1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-29 12:00:00 -05:00
vsphere-automation-sdk-python/vsphere/8.0.0.0/com.vmware.vcenter.html

26273 lines
2.6 MiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.vcenter package &mdash; vSphere Automation SDK for Python. 8.0.0.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vcenter.certificate_management package" href="com.vmware.vcenter.certificate_management.html" />
<link rel="prev" title="com.vmware.vapi.std package" href="com.vmware.vapi.std.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
</a>
<div class="version">
8.0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li>com.vmware.vcenter package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-com.vmware.vcenter">
<span id="com-vmware-vcenter-package"></span><h1>com.vmware.vcenter package<a class="headerlink" href="#module-com.vmware.vcenter" title="Permalink to this headline"></a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html">com.vmware.vcenter.certificate_management package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.certificate_management.html#module-com.vmware.vcenter.certificate_management.vcenter_client">com.vmware.vcenter.certificate_management.vcenter_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.compute.html">com.vmware.vcenter.compute package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html">com.vmware.vcenter.compute.policies package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html">com.vmware.vcenter.compute.policies.capabilities package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#subpackages">Subpackages</a><ul>
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html">com.vmware.vcenter.compute.policies.capabilities.vm package</a><ul>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html#subpackages">Subpackages</a><ul>
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation package</a><ul>
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html#submodules">Submodules</a></li>
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.html#module-com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client">com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client module</a></li>
</ul>
</li>
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.placement.html">com.vmware.vcenter.compute.policies.capabilities.vm.placement package</a><ul>
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.placement.html#submodules">Submodules</a></li>
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.placement.html#module-com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client">com.vmware.vcenter.compute.policies.capabilities.vm.placement.anti_affinity_with_vcls_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html#submodules">Submodules</a></li>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.vm.html#module-com.vmware.vcenter.compute.policies.capabilities.vm.placement_client">com.vmware.vcenter.compute.policies.capabilities.vm.placement_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#submodules">Submodules</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client">com.vmware.vcenter.compute.policies.capabilities.cluster_scale_in_ignore_vm_capabilities_client module</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client">com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion_client module</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_affinity_client module</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_host_anti_affinity_client module</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_affinity_client module</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.compute.policies.capabilities.html#module-com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client">com.vmware.vcenter.compute.policies.capabilities.vm_vm_anti_affinity_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.compute.policies.html#module-com.vmware.vcenter.compute.policies.capabilities_client">com.vmware.vcenter.compute.policies.capabilities_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.compute.html#module-com.vmware.vcenter.compute.policies_client">com.vmware.vcenter.compute.policies_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.content.html">com.vmware.vcenter.content package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.content.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.content.registries.html">com.vmware.vcenter.content.registries package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.content.registries.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.content.registries.html#module-com.vmware.vcenter.content.registries.harbor_client">com.vmware.vcenter.content.registries.harbor_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.content.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.content.html#module-com.vmware.vcenter.content.registries_client">com.vmware.vcenter.content.registries_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.html">com.vmware.vcenter.crypto_manager package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.hosts.html">com.vmware.vcenter.crypto_manager.hosts package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.hosts.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.hosts.html#module-com.vmware.vcenter.crypto_manager.hosts.kms_client">com.vmware.vcenter.crypto_manager.hosts.kms_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.html#module-com.vmware.vcenter.crypto_manager.hosts_client">com.vmware.vcenter.crypto_manager.hosts_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.html#module-com.vmware.vcenter.crypto_manager.kms_client">com.vmware.vcenter.crypto_manager.kms_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.deployment.html">com.vmware.vcenter.deployment package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.deployment.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html">com.vmware.vcenter.deployment.install package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html">com.vmware.vcenter.deployment.install.initial_config package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html#submodules">Submodules</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.deployment.install.initial_config.html#module-com.vmware.vcenter.deployment.install.initial_config.remote_psc_client">com.vmware.vcenter.deployment.install.initial_config.remote_psc_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.deployment.install.html#module-com.vmware.vcenter.deployment.install.psc_client">com.vmware.vcenter.deployment.install.psc_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.deployment.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.deployment.html#module-com.vmware.vcenter.deployment.install_client">com.vmware.vcenter.deployment.install_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.deployment.html#module-com.vmware.vcenter.deployment.migrate_client">com.vmware.vcenter.deployment.migrate_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.hvc.html">com.vmware.vcenter.hvc package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.hvc.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html">com.vmware.vcenter.hvc.links package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.hvc.links.html#module-com.vmware.vcenter.hvc.links.sync_client">com.vmware.vcenter.hvc.links.sync_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.hvc.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.hvc.html#module-com.vmware.vcenter.hvc.links_client">com.vmware.vcenter.hvc.links_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.hvc.html#module-com.vmware.vcenter.hvc.management_client">com.vmware.vcenter.hvc.management_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.lcm.html">com.vmware.vcenter.lcm package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.lcm.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.lcm.html#module-com.vmware.vcenter.lcm.discovery_client">com.vmware.vcenter.lcm.discovery_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.lcm.html#module-com.vmware.vcenter.lcm.update_client">com.vmware.vcenter.lcm.update_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html">com.vmware.vcenter.namespace_management package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html#module-com.vmware.vcenter.namespace_management.cns_client">com.vmware.vcenter.namespace_management.cns_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html#module-com.vmware.vcenter.namespace_management.software_client">com.vmware.vcenter.namespace_management.software_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html#module-com.vmware.vcenter.namespace_management.stats_client">com.vmware.vcenter.namespace_management.stats_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.html#module-com.vmware.vcenter.namespace_management.supervisor_services_client">com.vmware.vcenter.namespace_management.supervisor_services_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.namespaces.html">com.vmware.vcenter.namespaces package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespaces.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespaces.html#module-com.vmware.vcenter.namespaces.user_client">com.vmware.vcenter.namespaces.user_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.storage.html">com.vmware.vcenter.storage package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.storage.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html">com.vmware.vcenter.storage.policies package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.storage.policies.html#module-com.vmware.vcenter.storage.policies.compliance_client">com.vmware.vcenter.storage.policies.compliance_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.storage.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.storage.html#module-com.vmware.vcenter.storage.policies_client">com.vmware.vcenter.storage.policies_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.system_config.html">com.vmware.vcenter.system_config package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.system_config.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html">com.vmware.vcenter.system_config.features package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.system_config.features.html#module-com.vmware.vcenter.system_config.features.tech_preview_client">com.vmware.vcenter.system_config.features.tech_preview_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html">com.vmware.vcenter.trusted_infrastructure package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html#subpackages">Subpackages</a><ul>
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os package</a><ul>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.html#submodules">Submodules</a></li>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html#submodules">Submodules</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html#subpackages">Subpackages</a><ul>
<li class="toctree-l7"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers package</a><ul>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.html#submodules">Submodules</a></li>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html#submodules">Submodules</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html">com.vmware.vcenter.trusted_infrastructure.trusted_clusters package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#module-com.vmware.vcenter.trusted_infrastructure.attestation_client">com.vmware.vcenter.trusted_infrastructure.attestation_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#module-com.vmware.vcenter.trusted_infrastructure.kms_client">com.vmware.vcenter.trusted_infrastructure.kms_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.html#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client">com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.vcha.html">com.vmware.vcenter.vcha package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vcha.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vcha.html#module-com.vmware.vcenter.vcha.cluster_client">com.vmware.vcenter.vcha.cluster_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.vm.html">com.vmware.vcenter.vm package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.vm.guest.html">com.vmware.vcenter.vm.guest package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.guest.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.guest.html#module-com.vmware.vcenter.vm.guest.filesystem_client">com.vmware.vcenter.vm.guest.filesystem_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.guest.html#module-com.vmware.vcenter.vm.guest.networking_client">com.vmware.vcenter.vm.guest.networking_client module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html">com.vmware.vcenter.vm.hardware package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware.adapter_client">com.vmware.vcenter.vm.hardware.adapter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.hardware.html#module-com.vmware.vcenter.vm.hardware.boot_client">com.vmware.vcenter.vm.hardware.boot_client module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html">com.vmware.vcenter.vm.storage package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.vm.storage.html#module-com.vmware.vcenter.vm.storage.policy_client">com.vmware.vcenter.vm.storage.policy_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.compute_client">com.vmware.vcenter.vm.compute_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.console_client">com.vmware.vcenter.vm.console_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.data_sets_client">com.vmware.vcenter.vm.data_sets_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.guest_client">com.vmware.vcenter.vm.guest_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.hardware_client">com.vmware.vcenter.vm.hardware_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.storage_client">com.vmware.vcenter.vm.storage_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm.html#module-com.vmware.vcenter.vm.tools_client">com.vmware.vcenter.vm.tools_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.vm_template.html">com.vmware.vcenter.vm_template package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm_template.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.vm_template.html#module-com.vmware.vcenter.vm_template.library_items_client">com.vmware.vcenter.vm_template.library_items_client module</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.vcenter.authentication_client">
<span id="com-vmware-vcenter-authentication-client-module"></span><h2>com.vmware.vcenter.authentication_client module<a class="headerlink" href="#module-com.vmware.vcenter.authentication_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.authentication_client</span></code> module provides authentication
classes specific to the com.vmware.vcenter module. The
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.authentication_client</span></code> module is available starting in
vSphere 7.0 U2.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.authentication_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.authentication_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.authentication_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.authentication_client.Token">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.authentication_client.</span></code><code class="sig-name descname"><span class="pre">Token</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.authentication_client.Token" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Token</span></code> interface provides operations for obtaining an access token.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.authentication_client.Token.IssueSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">IssueSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">grant_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">audience</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">requested_token_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject_token_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actor_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actor_token_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.authentication_client.Token.IssueSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Token.IssueSpec</span></code> class contains arguments required for token
exchange.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>grant_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The value of <code class="docutils literal notranslate"><span class="pre">urn:ietf:params:oauth:grant-type:token-exchange</span></code>
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
<code class="docutils literal notranslate"><span class="pre">urn:ietf:params:oauth:grant-type:token-exchange</span></code>. When methods
return a value of this class as a return value, the attribute will
be one of <code class="docutils literal notranslate"><span class="pre">urn:ietf:params:oauth:grant-type:token-exchange</span></code>.</p></li>
<li><p><strong>resource</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>audience</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The logical name of the target service where the client intends to
use the requested security token. This serves a purpose similar to
the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Token.IssueSpec.resource</span></code> attribute, but with the client
providing a logical name rather than a location.
If None, it is inferred from other arguments.</p></li>
<li><p><strong>scope</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>requested_token_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Token.IssueSpec.resource</span></code> or
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Token.IssueSpec.audience</span></code> attribute.
If None, it is inferred from other arguments.</p></li>
<li><p><strong>subject_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>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.</p>
<p>The attribute is required when the value of the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Token.IssueSpec.grant_type</span></code> attribute is
<code class="docutils literal notranslate"><span class="pre">urn:ietf:params:oauth:grant-type:token-exchange</span></code>.
This attribute is currently required. In the future, the class may
support grant-types other than
<code class="docutils literal notranslate"><span class="pre">urn:ietf:params:oauth:grant-type:token-exchange</span></code> for which the
value may be None.</p>
</p></li>
<li><p><strong>subject_token_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>An identifier, that indicates the type of the security token in the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Token.IssueSpec.subject_token</span></code> attribute.</p>
<p>The attribute is required when the value of the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Token.IssueSpec.grant_type</span></code> attribute is
<code class="docutils literal notranslate"><span class="pre">urn:ietf:params:oauth:grant-type:token-exchange</span></code>.
This attribute is currently required. In the future, the class may
support grant-types other than
<code class="docutils literal notranslate"><span class="pre">urn:ietf:params:oauth:grant-type:token-exchange</span></code> for which the
value may be None.</p>
</p></li>
<li><p><strong>actor_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>actor_token_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) An identifier, that indicates the type of the security token in the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Token.IssueSpec.actor_token</span></code> attribute.
None if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Token.IssueSpec.actor_token</span></code> attribute is not
present.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.authentication_client.Token.issue">
<code class="sig-name descname"><span class="pre">issue</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.authentication_client.Token.issue" title="Permalink to this definition"></a></dt>
<dd><p>Provides a token endpoint as defined in <a class="reference external" href="https://tools.ietf.org/html/rfc6749#section-3.2">RFC 6749</a>.</p>
<p>Supported grant types:</p>
<ul class="simple">
<li><p>` <a class="reference external" href="urn:ietf:params:oauth:grant-type:token-exchange">urn:ietf:params:oauth:grant-type:token-exchange</a>
&lt;<a class="reference external" href="https://tools.ietf.org/html/rfc8693#section-2.1">https://tools.ietf.org/html/rfc8693#section-2.1</a>&gt;`_ - Exchanges
incoming token based on the spec and current client authorization data.</p></li>
</ul>
<p>This method supercedes
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.tokenservice.TokenExchange#exchange</span></code>. The REST
rendering of the newer operation matches RFC8693s definition for both
input and output of the method.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.authentication_client.Token.IssueSpec" title="com.vmware.vcenter.authentication_client.Token.IssueSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Token.IssueSpec</span></code></a>) <code class="docutils literal notranslate"><span class="pre">Token.IssueSpec</span></code> class containing arguments that define the
exchange process.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.html#com.vmware.oauth2_client.TokenInfo" title="com.vmware.oauth2_client.TokenInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.oauth2_client.TokenInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.html#com.vmware.oauth2_client.TokenInfo" title="com.vmware.oauth2_client.TokenInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.oauth2_client.TokenInfo</span></code></a> class that contains a
newly issued token.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.oauth2.html#com.vmware.oauth2.errors_client.InvalidRequest" title="com.vmware.oauth2.errors_client.InvalidRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.oauth2.errors_client.InvalidRequest</span></code></a>
if <a class="reference internal" href="#com.vmware.vcenter.authentication_client.Token.IssueSpec" title="com.vmware.vcenter.authentication_client.Token.IssueSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Token.IssueSpec</span></code></a> is missing a required attribute,
includes an unsupported attribute value (other than
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Token.IssueSpec.grant_type</span></code>).</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.oauth2.html#com.vmware.oauth2.errors_client.InvalidGrant" title="com.vmware.oauth2.errors_client.InvalidGrant"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.oauth2.errors_client.InvalidGrant</span></code></a>
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.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.oauth2.html#com.vmware.oauth2.errors_client.InvalidScope" title="com.vmware.oauth2.errors_client.InvalidScope"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.oauth2.errors_client.InvalidScope</span></code></a>
If the server is unwilling or unable to issue a token for all the
target services indicated by the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Token.IssueSpec.resource</span></code>
or <code class="xref py py-attr docutils literal notranslate"><span class="pre">Token.IssueSpec.audience</span></code> attributes.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.certificate_management_client">
<span id="com-vmware-vcenter-certificate-management-client-module"></span><h2>com.vmware.vcenter.certificate_management_client module<a class="headerlink" href="#module-com.vmware.vcenter.certificate_management_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.certificate_management_client</span></code> module provides
classes to manage certificates.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.certificate_management_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.certificate_management_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.certificate_management_client.X509CertChain">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.certificate_management_client.</span></code><code class="sig-name descname"><span class="pre">X509CertChain</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cert_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management_client.X509CertChain" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">X509CertChain</span></code> class contains x509 certificate chain. This class was
added in vSphere API 6.7.2.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cert_chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Certificate chain in base64 format. This attribute was added in
vSphere API 6.7.2.</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.compute_client">
<span id="com-vmware-vcenter-compute-client-module"></span><h2>com.vmware.vcenter.compute_client module<a class="headerlink" href="#module-com.vmware.vcenter.compute_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute_client</span></code> module provides classes for managing
compute policies.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.compute_client.Policies">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute_client.</span></code><code class="sig-name descname"><span class="pre">Policies</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute_client.Policies" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Policies</span></code> 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies_client.Capabilities.Info.create_spec_type</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.compute_client.Policies.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.compute.Policy'</span></em><a class="headerlink" href="#com.vmware.vcenter.compute_client.Policies.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>The resource type for the compute policy.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.compute_client.Policies.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute_client.Policies.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Policies.Summary</span></code> class contains commonly used information about a
compute policy.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>. When methods return a value
of this class as a return value, the attribute will be an
identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the policy.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Description of the policy.</p></li>
<li><p><strong>capability</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the capability this policy is based on.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies.Capability</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.compute_client.Policies.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute_client.Policies.create" title="Permalink to this definition"></a></dt>
<dd><p>Creates a new compute policy.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code>) Specification for the new policy to be created. The new policy will
be an instance of the capability that has the creation type (see
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies_client.Capabilities.Info.create_spec_type</span></code>)
equal to the type of the specified value (see <code class="docutils literal notranslate"><span class="pre">spec</span></code>).
The parameter must contain all the attributes defined in
<a class="reference internal" href="com.vmware.vcenter.compute.html#com.vmware.vcenter.compute.policies_client.CreateSpec" title="com.vmware.vcenter.compute.policies_client.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies_client.CreateSpec</span></code></a>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if a policy with the same name is already present on this vCenter
server.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if a parameter passed in the spec is invalid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
if more than 100 policies are created.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">ComputePolicy.Manage</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.compute_client.Policies.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute_client.Policies.delete" title="Permalink to this definition"></a></dt>
<dd><p>Deletes a specific compute policy.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the policy to be deleted.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if a policy with this identifier does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">ComputePolicy.Manage</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.compute_client.Policies.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute_client.Policies.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about a specific compute policy.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the policy for which information should be retrieved.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.Policy</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies_client.Capabilities.Info.info_type</span></code>.
The return value will contain all the attributes defined in
<a class="reference internal" href="com.vmware.vcenter.compute.html#com.vmware.vcenter.compute.policies_client.Info" title="com.vmware.vcenter.compute.policies_client.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.compute.policies_client.Info</span></code></a>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if a policy with this identifier does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.compute_client.Policies.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute_client.Policies.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about the compute policies available in this
vCenter server.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.compute_client.Policies.list" title="com.vmware.vcenter.compute_client.Policies.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.compute_client.Policies.Summary" title="com.vmware.vcenter.compute_client.Policies.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policies.Summary</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The list of compute policies available on this vCenter server.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.compute_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.compute_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.compute_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.crypto_manager_client">
<span id="com-vmware-vcenter-crypto-manager-client-module"></span><h2>com.vmware.vcenter.crypto_manager_client module<a class="headerlink" href="#module-com.vmware.vcenter.crypto_manager_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager_client</span></code> module provides classes for
managing key providers and cryptographic keys.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.crypto_manager_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.datastore_client">
<span id="com-vmware-vcenter-datastore-client-module"></span><h2>com.vmware.vcenter.datastore_client module<a class="headerlink" href="#module-com.vmware.vcenter.datastore_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="com.vmware.vcenter.datastore_client.DefaultPolicy">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.datastore_client.</span></code><code class="sig-name descname"><span class="pre">DefaultPolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.datastore_client.DefaultPolicy" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DefaultPolicy</span></code> class provides methods related to storage policies
associated with datastore object. The <a class="reference internal" href="#com.vmware.vcenter.datastore_client.DefaultPolicy.get" title="com.vmware.vcenter.datastore_client.DefaultPolicy.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">DefaultPolicy.get()</span></code></a> method
provides information about the default storage policy associated with the
specific datastore. This class was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py method">
<dt id="com.vmware.vcenter.datastore_client.DefaultPolicy.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datastore</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.datastore_client.DefaultPolicy.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the identifier of the current default storage policy associated
with the specified datastore. This method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the datastore for which the default policy is
requested.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Identifier of the default storage policy associated with the
specified datastore.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.
this field is None if there is no default storage policy associated
with the datastore.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the specified datastore does not exist.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the required priveleges.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.datastore_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.datastore_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.datastore_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.deployment_client">
<span id="com-vmware-vcenter-deployment-client-module"></span><h2>com.vmware.vcenter.deployment_client module<a class="headerlink" href="#module-com.vmware.vcenter.deployment_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.ApplianceSize">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">ApplianceSize</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceSize" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ApplianceSize</span></code> class defines the vCenter Server Appliance sizes.
This enumeration was added in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.deployment_client.ApplianceSize" title="com.vmware.vcenter.deployment_client.ApplianceSize"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplianceSize</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.ApplianceSize.LARGE">
<code class="sig-name descname"><span class="pre">LARGE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceSize(string='LARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceSize.LARGE" title="Permalink to this definition"></a></dt>
<dd><p>Appliance size of large. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.ApplianceSize.MEDIUM">
<code class="sig-name descname"><span class="pre">MEDIUM</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceSize(string='MEDIUM')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceSize.MEDIUM" title="Permalink to this definition"></a></dt>
<dd><p>Appliance size of medium. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.ApplianceSize.SMALL">
<code class="sig-name descname"><span class="pre">SMALL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceSize(string='SMALL')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceSize.SMALL" title="Permalink to this definition"></a></dt>
<dd><p>Appliance size of small. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.ApplianceSize.TINY">
<code class="sig-name descname"><span class="pre">TINY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceSize(string='TINY')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceSize.TINY" title="Permalink to this definition"></a></dt>
<dd><p>Appliance size of tiny. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.ApplianceSize.XLARGE">
<code class="sig-name descname"><span class="pre">XLARGE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceSize(string='XLARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceSize.XLARGE" title="Permalink to this definition"></a></dt>
<dd><p>Appliance size of extra large. This class attribute was added in vSphere
API 7.0.0.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.ApplianceState">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">ApplianceState</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceState" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ApplianceState</span></code> class defines the various states the vCenter
Appliance can be in. This enumeration was added in vSphere API 6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.deployment_client.ApplianceState" title="com.vmware.vcenter.deployment_client.ApplianceState"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplianceState</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.ApplianceState.CONFIGURED">
<code class="sig-name descname"><span class="pre">CONFIGURED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceState(string='CONFIGURED')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceState.CONFIGURED" title="Permalink to this definition"></a></dt>
<dd><p>The appliance has been configured. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.ApplianceState.CONFIG_IN_PROGRESS">
<code class="sig-name descname"><span class="pre">CONFIG_IN_PROGRESS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceState(string='CONFIG_IN_PROGRESS')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceState.CONFIG_IN_PROGRESS" title="Permalink to this definition"></a></dt>
<dd><p>The appliance is in the process of being configured. This class attribute
was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.ApplianceState.FAILED">
<code class="sig-name descname"><span class="pre">FAILED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceState(string='FAILED')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceState.FAILED" title="Permalink to this definition"></a></dt>
<dd><p>The appliance configuration has failed. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.ApplianceState.INITIALIZED">
<code class="sig-name descname"><span class="pre">INITIALIZED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceState(string='INITIALIZED')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceState.INITIALIZED" title="Permalink to this definition"></a></dt>
<dd><p>The appliance is initialized and ready to be configured. This class
attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.ApplianceState.NOT_INITIALIZED">
<code class="sig-name descname"><span class="pre">NOT_INITIALIZED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceState(string='NOT_INITIALIZED')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceState.NOT_INITIALIZED" title="Permalink to this definition"></a></dt>
<dd><p>The appliance is in the process of being initialized and not ready for
configuration. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.ApplianceState.QUESTION_RAISED">
<code class="sig-name descname"><span class="pre">QUESTION_RAISED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceState(string='QUESTION_RAISED')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceState.QUESTION_RAISED" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.ApplianceType">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">ApplianceType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ApplianceType</span></code> class defines the vCenter appliance types. This
enumeration was added in vSphere API 6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.deployment_client.ApplianceType" title="com.vmware.vcenter.deployment_client.ApplianceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplianceType</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.ApplianceType.PSC_EXTERNAL">
<code class="sig-name descname"><span class="pre">PSC_EXTERNAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceType(string='PSC_EXTERNAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceType.PSC_EXTERNAL" title="Permalink to this definition"></a></dt>
<dd><p>An external Platform Services Controller. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.ApplianceType.VCSA_EMBEDDED">
<code class="sig-name descname"><span class="pre">VCSA_EMBEDDED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceType(string='VCSA_EMBEDDED')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceType.VCSA_EMBEDDED" title="Permalink to this definition"></a></dt>
<dd><p>vCenter Server Appliance with an embedded Platform Services Controller.
This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.ApplianceType.VCSA_EXTERNAL">
<code class="sig-name descname"><span class="pre">VCSA_EXTERNAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceType(string='VCSA_EXTERNAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ApplianceType.VCSA_EXTERNAL" title="Permalink to this definition"></a></dt>
<dd><p>vCenter Server Appliance with an external Platform Services Controller.
This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.CheckInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">CheckInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.CheckInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CheckInfo</span></code> class describes the result of the appliance deployment
check. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.CheckStatus" title="com.vmware.vcenter.deployment_client.CheckStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckStatus</span></code></a>) Status of the check. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>result</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Notifications" title="com.vmware.vcenter.deployment_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>source_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.SourceInfo" title="com.vmware.vcenter.deployment_client.SourceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.CheckStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">CheckStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.CheckStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CheckStatus</span></code> class defines the status of the checks. This
enumeration was added in vSphere API 6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.deployment_client.CheckStatus" title="com.vmware.vcenter.deployment_client.CheckStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckStatus</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.CheckStatus.FAILED">
<code class="sig-name descname"><span class="pre">FAILED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CheckStatus(string='FAILED')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.CheckStatus.FAILED" title="Permalink to this definition"></a></dt>
<dd><p>A fatal error was encountered when running the sanity checks. This class
attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.CheckStatus.SUCCESS">
<code class="sig-name descname"><span class="pre">SUCCESS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CheckStatus(string='SUCCESS')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.CheckStatus.SUCCESS" title="Permalink to this definition"></a></dt>
<dd><p>All checks have completed successfully. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.DataMigrationEstimate">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">DataMigrationEstimate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">estimated_export_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">estimated_import_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">required_free_disk_space_on_source</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.DataMigrationEstimate" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DataMigrationEstimate</span></code> {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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>estimated_export_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The time estimated to export data from the source vCenter Server.
This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>estimated_import_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The time estimated to import data to the upgraded vCenter Server.
This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>required_free_disk_space_on_source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>) The extra free space required on source vCenter Server. This
attribute was added in vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.DataMigrationInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">DataMigrationInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">core</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">core_events_tasks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">all</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">core_events_tasks_with_deferred</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">all_with_deferred</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.DataMigrationInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DataMigrationInfo</span></code> {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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>core</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.DataMigrationEstimate" title="com.vmware.vcenter.deployment_client.DataMigrationEstimate"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataMigrationEstimate</span></code></a>) 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.</p></li>
<li><p><strong>core_events_tasks</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.DataMigrationEstimate" title="com.vmware.vcenter.deployment_client.DataMigrationEstimate"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataMigrationEstimate</span></code></a>) Migrate core, events, and tasks from vCenter Server. Stats will not
be migrated. This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>all</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.DataMigrationEstimate" title="com.vmware.vcenter.deployment_client.DataMigrationEstimate"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataMigrationEstimate</span></code></a>) Migrate all data from vCenter Server. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>core_events_tasks_with_deferred</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.DataMigrationEstimate" title="com.vmware.vcenter.deployment_client.DataMigrationEstimate"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataMigrationEstimate</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>all_with_deferred</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.DataMigrationEstimate" title="com.vmware.vcenter.deployment_client.DataMigrationEstimate"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataMigrationEstimate</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.HistoryMigrationOption">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">HistoryMigrationOption</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">HistoryMigrationOption</span></code> class defines the vCenter history migration
option choices. This enumeration was added in vSphere API 6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption" title="com.vmware.vcenter.deployment_client.HistoryMigrationOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">HistoryMigrationOption</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.HistoryMigrationOption.ALL">
<code class="sig-name descname"><span class="pre">ALL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">HistoryMigrationOption(string='ALL')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption.ALL" title="Permalink to this definition"></a></dt>
<dd><p>All history data will be migrated along with the core data. This class
attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.HistoryMigrationOption.EVENTS_TASKS">
<code class="sig-name descname"><span class="pre">EVENTS_TASKS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">HistoryMigrationOption(string='EVENTS_TASKS')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption.EVENTS_TASKS" title="Permalink to this definition"></a></dt>
<dd><p>Only event data and task data will be migrated along with the core data.
This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.HistoryMigrationSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">HistoryMigrationSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">defer_import</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.HistoryMigrationSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">HistoryMigrationSpec</span></code> class defines how vCenter history data will be
migrated. vCenter History data includes</p>
<ul class="simple">
<li><p>Statistics</p></li>
<li><p>Events</p></li>
<li><p>Tasks</p></li>
</ul>
<p>. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data_set</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption" title="com.vmware.vcenter.deployment_client.HistoryMigrationOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">HistoryMigrationOption</span></code></a>) Defines what part of vCenter historical data will be migrated along
with core data. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>defer_import</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 wont be deferred and will be
migrated along with core data.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.ImportHistory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">ImportHistory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ImportHistory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ImportHistory</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.ImportHistory.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ImportHistory.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ImportHistory.CreateSpec</span></code> class contains information to create and
start vCenter historical data deferred import. This class was added in
vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the vCenter history import task. This attribute was added
in vSphere API 6.7.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Description of the vCenter history import task. This attribute was
added in vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.ImportHistory.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">progress</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cancelable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ImportHistory.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ImportHistory.Info</span></code> class contains attributes to describe the state
of vCenter history import task. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>progress</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Progress</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">CommonInfo#status</span></code> is one of
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>, or
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>.</p></li>
<li><p><strong>result</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Notifications" title="com.vmware.vcenter.deployment_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Result of the operation. If an operation reports partial results
before it completes, this attribute could be <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> before
the <code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.CommonInfo.status</span></code> has the
value <a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>. 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.</p></li>
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) Description of the operation associated with the task.</p></li>
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the service containing the operation.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the operation associated with the task.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Parent of the current task.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Identifier of the target created by the operation or an existing
one the operation performed on.
This attribute will be None if the operation has no target or
multiple targets.</p></li>
<li><p><strong>status</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a>) Status of the operation associated with the task.</p></li>
<li><p><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Flag to indicate whether or not the operation can be cancelled. The
value may change as the operation progresses.</p></li>
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Description of the error if the operation status is “FAILED”.
If None the description of why the operation failed will be
included in the result of the operation (see
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info.result</span></code>).</p></li>
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) Time when the operation is started.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) Time when the operation is completed.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
<li><p><strong>user</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Name of the user who performed the operation.
This attribute will be None if the operation is performed by the
system.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.ImportHistory.cancel">
<code class="sig-name descname"><span class="pre">cancel</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ImportHistory.cancel" title="Permalink to this definition"></a></dt>
<dd><p>Cancels the task for importing vCenter historical data. This method was
added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the caller is not authorized to perform the method.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if vCenter historical data import task cannot be canceled at this
state. This can happen in the following cases:</p>
<ul class="simple">
<li><p>If historical data import has not been started yet because a not
running task cannot be canceled</p></li>
<li><p>If historical data import has already been completed because a
completed task cannot be canceled</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
if vCenter historical data import task is already canceled.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.ImportHistory.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ImportHistory.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the current status of the vCenter historical data import. This
method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.deployment_client.ImportHistory.Info" title="com.vmware.vcenter.deployment_client.ImportHistory.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImportHistory.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Info structure containing the status information about the
historical data import status.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the caller is not authorized to perform the method.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.ImportHistory.pause">
<code class="sig-name descname"><span class="pre">pause</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ImportHistory.pause" title="Permalink to this definition"></a></dt>
<dd><p>Pauses the task for importing vCenter historical data. This method was
added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the caller is not authorized to perform the method.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if vCenter historical data import task cannot be paused at this
time. Pause can be accepted only in
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a> state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
if vCenter historical data import task is already paused</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.ImportHistory.resume">
<code class="sig-name descname"><span class="pre">resume</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ImportHistory.resume" title="Permalink to this definition"></a></dt>
<dd><p>Resumes the task for importing vCenter historical data. This method was
added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the caller is not authorized to perform the method.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if vCenter historical data import task cannot be resumed at this
state. Resume can be accepted only in
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a> state</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
if vCenter historical data import task is already resumed.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.ImportHistory.start">
<code class="sig-name descname"><span class="pre">start</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ImportHistory.start" title="Permalink to this definition"></a></dt>
<dd><p>Creates and starts task for importing vCenter historical data. This
method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.ImportHistory.CreateSpec" title="com.vmware.vcenter.deployment_client.ImportHistory.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImportHistory.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>An optional <code class="docutils literal notranslate"><span class="pre">ImportHistory.CreateSpec</span></code> info that can be passed
for creating a new historical data import task and starts it.
If None, default value will be:</p>
<ul class="simple">
<li><p>name : vcenter.deployment.history.import</p></li>
<li><p>description : vCenter Server history import</p></li>
</ul>
</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the caller is not authorized to perform the method.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if vCenter historical data import task cannot be started at this
time. This can happen in the following cases:</p>
<ul class="simple">
<li><p>If historical data import has already been canceled because a
canceled task cannot be re-started</p></li>
<li><p>If historical data import has already been completed because a
completed task cannot be re-started</p></li>
<li><p>If historical data import has already been paused because a
paused task can only be resumed or canceled</p></li>
</ul>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
if vCenter historical data import task has already being started.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
Generic error</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Install">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">Install</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Install" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Install</span></code> class provides methods to configure the installation of the
appliance. This class was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Install.InstallSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">InstallSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vcsa_embedded</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_answer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Install.InstallSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Install.InstallSpec</span></code> class contains information used to configure
the appliance installation. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vcsa_embedded</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Install.VcsaEmbeddedSpec" title="com.vmware.vcenter.deployment_client.Install.VcsaEmbeddedSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Install.VcsaEmbeddedSpec</span></code></a>) 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.</p></li>
<li><p><strong>auto_answer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Install.VcsaEmbeddedSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VcsaEmbeddedSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">standalone</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replicated</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ceip_enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Install.VcsaEmbeddedSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Install.VcsaEmbeddedSpec</span></code> class contains information used to
configure an embedded standalone or replicated vCenter Server. This class
was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>standalone</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.StandaloneSpec" title="com.vmware.vcenter.deployment_client.StandaloneSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">StandaloneSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>replicated</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.ReplicatedSpec" title="com.vmware.vcenter.deployment_client.ReplicatedSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReplicatedSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>ceip_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Whether CEIP should be enabled or disabled. This attribute was
added in vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.Install.cancel">
<code class="sig-name descname"><span class="pre">cancel</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Install.cancel" title="Permalink to this definition"></a></dt>
<dd><p>Cancel the appliance installation that is in progress. This method was
added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the appliance is not in CONFIG_IN_PROGRESS state and if the
operation is not INSTALL.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.Install.check">
<code class="sig-name descname"><span class="pre">check</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Install.check" title="Permalink to this definition"></a></dt>
<dd><p>Run sanity checks using the InstallSpec parameters passed. This method
was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Install.InstallSpec" title="com.vmware.vcenter.deployment_client.Install.InstallSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Install.InstallSpec</span></code></a>) InstallSpec parameters to run sanity check with.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.deployment_client.CheckInfo" title="com.vmware.vcenter.deployment_client.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>CheckInfo containing the check results.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if external PSC credentials are not valid when configuring PSC to
replicate with an external existing PSC.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if external PSC credentials are not valid when configuring a
VCSA_EXTERNAL appliance.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if passed arguments are invalid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the appliance is not in INITIALIZED state.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.Install.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Install.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the parameters used to configure the ongoing appliance
installation. This method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.deployment_client.Install.InstallSpec" title="com.vmware.vcenter.deployment_client.Install.InstallSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Install.InstallSpec</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>InstallSpec parameters being used to configure appliance install.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if appliance is not in INSTALL_PROGRESS state.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.Install.start">
<code class="sig-name descname"><span class="pre">start</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Install.start" title="Permalink to this definition"></a></dt>
<dd><p>Start the appliance installation. This method was added in vSphere API
6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Install.InstallSpec" title="com.vmware.vcenter.deployment_client.Install.InstallSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Install.InstallSpec</span></code></a>) InstallSpec parameters to configure the appliance install.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the partner PSC credentials are not valid when configuring PSC
to replicate with partner PSC.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if external PSC credentials are not valid when configuring a
VCSA_EXTERNAL appliance.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if passed arguments are invalid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the appliance is not in INITIALIZED state.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.LocationSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">LocationSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">https_port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_thumbprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_verify</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.LocationSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LocationSpec</span></code> class 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The IP address or DNS resolvable name of the container. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The HTTPS port of the container. This attribute was added in
vSphere API 6.7.
If None, port 443 will be used.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is None or has the
value true.</p></li>
<li><p><strong>ssl_verify</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) SSL verification should be enabled or disabled. If <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is
true and and <code class="docutils literal notranslate"><span class="pre">sslThumbprint</span></code> is None, the CA certificate will be
used for verification. If <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is true and
<code class="docutils literal notranslate"><span class="pre">sslThumbprint</span></code> is set then the thumbprint will be used for
verification. No verification will be performed if <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code>
value is set to false. This attribute was added in vSphere API 6.7.
If None, ssl_verify true will be used.</p></li>
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The administrator account on the host. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Migrate">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">Migrate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Migrate" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Migrate</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Migrate.MigrateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">MigrateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_vc_windows</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">existing_migration_assistant</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">history</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vcsa_embedded</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">psc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active_directory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_answer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Migrate.MigrateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Migrate.MigrateSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>source_vc_windows</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Migrate.SourceVcWindows" title="com.vmware.vcenter.deployment_client.Migrate.SourceVcWindows"><code class="xref py py-class docutils literal notranslate"><span class="pre">Migrate.SourceVcWindows</span></code></a>) Information specific to the Windows vCenter Server. This attribute
was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>existing_migration_assistant</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Migrate.MigrationAssistantSpec" title="com.vmware.vcenter.deployment_client.Migrate.MigrationAssistantSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Migrate.MigrationAssistantSpec</span></code></a>) 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.</p></li>
<li><p><strong>history</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.HistoryMigrationSpec" title="com.vmware.vcenter.deployment_client.HistoryMigrationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">HistoryMigrationSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Determines how vCenter history will be migrated during the
migration process. vCenter history consists of:</p>
<ul>
<li><p>Statistics</p></li>
<li><p>Events</p></li>
<li><p>Tasks</p></li>
</ul>
<p>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.</p>
</p></li>
<li><p><strong>vcsa_embedded</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Migrate.VcsaEmbeddedSpec" title="com.vmware.vcenter.deployment_client.Migrate.VcsaEmbeddedSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Migrate.VcsaEmbeddedSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>psc</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Migrate.PscSpec" title="com.vmware.vcenter.deployment_client.Migrate.PscSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Migrate.PscSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>active_directory</strong> (<a class="reference internal" href="com.vmware.vcenter.deployment.html#com.vmware.vcenter.deployment.migrate_client.ActiveDirectorySpec" title="com.vmware.vcenter.deployment.migrate_client.ActiveDirectorySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment.migrate_client.ActiveDirectorySpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>auto_answer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Migrate.MigrationAssistantSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">MigrationAssistantSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">https_port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_thumbprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Migrate.MigrationAssistantSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Migrate.MigrationAssistantSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>https_port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The HTTPS port being used by Migration Assistant. This attribute
was added in vSphere API 7.0.0.0.
If None, port 9123 will be used.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Migrate.PscSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">PscSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ceip_enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Migrate.PscSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Migrate.PscSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ceip_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) 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.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Migrate.SourceVcWindows">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">SourceVcWindows</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Migrate.SourceVcWindows" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Migrate.SourceVcWindows</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The IP address or DNS resolvable name of the source Windows
machine. This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The SSO account with administrative privilege to perform the
migration operation. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The SSO administrator account password. This attribute was added in
vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Migrate.VcsaEmbeddedSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VcsaEmbeddedSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ceip_enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Migrate.VcsaEmbeddedSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Migrate.VcsaEmbeddedSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ceip_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) 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.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.Migrate.cancel">
<code class="sig-name descname"><span class="pre">cancel</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Migrate.cancel" title="Permalink to this definition"></a></dt>
<dd><p>Cancel the appliance migration that is in progress. This method was
added in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the appliance is not in CONFIG_IN_PROGRESS state and if the
operation is not INSTALL.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.Migrate.check">
<code class="sig-name descname"><span class="pre">check</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Migrate.check" title="Permalink to this definition"></a></dt>
<dd><p>Run sanity checks using the MigrateSpec parameters passed. This method
was added in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Migrate.MigrateSpec" title="com.vmware.vcenter.deployment_client.Migrate.MigrateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Migrate.MigrateSpec</span></code></a>) MigrateSpec parameters to run sanity check on.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.deployment_client.CheckInfo" title="com.vmware.vcenter.deployment_client.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>CheckInfo containing the check results.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if migration assistant credentials are not valid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if passed arguments are invalid.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the appliance is not in INITIALIZED state.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.Migrate.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Migrate.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the MigrateSpec parameters used to configure the ongoing appliance
migration. This method was added in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.deployment_client.Migrate.MigrateSpec" title="com.vmware.vcenter.deployment_client.Migrate.MigrateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Migrate.MigrateSpec</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>MigrateSpec parameters being used to configure appliance migration.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if appliance is not in MIGRATE_PROGRESS state.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.Migrate.start">
<code class="sig-name descname"><span class="pre">start</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Migrate.start" title="Permalink to this definition"></a></dt>
<dd><p>Start the appliance migration. This method was added in vSphere API
7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Migrate.MigrateSpec" title="com.vmware.vcenter.deployment_client.Migrate.MigrateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Migrate.MigrateSpec</span></code></a>) MigrateSpec parameters to configure the appliance migration.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if migration assistant credentials are not valid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if passed arguments are invalid.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the appliance is not in INITIALIZED state.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Notification">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">Notification</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resolution</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Notification" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Notification</span></code> class contains attributes to describe any
info/warning/error messages that Tasks can raise. This class was added in
vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The notification id. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The time the notification was raised/found. This attribute was
added in vSphere API 6.7.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the time information is available.</p></li>
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) The notification message. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>resolution</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The resolution message, if any. This attribute was added in vSphere
API 6.7.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> for warnings and errors.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Notifications">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">Notifications</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">warnings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Notifications" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Notifications</span></code> class contains info/warning/error messages that can
be reported be the task. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.deployment_client.Notification" title="com.vmware.vcenter.deployment_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Info notification messages reported. This attribute was added in
vSphere API 6.7.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an info was reported by the task.</p></li>
<li><p><strong>warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.deployment_client.Notification" title="com.vmware.vcenter.deployment_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Warning notification messages reported. This attribute was added in
vSphere API 6.7.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an warning was reported by the task.</p></li>
<li><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.deployment_client.Notification" title="com.vmware.vcenter.deployment_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Error notification messages reported. This attribute was added in
vSphere API 6.7.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an error was reported by the task.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Operation">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">Operation</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Operation" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Operation</span></code> class defines the supported vCenter appliance deployment
operations. This enumeration was added in vSphere API 6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.deployment_client.Operation" title="com.vmware.vcenter.deployment_client.Operation"><code class="xref py py-class docutils literal notranslate"><span class="pre">Operation</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.Operation.INSTALL">
<code class="sig-name descname"><span class="pre">INSTALL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Operation(string='INSTALL')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Operation.INSTALL" title="Permalink to this definition"></a></dt>
<dd><p>The appliance installation is in progress. This class attribute was added
in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.Operation.MIGRATE">
<code class="sig-name descname"><span class="pre">MIGRATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Operation(string='MIGRATE')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Operation.MIGRATE" title="Permalink to this definition"></a></dt>
<dd><p>The appliance migration is in progress. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.Operation.RESTORE">
<code class="sig-name descname"><span class="pre">RESTORE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Operation(string='RESTORE')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Operation.RESTORE" title="Permalink to this definition"></a></dt>
<dd><p>The appliance restoration is in progress. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.Operation.ROLLBACK">
<code class="sig-name descname"><span class="pre">ROLLBACK</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Operation(string='ROLLBACK')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Operation.ROLLBACK" title="Permalink to this definition"></a></dt>
<dd><p>The appliance is being rolled back to an unconfigured state. This class
attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.Operation.UPGRADE">
<code class="sig-name descname"><span class="pre">UPGRADE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Operation(string='UPGRADE')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Operation.UPGRADE" title="Permalink to this definition"></a></dt>
<dd><p>The appliance upgrade is in progress. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Question">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">Question</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Question" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Question</span></code> class provides methods to get the question raised during
deployment and to answer them. This class was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Question.AnswerSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">AnswerSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">question_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">answer_val</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Question.AnswerSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Question.AnswerSpec</span></code> class contains attributes to describe the
answer to a raised question. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>question_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Id of the question being answered. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>answer_val</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The answer value. This attribute was added in vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Question.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">questions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Question.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Question.Info</span></code> class contains attributes to describe questions
raised during the deployment process. This class was added in vSphere API
6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>questions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.deployment_client.Question.Question" title="com.vmware.vcenter.deployment_client.Question.Question"><code class="xref py py-class docutils literal notranslate"><span class="pre">Question.Question</span></code></a>) One or more questions raised during the deployment. This attribute
was added in vSphere API 6.7.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Question.Question">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Question</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">question</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_answer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">possible_answers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Question.Question" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Question.Question</span></code> class contains attributes to describe a
deployment question. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Id of the question raised. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>question</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) Message describing the question. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Question.QuestionType" title="com.vmware.vcenter.deployment_client.Question.QuestionType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Question.QuestionType</span></code></a>) Type of the question raised. This attribute was added in vSphere
API 6.7.</p></li>
<li><p><strong>default_answer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Default answer value. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>possible_answers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Possible answers values. This attribute was added in vSphere API
6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Question.QuestionType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">QuestionType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Question.QuestionType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Question.QuestionType</span></code> class defines the type of the question
raised. This enumeration was added in vSphere API 6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">QuestionType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.Question.QuestionType.ABORT_RETRY_IGNORE">
<code class="sig-name descname"><span class="pre">ABORT_RETRY_IGNORE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">QuestionType(string='ABORT_RETRY_IGNORE')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Question.QuestionType.ABORT_RETRY_IGNORE" title="Permalink to this definition"></a></dt>
<dd><p>Question with answer values Abort/Retry/Ignore. This class attribute was
added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.Question.QuestionType.OK_CANCEL">
<code class="sig-name descname"><span class="pre">OK_CANCEL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">QuestionType(string='OK_CANCEL')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Question.QuestionType.OK_CANCEL" title="Permalink to this definition"></a></dt>
<dd><p>Question with answer values Ok/Cancel. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.Question.QuestionType.YES_NO">
<code class="sig-name descname"><span class="pre">YES_NO</span></code><em class="property"> <span class="pre">=</span> <span class="pre">QuestionType(string='YES_NO')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Question.QuestionType.YES_NO" title="Permalink to this definition"></a></dt>
<dd><p>Question with answer values Yes/No. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.Question.answer">
<code class="sig-name descname"><span class="pre">answer</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Question.answer" title="Permalink to this definition"></a></dt>
<dd><p>Supply answer to the raised question. This method was added in vSphere
API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Question.AnswerSpec" title="com.vmware.vcenter.deployment_client.Question.AnswerSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Question.AnswerSpec</span></code></a>) AnswerSpec with the answer to the raised question.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if passed arguments are invalid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the appliance is NOT in QUESTION_RAISED state.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InternalServerError" title="com.vmware.vapi.std.errors_client.InternalServerError"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code></a>
if answer file could not be created.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.Question.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Question.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the question that was raised during the configuration. This method
was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.deployment_client.Question.Info" title="com.vmware.vcenter.deployment_client.Question.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Question.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Info structure containing the question.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the appliance is not in QUESTION_RAISED state.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InternalServerError" title="com.vmware.vapi.std.errors_client.InternalServerError"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code></a>
if questions could not be retrieved although the appliance is in
QUESTION_RAISED state.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.RemotePscSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">RemotePscSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">psc_hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">https_port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sso_admin_password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_thumbprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_verify</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.RemotePscSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">RemotePscSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>psc_hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The IP address or DNS resolvable name of the remote PSC to which
this configuring vCenter Server will be registered to. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The HTTPS port of the external PSC appliance. This attribute was
added in vSphere API 6.7.
If None, port 443 will be used.</p></li>
<li><p><strong>sso_admin_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is None or has the
value true.</p></li>
<li><p><strong>ssl_verify</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) SSL verification should be enabled or disabled. If <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is
true and and <code class="docutils literal notranslate"><span class="pre">sslThumbprint</span></code> is None, the CA certificate will be
used for verification. If <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is true and
<code class="docutils literal notranslate"><span class="pre">sslThumbprint</span></code> is set then the thumbprint will be used for
verification. No verification will be performed if <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code>
value is set to false. This attribute was added in vSphere API 6.7.
If None, <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> true will be used.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.ReplicatedPscSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">ReplicatedPscSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sso_site_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partner_hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">https_port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sso_admin_password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_thumbprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_verify</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ReplicatedPscSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ReplicatedPscSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sso_site_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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.</p></li>
<li><p><strong>partner_hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The IP address or DNS resolvable name of the partner PSC appliance.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The HTTPS port of the external PSC appliance. This attribute was
added in vSphere API 6.7.
If None, port 443 will be used.</p></li>
<li><p><strong>sso_admin_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is None or has the
value true.</p></li>
<li><p><strong>ssl_verify</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) SSL verification should be enabled or disabled. This attribute was
added in vSphere API 6.7.
If None, ssl_verify true will be used.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.ReplicatedSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">ReplicatedSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">partner_hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">https_port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sso_admin_password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_thumbprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_verify</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.ReplicatedSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ReplicatedSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>partner_hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The IP address or DNS resolvable name of the partner PSC appliance.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The HTTPS port of the external PSC appliance. This attribute was
added in vSphere API 6.7.
If None, port 443 will be used.</p></li>
<li><p><strong>sso_admin_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is None or has the
value true.</p></li>
<li><p><strong>ssl_verify</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) SSL verification should be enabled or disabled. This attribute was
added in vSphere API 6.7.
If None, ssl_verify true will be used.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.SourceInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">SourceInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deployment_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deployment_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sso_domain_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active_directory_domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dns_servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_migration_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.SourceInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SourceInfo</span></code> {class contains information about the source vCenter
Server system and the database migration options. This class was added in
vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The IP address or DNS resolvable name of the source vCenter Server.
This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Source vCenter Server version. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>deployment_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.ApplianceType" title="com.vmware.vcenter.deployment_client.ApplianceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplianceType</span></code></a>) Deployment type of the source vCenter Server. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>deployment_size</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.ApplianceSize" title="com.vmware.vcenter.deployment_client.ApplianceSize"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplianceSize</span></code></a>) Deployment size of the source vCenter Server. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>sso_domain_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The SSO domain name of the source vCenter Server. This attribute
was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>active_directory_domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>dns_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) IP addresses of the DNS servers of the Active Directory server.
This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>data_migration_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.DataMigrationInfo" title="com.vmware.vcenter.deployment_client.DataMigrationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataMigrationInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.StandalonePscSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">StandalonePscSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sso_site_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sso_admin_password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sso_domain_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.StandalonePscSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">StandalonePscSpec</span></code> class contains information used to configure a
standalone PSC appliance. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sso_site_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The SSO site name used for this PSC. This attribute was added in
vSphere API 6.7.
If None, default-first-site will be used.</p></li>
<li><p><strong>sso_admin_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>sso_domain_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.StandaloneSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">StandaloneSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sso_admin_password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sso_domain_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.StandaloneSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">StandaloneSpec</span></code> class contains information used to configure a
standalone embedded vCenter Server appliance. This class was added in
vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sso_admin_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>sso_domain_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Upgrade">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">Upgrade</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Upgrade" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Upgrade</span></code> class provides methods to configure the upgrade of this
appliance from an existing vCenter appliance. This class was added in
vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Upgrade.PscSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">PscSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ceip_enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Upgrade.PscSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Upgrade.PscSpec</span></code> class contains information used to upgrade a
Platform Service Controller appliance. This class was added in vSphere API
6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ceip_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Customer experience improvement program should be enabled or
disabled for this Platform Services Controller upgrade. This
attribute was added in vSphere API 6.7.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Upgrade.SourceApplianceSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">SourceApplianceSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">https_port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_thumbprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_verify</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sso_admin_username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sso_admin_password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">root_password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssh_verify</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssh_thumbprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Upgrade.SourceApplianceSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Upgrade.SourceApplianceSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The IP address or DNS resolvable name of the source appliance. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The HTTPS port of the source appliance. This attribute was added in
vSphere API 6.7.
If None, port 443 will be used.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">sslVerify</span></code> is None or has the
value true.</p></li>
<li><p><strong>ssl_verify</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>sso_admin_username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The SSO administrator account on the source appliance. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>sso_admin_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>root_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The password of the root user on the source appliance. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>ssh_verify</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>ssh_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">sshVerify</span></code> is None or has the
value true.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpgradeSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_appliance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source_location</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">history</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vcsa_embedded</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">psc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_answer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Upgrade.UpgradeSpec</span></code> class contains information used to configure
the appliance upgrade. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>source_appliance</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Upgrade.SourceApplianceSpec" title="com.vmware.vcenter.deployment_client.Upgrade.SourceApplianceSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Upgrade.SourceApplianceSpec</span></code></a>) Source appliance spec. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>source_location</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.LocationSpec" title="com.vmware.vcenter.deployment_client.LocationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocationSpec</span></code></a>) Source location spec. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>history</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.HistoryMigrationSpec" title="com.vmware.vcenter.deployment_client.HistoryMigrationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">HistoryMigrationSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Determines how vCenter history will be migrated during the upgrade
process. vCenter history consists of:</p>
<ul>
<li><p>Statistics</p></li>
<li><p>Events</p></li>
<li><p>Tasks</p></li>
</ul>
<p>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.</p>
</p></li>
<li><p><strong>vcsa_embedded</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Upgrade.VcsaEmbeddedSpec" title="com.vmware.vcenter.deployment_client.Upgrade.VcsaEmbeddedSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Upgrade.VcsaEmbeddedSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>psc</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Upgrade.PscSpec" title="com.vmware.vcenter.deployment_client.Upgrade.PscSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Upgrade.PscSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>auto_answer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.Upgrade.VcsaEmbeddedSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VcsaEmbeddedSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ceip_enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Upgrade.VcsaEmbeddedSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Upgrade.VcsaEmbeddedSpec</span></code> class contains information used to upgrade
a Embedded vCenter Server appliance. This class was added in vSphere API
6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ceip_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Customer experience improvement program should be enabled or
disabled for this embedded vCenter Server upgrade. This attribute
was added in vSphere API 6.7.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.Upgrade.cancel">
<code class="sig-name descname"><span class="pre">cancel</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Upgrade.cancel" title="Permalink to this definition"></a></dt>
<dd><p>Cancel the appliance upgrade that is in progress. This method was added
in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the appliance is not in CONFIG_IN_PROGRESS state and if the
operation is not INSTALL.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.Upgrade.check">
<code class="sig-name descname"><span class="pre">check</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Upgrade.check" title="Permalink to this definition"></a></dt>
<dd><p>Run sanity checks using the UpgradeSpec parameters passed. This method
was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec" title="com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Upgrade.UpgradeSpec</span></code></a>) UpgradeSpec parameters to run sanity check on.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.deployment_client.CheckInfo" title="com.vmware.vcenter.deployment_client.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>CheckInfo containing the check results.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if source credentials are not valid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if source container credentials are not valid.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if passed arguments are invalid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the appliance is not in INITIALIZED state.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.Upgrade.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Upgrade.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the UpgradeSpec parameters used to configure the ongoing appliance
upgrade. This method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec" title="com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Upgrade.UpgradeSpec</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>UpgradeSpec parameters being used to configure appliance upgrade.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if appliance is not in UPGRADE_PROGRESS state.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.deployment_client.Upgrade.start">
<code class="sig-name descname"><span class="pre">start</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.Upgrade.start" title="Permalink to this definition"></a></dt>
<dd><p>Start the appliance installation. This method was added in vSphere API
6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec" title="com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Upgrade.UpgradeSpec</span></code></a>) UpgradeSpec parameters to configure the appliance upgrade.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if source credentials are not valid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if source container credentials are not valid.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if passed arguments are invalid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the appliance is not in INITIALIZED state.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.deployment_client.VerificationMode">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.deployment_client.</span></code><code class="sig-name descname"><span class="pre">VerificationMode</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.deployment_client.VerificationMode" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VerificationMode</span></code> class defines the verification modes for SSL
certificates or SSH connections. This enumeration was added in vSphere API
6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.deployment_client.VerificationMode" title="com.vmware.vcenter.deployment_client.VerificationMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">VerificationMode</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.VerificationMode.NONE">
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VerificationMode(string='NONE')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.VerificationMode.NONE" title="Permalink to this definition"></a></dt>
<dd><p>No verification will be performed. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.deployment_client.VerificationMode.THUMBPRINT">
<code class="sig-name descname"><span class="pre">THUMBPRINT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VerificationMode(string='THUMBPRINT')</span></em><a class="headerlink" href="#com.vmware.vcenter.deployment_client.VerificationMode.THUMBPRINT" title="Permalink to this definition"></a></dt>
<dd><p>Passed thumbprint will be used for verification. This class attribute was
added in vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.guest_client">
<span id="com-vmware-vcenter-guest-client-module"></span><h2>com.vmware.vcenter.guest_client module<a class="headerlink" href="#module-com.vmware.vcenter.guest_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest_client</span></code> module provides classes for managing
guest customization specifications in the vCenter Server.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.AdapterMapping">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">AdapterMapping</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mac_address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">adapter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.AdapterMapping" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">AdapterMapping</span></code> class specifies the association between a virtual
network adapter and its IP settings. This class was added in vSphere API
7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mac_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>The MAC address of a network adapter being customized.</p>
<p>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
<a class="reference external" href="https://kb.vmware.com/s/article/87648">https://kb.vmware.com/s/article/87648</a></p>
<p>. 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CustomizationSpec.interfaces</span></code> to the virtual machines
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.</p>
</p></li>
<li><p><strong>adapter</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.IPSettings" title="com.vmware.vcenter.guest_client.IPSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPSettings</span></code></a>) The IP settings for the associated virtual network adapter. This
attribute was added in vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.CloudConfiguration">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">CloudConfiguration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cloudinit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CloudConfiguration" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Guest customization settings to customize a guest operating system with
cloud configuration.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">CloudConfiguration</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.CloudConfiguration.Type" title="com.vmware.vcenter.guest_client.CloudConfiguration.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudConfiguration.Type</span></code></a>) The type of the cloud configuration. This attribute was added in
vSphere API 7.0.3.0.</p></li>
<li><p><strong>cloudinit</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.CloudinitConfiguration" title="com.vmware.vcenter.guest_client.CloudinitConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudinitConfiguration</span></code></a>) cloud-init configuration. This attribute was added in vSphere API
7.0.3.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.guest_client.CloudConfiguration.Type.CLOUDINIT" title="com.vmware.vcenter.guest_client.CloudConfiguration.Type.CLOUDINIT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">CloudConfiguration.Type.CLOUDINIT</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.CloudConfiguration.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CloudConfiguration.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CloudConfiguration.Type</span></code> class specifies different types of the
cloud configuration. This enumeration was added in vSphere API 7.0.3.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.CloudConfiguration.Type.CLOUDINIT">
<code class="sig-name descname"><span class="pre">CLOUDINIT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='CLOUDINIT')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.CloudConfiguration.Type.CLOUDINIT" title="Permalink to this definition"></a></dt>
<dd><p>cloud-init configuration. This class attribute was added in vSphere API
7.0.3.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.CloudinitConfiguration">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">CloudinitConfiguration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">userdata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CloudinitConfiguration" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Guest customization settings to customize a Linux guest operating system
with raw cloud-init data.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">CloudinitConfiguration</span></code> class contains settings that configure a
Linux machine with raw cloud-init data. See
<a class="reference external" href="https://cloudinit.readthedocs.io/en/latest">https://cloudinit.readthedocs.io/en/latest</a> about cloud-init.. This class
was added in vSphere API 7.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Metadata includes the network, instance id and hostname that
cloud-init processes to configure the virtual machine. It is in
json or yaml format. The max size of the metadata is 524288 bytes.
See
<a class="reference external" href="https://cloudinit.readthedocs.io/en/latest/topics/datasources/ovf.html">https://cloudinit.readthedocs.io/en/latest/topics/datasources/ovf.html</a>
about supported meta data formats. This attribute was added in
vSphere API 7.0.3.0.</p></li>
<li><p><strong>userdata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Userdata is the user customized content that cloud-init processes
to configure the virtual machine. See
<a class="reference external" href="https://cloudinit.readthedocs.io/en/latest/topics/format.html">https://cloudinit.readthedocs.io/en/latest/topics/format.html</a> about
user data formats. See
<a class="reference external" href="https://cloudinit.readthedocs.io/en/latest/topics/modules">https://cloudinit.readthedocs.io/en/latest/topics/modules</a>.html#
about user data modules. The max size of the userdata is 524288
bytes. This attribute was added in vSphere API 7.0.3.0.
If None, no cloud-init user data will be used as part of the
cloud-init configuration.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.ConfigurationSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">ConfigurationSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">windows_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">linux_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cloud_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.ConfigurationSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ConfigurationSpec</span></code> class specifies the settings for customizing a
guest operating system. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>windows_config</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.WindowsConfiguration" title="com.vmware.vcenter.guest_client.WindowsConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowsConfiguration</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Guest customization specification for a Windows guest operating
system. This attribute was added in vSphere API 7.0.0.0.
If None, <code class="xref py py-attr docutils literal notranslate"><span class="pre">ConfigurationSpec.linux_config</span></code> or
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ConfigurationSpec.cloud_config</span></code> must be set. Otherwise, an
appropriate fault will be thrown.</p></li>
<li><p><strong>linux_config</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.LinuxConfiguration" title="com.vmware.vcenter.guest_client.LinuxConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinuxConfiguration</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Guest customization specification for a linux guest operating
system. This attribute was added in vSphere API 7.0.0.0.
If None, <code class="xref py py-attr docutils literal notranslate"><span class="pre">ConfigurationSpec.windows_config</span></code> or
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ConfigurationSpec.cloud_config</span></code> must be set. Otherwise, an
appropriate fault will be thrown.</p></li>
<li><p><strong>cloud_config</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.CloudConfiguration" title="com.vmware.vcenter.guest_client.CloudConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudConfiguration</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Guest customization specification with cloud configuration. This
attribute was added in vSphere API 7.0.3.0.
If None, <code class="xref py py-attr docutils literal notranslate"><span class="pre">ConfigurationSpec.windows_config</span></code> or
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ConfigurationSpec.linux_config</span></code> must be set. Otherwise, an
appropriate fault will be thrown.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">CustomizationSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">configuration_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">global_dns_settings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interfaces</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CustomizationSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>configuration_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.ConfigurationSpec" title="com.vmware.vcenter.guest_client.ConfigurationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationSpec</span></code></a>) Settings to be applied to the guest during the customization. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>global_dns_settings</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.GlobalDNSSettings" title="com.vmware.vcenter.guest_client.GlobalDNSSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">GlobalDNSSettings</span></code></a>) 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.</p></li>
<li><p><strong>interfaces</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.guest_client.AdapterMapping" title="com.vmware.vcenter.guest_client.AdapterMapping"><code class="xref py py-class docutils literal notranslate"><span class="pre">AdapterMapping</span></code></a>) IP settings that are specific to a particular virtual network
adapter. The <a class="reference internal" href="#com.vmware.vcenter.guest_client.AdapterMapping" title="com.vmware.vcenter.guest_client.AdapterMapping"><code class="xref py py-class docutils literal notranslate"><span class="pre">AdapterMapping</span></code></a> class maps a network adapters
MAC address to its <a class="reference internal" href="#com.vmware.vcenter.guest_client.IPSettings" title="com.vmware.vcenter.guest_client.IPSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPSettings</span></code></a>. 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">CustomizationSpecs</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CustomizationSpecs</span></code> class provides methods to manage guest
customization specifications in the vCenter Server. This class was added in
vSphere API 6.7.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CustomizationSpecs.CreateSpec</span></code> class contains specification
information and specification object that can be passed to the
<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.create" title="com.vmware.vcenter.guest_client.CustomizationSpecs.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">CustomizationSpecs.create()</span></code></a> method. This class was added in vSphere
API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpec" title="com.vmware.vcenter.guest_client.CustomizationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpec</span></code></a>) The specification object. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Description of the specification. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the specification. This attribute was added in vSphere API
7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">os_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CustomizationSpecs.FilterSpec</span></code> class contains attributes used to
filter the results when listing guest customization specifications (see
<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.list" title="com.vmware.vcenter.guest_client.CustomizationSpecs.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">CustomizationSpecs.list()</span></code></a>). 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Names that guest customization specifications must have to match
the filter (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">CustomizationSpecs.Summary.name</span></code>). 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest.CustomizationSpec</span></code>. When methods return
a value of this class as a return value, the attribute will contain
identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest.CustomizationSpec</span></code>.
If None or empty, guest customization specifications with any name
match the filter.</p></li>
<li><p><strong>os_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.OsType" title="com.vmware.vcenter.guest_client.CustomizationSpecs.OsType"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.OsType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Guest operating system type that guest customization specifications
must have to match the filter (see
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CustomizationSpecs.Summary.os_type</span></code>). This attribute was
added in vSphere API 6.7.1.
If None, guest customization specifications with any guest
operating system type match the filter.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.Format">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Format</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Format" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CustomizationSpecs.Format</span></code> class specifies the formats the
customization specification can be exported to. This enumeration was added
in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Format</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.Format.JSON">
<code class="sig-name descname"><span class="pre">JSON</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Format(string='JSON')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Format.JSON" title="Permalink to this definition"></a></dt>
<dd><p>JSON format. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.Format.XML">
<code class="sig-name descname"><span class="pre">XML</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Format(string='XML')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Format.XML" title="Permalink to this definition"></a></dt>
<dd><p>XML format. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">last_modified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CustomizationSpecs.Info</span></code> class describes a guest customization
specification and the timestamp when it was last modified. This is returned
by the <a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.get" title="com.vmware.vcenter.guest_client.CustomizationSpecs.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">CustomizationSpecs.get()</span></code></a> method. This class was added in
vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>last_modified</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) Time when the specification was last modified. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Spec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.Spec</span></code></a>) The Spec object including specification and metadata information.
This attribute was added in vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.Metadata">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Metadata</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Metadata" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CustomizationSpecs.Metadata</span></code> class contains metadata i.e. name and
description related to a customization specification. This class was added
in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Description of the specification. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the specification. This attribute was added in vSphere API
7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.OsType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">OsType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.OsType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CustomizationSpecs.OsType</span></code> class defines the types of guest
operating systems for which guest customization is supported. This
enumeration was added in vSphere API 6.7.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">OsType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.OsType.LINUX">
<code class="sig-name descname"><span class="pre">LINUX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">OsType(string='LINUX')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.OsType.LINUX" title="Permalink to this definition"></a></dt>
<dd><p>A customization specification for a Linux guest operating system. This
class attribute was added in vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.OsType.WINDOWS">
<code class="sig-name descname"><span class="pre">WINDOWS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">OsType(string='WINDOWS')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.OsType.WINDOWS" title="Permalink to this definition"></a></dt>
<dd><p>A customization specification for a Windows guest operating system. This
class attribute was added in vSphere API 6.7.1.</p>
</dd></dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.guest.CustomizationSpec'</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>The resource type for a vCenter guest customization specification. This class
attribute was added in vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.Spec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Spec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fingerprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Spec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CustomizationSpecs.Spec</span></code> class contains the specification
information and specification object. This is passed to the
<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.set" title="com.vmware.vcenter.guest_client.CustomizationSpecs.set"><code class="xref py py-func docutils literal notranslate"><span class="pre">CustomizationSpecs.set()</span></code></a> method. This class was added in vSphere API
7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>fingerprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpec" title="com.vmware.vcenter.guest_client.CustomizationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpec</span></code></a>) The specification object. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Description of the specification. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the specification. This attribute was added in vSphere API
7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">os_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">last_modified</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CustomizationSpecs.Summary</span></code> class contains commonly used information
about a guest customization specification. This class was added in vSphere
API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest.CustomizationSpec</span></code>. When methods return
a value of this class as a return value, the attribute will be an
identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest.CustomizationSpec</span></code>.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Description of the guest customization specification. This
attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>os_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.OsType" title="com.vmware.vcenter.guest_client.CustomizationSpecs.OsType"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.OsType</span></code></a>) Guest operating system type for which that this guest customization
specification applies. This attribute was added in vSphere API
6.7.1.</p></li>
<li><p><strong>last_modified</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) Date and tme when this guest customization specification was last
modified. This attribute was added in vSphere API 6.7.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.create" title="Permalink to this definition"></a></dt>
<dd><p>Creates a customization specification. This method was added in vSphere
API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.CreateSpec</span></code></a>) 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.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The name of the customization specification that is created.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest.CustomizationSpec</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if a customization specification is already present with the same
name.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the specified specification is not a valid one.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Provisioning.ModifyCustSpecs</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.delete" title="Permalink to this definition"></a></dt>
<dd><p>Deletes a customization specification with the specified identifier.
This method was added in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of the customization specification that needs to be
deleted.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest.CustomizationSpec</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if a customization specification is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Provisioning.ModifyCustSpecs</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.export">
<code class="sig-name descname"><span class="pre">export</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">format</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.export" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of the customization specification that has to be
returned.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest.CustomizationSpec</span></code>.</p></li>
<li><p><strong>format</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Format" title="com.vmware.vcenter.guest_client.CustomizationSpecs.Format"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.Format</span></code></a>) The format in which the customization specification has to be
returned.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The string representation of the customization specification in the
specified format.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If value of <code class="docutils literal notranslate"><span class="pre">format</span></code> is not valid.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the customization specification is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Provisioning.ReadCustSpecs</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the guest customization specification from vCenter with the
specified identifier. This method was added in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of the customization specification.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest.CustomizationSpec</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Info" title="com.vmware.vcenter.guest_client.CustomizationSpecs.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A customization spec with the specified identifier.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if a customization specification is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Provisioning.ReadCustSpecs</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.import_specification">
<code class="sig-name descname"><span class="pre">import_specification</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">customization_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.import_specification" title="Permalink to this definition"></a></dt>
<dd><p>Converts a well formatted string to a
<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.CreateSpec</span></code></a>. The resulting object can be
passed to <a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.create" title="com.vmware.vcenter.guest_client.CustomizationSpecs.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">CustomizationSpecs.create()</span></code></a> method. This method was
added in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>customization_spec</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) content to be converted to the spec.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.CreateSpec</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A proper specification of type
<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.CreateSpec</span></code></a></p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the specified content cannot be properly converted into a proper
valid <a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.CreateSpec</span></code></a> object.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Provisioning.ModifyCustSpecs</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about at most 1000 visible (subject to permission
checks) guest customization specifications in vCenter matching the
<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.FilterSpec</span></code></a>. This method was added in
vSphere API 6.7.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specification of matching guest customization specifications for
which information should be returned.
If None, the behavior is equivalent to a
<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.FilterSpec</span></code></a> with all attributes None
which means all guest customization specifications match the
filter.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.list" title="com.vmware.vcenter.guest_client.CustomizationSpecs.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Summary" title="com.vmware.vcenter.guest_client.CustomizationSpecs.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Commonly used information about the guest customization
specifications matching the <a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.FilterSpec</span></code></a>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">CustomizationSpecs.FilterSpec.os_type</span></code> attribute
contains a value that is not supported by the server.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
if more than 1000 guest customization specifications match the
<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.FilterSpec</span></code></a>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Provisioning.ReadCustSpecs</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.guest_client.CustomizationSpecs.set">
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.set" title="Permalink to this definition"></a></dt>
<dd><p>Sets an existing specification, possibly after retrieving (by using
<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.get" title="com.vmware.vcenter.guest_client.CustomizationSpecs.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">CustomizationSpecs.get()</span></code></a>) and editing it. This method was added
in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of the customization specification that needs to be set.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.guest.CustomizationSpec</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Spec" title="com.vmware.vcenter.guest_client.CustomizationSpecs.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomizationSpecs.Spec</span></code></a>) The new specification that will overwrite the existing
specification.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If, based on the items 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 clients change.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the settings in <code class="docutils literal notranslate"><span class="pre">spec</span></code> are not valid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if a customization specification is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Provisioning.ModifyCustSpecs</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.Domain">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">Domain</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">workgroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain_username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain_password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.Domain" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Domain</span></code> 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
<a class="reference external" href="https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx">https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx</a>. This
class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.Domain.Type" title="com.vmware.vcenter.guest_client.Domain.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Domain.Type</span></code></a>) The type of network to join after the customization. This attribute
was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>workgroup</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.guest_client.Domain.Type.WORKGROUP" title="com.vmware.vcenter.guest_client.Domain.Type.WORKGROUP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Domain.Type.WORKGROUP</span></code></a>.</p></li>
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.guest_client.Domain.Type.DOMAIN" title="com.vmware.vcenter.guest_client.Domain.Type.DOMAIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Domain.Type.DOMAIN</span></code></a>.</p></li>
<li><p><strong>domain_username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.guest_client.Domain.Type.DOMAIN" title="com.vmware.vcenter.guest_client.Domain.Type.DOMAIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Domain.Type.DOMAIN</span></code></a>.</p></li>
<li><p><strong>domain_password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The domain user password that has permission to join the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Domain.domain_username</span></code> 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 <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.guest_client.Domain.Type.DOMAIN" title="com.vmware.vcenter.guest_client.Domain.Type.DOMAIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Domain.Type.DOMAIN</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.Domain.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.Domain.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Domain.Type</span></code> 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.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.Domain.Type.DOMAIN">
<code class="sig-name descname"><span class="pre">DOMAIN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='DOMAIN')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.Domain.Type.DOMAIN" title="Permalink to this definition"></a></dt>
<dd><p>The virtual machine should be be joined to a domain. This class attribute
was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.Domain.Type.WORKGROUP">
<code class="sig-name descname"><span class="pre">WORKGROUP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='WORKGROUP')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.Domain.Type.WORKGROUP" title="Permalink to this definition"></a></dt>
<dd><p>The virtual machine should be be joined to a workgroup. This class
attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.GlobalDNSSettings">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">GlobalDNSSettings</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dns_suffix_list</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dns_servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.GlobalDNSSettings" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">GlobalDNSSettings</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dns_suffix_list</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>dns_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.GuiUnattended">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">GuiUnattended</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auto_logon</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_logon_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time_zone</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.GuiUnattended" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">GuiUnattended</span></code> 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
<a class="reference external" href="https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx">https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx</a>. This
class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>auto_logon</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Flag to determine whether or not the machine automatically logs on
as Administrator. See the <code class="xref py py-attr docutils literal notranslate"><span class="pre">GuiUnattended.password</span></code> property.
If <code class="xref py py-attr docutils literal notranslate"><span class="pre">GuiUnattended.auto_logon</span></code> flag is set, then
<code class="xref py py-attr docutils literal notranslate"><span class="pre">GuiUnattended.password</span></code> must not be None or the guest
customization will fail. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>auto_logon_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">GuiUnattended.auto_logon</span></code> flag is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, 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.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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.</p></li>
<li><p><strong>time_zone</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The time zone index for the virtual machine. Numbers correspond to
time zones at
<a class="reference external" href="https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values">https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values</a>.
This attribute was added in vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.HostnameGenerator">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">HostnameGenerator</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fixed_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.HostnameGenerator" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">HostnameGenerator</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.HostnameGenerator.Type" title="com.vmware.vcenter.guest_client.HostnameGenerator.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostnameGenerator.Type</span></code></a>) The type of the Name Generator. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>fixed_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.guest_client.HostnameGenerator.Type.FIXED" title="com.vmware.vcenter.guest_client.HostnameGenerator.Type.FIXED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">HostnameGenerator.Type.FIXED</span></code></a>.</p></li>
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.guest_client.HostnameGenerator.Type.PREFIX" title="com.vmware.vcenter.guest_client.HostnameGenerator.Type.PREFIX"><code class="xref py py-attr docutils literal notranslate"><span class="pre">HostnameGenerator.Type.PREFIX</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.HostnameGenerator.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.HostnameGenerator.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">HostnameGenerator.Type</span></code> class specifies different types of Name
Generators. This enumeration was added in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.HostnameGenerator.Type.FIXED">
<code class="sig-name descname"><span class="pre">FIXED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='FIXED')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.HostnameGenerator.Type.FIXED" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.HostnameGenerator.Type.PREFIX">
<code class="sig-name descname"><span class="pre">PREFIX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='PREFIX')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.HostnameGenerator.Type.PREFIX" title="Permalink to this definition"></a></dt>
<dd><p>Specifies that a unique name should be generated by concatenating the base
string with a number including the network name of the guest.</p>
<p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.HostnameGenerator.Type.USER_INPUT_REQUIRED">
<code class="sig-name descname"><span class="pre">USER_INPUT_REQUIRED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='USER_INPUT_REQUIRED')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.HostnameGenerator.Type.USER_INPUT_REQUIRED" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.HostnameGenerator.Type.VIRTUAL_MACHINE">
<code class="sig-name descname"><span class="pre">VIRTUAL_MACHINE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='VIRTUAL_MACHINE')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.HostnameGenerator.Type.VIRTUAL_MACHINE" title="Permalink to this definition"></a></dt>
<dd><p>Specifies that the VirtualCenter should generate a virtual machine name.</p>
<p>The name is generated from a base prefix comprising the virtual machine
entity name. A number is appended, if necessary, to make it unique.</p>
<p>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.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.IPSettings">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">IPSettings</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ipv4</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ipv6</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">windows</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.IPSettings" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">IPSettings</span></code> class specifies the IP settings for a virtual network
adapter. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ipv4</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.Ipv4" title="com.vmware.vcenter.guest_client.Ipv4"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>ipv6</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.Ipv6" title="com.vmware.vcenter.guest_client.Ipv6"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv6</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>windows</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings" title="com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowsNetworkAdapterSettings</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.Ipv4">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">Ipv4</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gateways</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.Ipv4" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv4</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.Ipv4.Type" title="com.vmware.vcenter.guest_client.Ipv4.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4.Type</span></code></a>) The type of the IPv4 configuration. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>ip_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.guest_client.Ipv4.Type.STATIC" title="com.vmware.vcenter.guest_client.Ipv4.Type.STATIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ipv4.Type.STATIC</span></code></a>.</p></li>
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The IPv4 CIDR prefix, for example, 24. See
<a class="reference external" href="http://www.oav.net/mirrors/cidr.html">http://www.oav.net/mirrors/cidr.html</a> 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 <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.guest_client.Ipv4.Type.STATIC" title="com.vmware.vcenter.guest_client.Ipv4.Type.STATIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ipv4.Type.STATIC</span></code></a>.</p></li>
<li><p><strong>gateways</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Gateways for the IPv4 address. This attribute was added in vSphere
API 7.0.0.0.
If None, no gateways are set.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.Ipv4.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.Ipv4.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv4.Type</span></code> class specifies different types of the IPv4
configuration. This enumeration was added in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.Ipv4.Type.DHCP">
<code class="sig-name descname"><span class="pre">DHCP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='DHCP')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.Ipv4.Type.DHCP" title="Permalink to this definition"></a></dt>
<dd><p>DHCP configuration. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.Ipv4.Type.STATIC">
<code class="sig-name descname"><span class="pre">STATIC</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='STATIC')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.Ipv4.Type.STATIC" title="Permalink to this definition"></a></dt>
<dd><p>Static configuration. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.Ipv4.Type.USER_INPUT_REQUIRED">
<code class="sig-name descname"><span class="pre">USER_INPUT_REQUIRED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='USER_INPUT_REQUIRED')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.Ipv4.Type.USER_INPUT_REQUIRED" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.Ipv6">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">Ipv6</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ipv6</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gateways</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.Ipv6" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv6</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.Ipv6.Type" title="com.vmware.vcenter.guest_client.Ipv6.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv6.Type</span></code></a>) The IPv6 configuration type. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>ipv6</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.guest_client.Ipv6Address" title="com.vmware.vcenter.guest_client.Ipv6Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv6Address</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.guest_client.Ipv6.Type.STATIC" title="com.vmware.vcenter.guest_client.Ipv6.Type.STATIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Ipv6.Type.STATIC</span></code></a>.</p></li>
<li><p><strong>gateways</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) gateways for the IPv6 address. This attribute was added in vSphere
API 7.0.0.0.
If None, no gateways are set.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.Ipv6.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.Ipv6.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv6.Type</span></code> class specifies different types of the IPv6
configuration. This enumeration was added in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.Ipv6.Type.DHCP">
<code class="sig-name descname"><span class="pre">DHCP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='DHCP')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.Ipv6.Type.DHCP" title="Permalink to this definition"></a></dt>
<dd><p>DHCP IPv6 configuration. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.Ipv6.Type.STATIC">
<code class="sig-name descname"><span class="pre">STATIC</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='STATIC')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.Ipv6.Type.STATIC" title="Permalink to this definition"></a></dt>
<dd><p>Static IPv6 configuration. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.Ipv6.Type.USER_INPUT_REQUIRED">
<code class="sig-name descname"><span class="pre">USER_INPUT_REQUIRED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='USER_INPUT_REQUIRED')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.Ipv6.Type.USER_INPUT_REQUIRED" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.Ipv6Address">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">Ipv6Address</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ip_address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.Ipv6Address" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv6Address</span></code> class specifies the the settings for a Static IPv6
configuration. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ip_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Static IPv6 Address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The CIDR prefix for the interface. This attribute was added in
vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.LinuxConfiguration">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">LinuxConfiguration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time_zone</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">script_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.LinuxConfiguration" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Guest customization Settings to customize a Linux guest operating system.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">LinuxConfiguration</span></code> class contains settings that identify a Linux
machine in the same way that the <a class="reference internal" href="#com.vmware.vcenter.guest_client.WindowsConfiguration" title="com.vmware.vcenter.guest_client.WindowsConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowsConfiguration</span></code></a> class
identifies a Windows machine.. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>hostname</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.HostnameGenerator" title="com.vmware.vcenter.guest_client.HostnameGenerator"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostnameGenerator</span></code></a>) The network host name of the Linux virtual machine. This attribute
was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The fully qualified domain name. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>time_zone</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>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 (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) in the form “Area/Location,” in
which Area is a continent or ocean name, and Location is the city,
island, or other regional designation.</p>
<p>See the <a class="reference external" href="https://kb.vmware.com/kb/2145518">https://kb.vmware.com/kb/2145518</a> 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.</p>
</p></li>
<li><p><strong>script_text</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>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.</p>
<p>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.</p>
<blockquote>
<div><p>A Linux shell script example:</p>
<p><code class="docutils literal notranslate"><span class="pre">#!/bin/sh</span>
<span class="pre">if</span> <span class="pre">[</span> <span class="pre">x$1</span> <span class="pre">==</span> <span class="pre">x&quot;precustomization&quot;</span> <span class="pre">];</span> <span class="pre">then</span>
<span class="pre">echo</span> <span class="pre">&quot;Do</span> <span class="pre">Precustomization</span> <span class="pre">tasks&quot;</span>
<span class="pre">#code</span> <span class="pre">for</span> <span class="pre">pre-customization</span> <span class="pre">actions...</span>
<span class="pre">elif</span> <span class="pre">[</span> <span class="pre">x$1</span> <span class="pre">==</span> <span class="pre">x&quot;postcustomization&quot;</span> <span class="pre">];</span> <span class="pre">then</span>
<span class="pre">echo</span> <span class="pre">&quot;Do</span> <span class="pre">Postcustomization</span> <span class="pre">tasks&quot;</span>
<span class="pre">#code</span> <span class="pre">for</span> <span class="pre">post-customization</span> <span class="pre">actions...</span>
<span class="pre">fi</span></code>. This attribute was added in vSphere API 7.0.0.0.</p>
</div></blockquote>
<p>If None, no script will be executed.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.UserData">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">UserData</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">computer_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">full_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">organization</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">product_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.UserData" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">UserData</span></code> 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 <a class="reference external" href="https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx">https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx</a>.
This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>computer_name</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.HostnameGenerator" title="com.vmware.vcenter.guest_client.HostnameGenerator"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostnameGenerator</span></code></a>) 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 <a class="reference internal" href="#com.vmware.vcenter.guest_client.HostnameGenerator" title="com.vmware.vcenter.guest_client.HostnameGenerator"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostnameGenerator</span></code></a> for various
options. This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>full_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>organization</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the organization that owns the computer. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>product_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The product Key to use for activating Windows guest operating
system. This attribute was added in vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.WindowsConfiguration">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">WindowsConfiguration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reboot</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sysprep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sysprep_xml</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.WindowsConfiguration" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">WindowsConfiguration</span></code> class specifies the settings for customizing a
windows guest operating system. This class was added in vSphere API
7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>reboot</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption" title="com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowsConfiguration.RebootOption</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <a class="reference internal" href="#com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption.REBOOT" title="com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption.REBOOT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">WindowsConfiguration.RebootOption.REBOOT</span></code></a>
option will be chosen.</p></li>
<li><p><strong>sysprep</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.WindowsSysprep" title="com.vmware.vcenter.guest_client.WindowsSysprep"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowsSysprep</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Customization settings like user details, administrator details,
etc for the windows guest operating system. Exactly one of
<code class="docutils literal notranslate"><span class="pre">sysprep</span></code> or <code class="docutils literal notranslate"><span class="pre">sysprepXml</span></code> 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.</p></li>
<li><p><strong>sysprep_xml</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<a class="reference external" href="https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/update-windows-settings-and-scripts-create-your-own-answer-file-sxs">https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/update-windows-settings-and-scripts-create-your-own-answer-file-sxs</a>
Exactly one of <code class="docutils literal notranslate"><span class="pre">sysprep</span></code> or <code class="docutils literal notranslate"><span class="pre">sysprepXml</span></code> 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.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">RebootOption</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">WindowsConfiguration.RebootOption</span></code> class specifies what should be
done to the guest after the customization. This enumeration was added in
vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">RebootOption</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption.NO_REBOOT">
<code class="sig-name descname"><span class="pre">NO_REBOOT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">RebootOption(string='NO_REBOOT')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption.NO_REBOOT" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption.REBOOT">
<code class="sig-name descname"><span class="pre">REBOOT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">RebootOption(string='REBOOT')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption.REBOOT" title="Permalink to this definition"></a></dt>
<dd><p>Reboot the guest after customization. This class attribute was added in
vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption.SHUTDOWN">
<code class="sig-name descname"><span class="pre">SHUTDOWN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">RebootOption(string='SHUTDOWN')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption.SHUTDOWN" title="Permalink to this definition"></a></dt>
<dd><p>Shutdown the guest after customization. This class attribute was added in
vSphere API 7.0.0.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">WindowsNetworkAdapterSettings</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dns_servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dns_domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wins_servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">net_bios_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">WindowsNetworkAdapterSettings</span></code> class specifies Windows specific
Network settings for a virtual network adapter. This class was added in
vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dns_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>A list of server IP addresses to use for DNS lookup in a Windows
guest operating system.</p>
<p>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.</p>
</p></li>
<li><p><strong>dns_domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>wins_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>net_bios_mode</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode" title="com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowsNetworkAdapterSettings.NetBIOSMode</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) NetBIOS setting for Windows. This attribute was added in vSphere
API 7.0.0.0.
If None, existing NetBIOS mode will be retained.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NetBIOSMode</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">WindowsNetworkAdapterSettings.NetBIOSMode</span></code> class specifies different
NetBIOS settings for Windows guest operating systems. This enumeration was
added in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">NetBIOSMode</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode.DISABLE">
<code class="sig-name descname"><span class="pre">DISABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetBIOSMode(string='DISABLE')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode.DISABLE" title="Permalink to this definition"></a></dt>
<dd><p>Never use NetBIOS. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode.ENABLE">
<code class="sig-name descname"><span class="pre">ENABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetBIOSMode(string='ENABLE')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode.ENABLE" title="Permalink to this definition"></a></dt>
<dd><p>Always use NetBIOS. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode.USE_DHCP">
<code class="sig-name descname"><span class="pre">USE_DHCP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetBIOSMode(string='USE_DHCP')</span></em><a class="headerlink" href="#com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode.USE_DHCP" title="Permalink to this definition"></a></dt>
<dd><p>DHCP server decides whether or not to use NetBIOS. This class attribute was
added in vSphere API 7.0.0.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.guest_client.WindowsSysprep">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.guest_client.</span></code><code class="sig-name descname"><span class="pre">WindowsSysprep</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gui_run_once_commands</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gui_unattended</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.guest_client.WindowsSysprep" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">WindowsSysprep</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>gui_run_once_commands</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<a class="reference external" href="https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx">https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx</a>
The commands listed here ar executed when a user logs on the first
time after customization completes. The logon may be driven by
<code class="xref py py-attr docutils literal notranslate"><span class="pre">GuiUnattended.auto_logon</span></code> 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.</p></li>
<li><p><strong>user_data</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.UserData" title="com.vmware.vcenter.guest_client.UserData"><code class="xref py py-class docutils literal notranslate"><span class="pre">UserData</span></code></a>) Personal data pertaining to the owner of the virtual machine. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>domain</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.Domain" title="com.vmware.vcenter.guest_client.Domain"><code class="xref py py-class docutils literal notranslate"><span class="pre">Domain</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>gui_unattended</strong> (<a class="reference internal" href="#com.vmware.vcenter.guest_client.GuiUnattended" title="com.vmware.vcenter.guest_client.GuiUnattended"><code class="xref py py-class docutils literal notranslate"><span class="pre">GuiUnattended</span></code></a>) Information related to unattended installation. This attribute was
added in vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.hvc_client">
<span id="com-vmware-vcenter-hvc-client-module"></span><h2>com.vmware.vcenter.hvc_client module<a class="headerlink" href="#module-com.vmware.vcenter.hvc_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc_client</span></code> module provides classes to manage hybrid
links between a local and remote Platform Service Controller. Usage beyond
VMware Cloud on AWS is not supported.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.hvc_client.Links">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.hvc_client.</span></code><code class="sig-name descname"><span class="pre">Links</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc_client.Links" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Links</span></code> 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.
<strong>Warning:</strong> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.hvc_client.Links.CertificateInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CertificateInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ssl_thumbprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc_client.Links.CertificateInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Links.CertificateInfo</span></code> class contains information about the SSL
certificate for a destination PSC endpoint. <strong>Warning:</strong> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ssl_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The SHA-256 thumbprint of the SSL certificate for the destination
PSC endpoint. <strong>Warning:</strong> 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.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.hvc_client.Links.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">psc_hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_thumbprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">admin_groups</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc_client.Links.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Links.CreateSpec</span></code> class is the specification used for the hybrid
link creation. <strong>Warning:</strong> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>psc_hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The PSC hostname for the domain to be linked. <strong>Warning:</strong> 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.</p></li>
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The HTTPS port of the PSC to be linked. <strong>Warning:</strong> 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 443 will be used as default.</p></li>
<li><p><strong>domain_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The domain to which the PSC belongs. <strong>Warning:</strong> 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.</p></li>
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The administrator username of the PSC. <strong>Warning:</strong> 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.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The administrator password of the PSC. <strong>Warning:</strong> 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.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The ssl thumbprint of the server. <strong>Warning:</strong> 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 no thumbprint is passed.</p></li>
<li><p><strong>admin_groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) List of groups to be added to enable administrator access to.
<strong>Warning:</strong> 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 administrator access will not be set.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.hvc_client.Links.Credentials">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Credentials</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc_client.Links.Credentials" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Links.Credentials</span></code> class specifies user credentials to make a
successful connection to remote endpoint. <strong>Warning:</strong> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the user to authenticate. <strong>Warning:</strong> This attribute is
available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Password for the user. <strong>Warning:</strong> This attribute is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.hvc_client.Links.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">link</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc_client.Links.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Links.Summary</span></code> class contains information about the hybrid link.
<strong>Warning:</strong> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Unique identifier for the link. <strong>Warning:</strong> 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</p></li>
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The display name is set to the domain name which was set during
create. <strong>Warning:</strong> 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.hvc_client.Links.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc_client.Links.create" title="Permalink to this definition"></a></dt>
<dd><p>Creates a new hybrid link between the local and foreign PSC. Usage
beyond VMware Cloud on AWS is not supported. <strong>Warning:</strong> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.hvc_client.Links.CreateSpec" title="com.vmware.vcenter.hvc_client.Links.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Links.CreateSpec</span></code></a>) Specification for the new link to be created.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The identifier of the newly linked domain.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
If the link already exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the values of any of the attributes of the <code class="docutils literal notranslate"><span class="pre">spec</span></code> parameter
are not valid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
If the PSC or the VC version is not supported.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
If the user is not authorized.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnverifiedPeer" title="com.vmware.vapi.std.errors_client.UnverifiedPeer"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnverifiedPeer</span></code></a>
If the SSL certificate of the foreign PSC cannot be validated by
comparing with the thumbprint provided in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Links.CreateSpec.ssl_thumbprint</span></code> or if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Links.CreateSpec.ssl_thumbprint</span></code> is None. The value of the
{\&#64;link UnverifiedPeer#data) attribute will be a class that
contains all the attributes defined in
<a class="reference internal" href="#com.vmware.vcenter.hvc_client.Links.CertificateInfo" title="com.vmware.vcenter.hvc_client.Links.CertificateInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Links.CertificateInfo</span></code></a>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.hvc_client.Links.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">link</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc_client.Links.delete" title="Permalink to this definition"></a></dt>
<dd><p>Deletes an existing hybrid link. Usage beyond VMware Cloud on AWS is
not supported. <strong>Warning:</strong> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the hybrid link.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.hvc.Links</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If the hybrid link associated with <code class="docutils literal notranslate"><span class="pre">link</span></code> does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
If the user is not authorized.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.hvc_client.Links.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc_client.Links.list" title="Permalink to this definition"></a></dt>
<dd><p>Enumerates the list of registered hybrid links. Usage beyond VMware
Cloud on AWS is not supported. <strong>Warning:</strong> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.hvc_client.Links.list" title="com.vmware.vcenter.hvc_client.Links.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.hvc_client.Links.Summary" title="com.vmware.vcenter.hvc_client.Links.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Links.Summary</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The <a class="reference internal" href="#com.vmware.vcenter.hvc_client.Links.list" title="com.vmware.vcenter.hvc_client.Links.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of hybrid link information.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.hvc_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.hvc_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.hvc_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.identity_client">
<span id="com-vmware-vcenter-identity-client-module"></span><h2>com.vmware.vcenter.identity_client module<a class="headerlink" href="#module-com.vmware.vcenter.identity_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.identity_client</span></code> module provides classes to manage
VcIdentity.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.identity_client.</span></code><code class="sig-name descname"><span class="pre">Providers</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers</span></code> interface provides methods to list, read and modify
vCenter Server identity providers. This class was added in vSphere API
7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.ActiveDirectoryOverLdap">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ActiveDirectoryOverLdap</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">users_base_dn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups_base_dn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_endpoints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cert_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.ActiveDirectoryOverLdap" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.ActiveDirectoryOverLdap</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) User name to connect to the active directory server. This attribute
was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Password to connect to the active directory server. This attribute
was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>users_base_dn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Base distinguished name for users. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>groups_base_dn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Base distinguished name for groups. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>server_endpoints</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>cert_chain</strong> (<a class="reference internal" href="#com.vmware.vcenter.certificate_management_client.X509CertChain" title="com.vmware.vcenter.certificate_management_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.certificate_management_client.X509CertChain</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.ConfigType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ConfigType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.ConfigType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.ConfigType</span></code> class contains the possible types of vCenter
Server identity providers. This enumeration was added in vSphere API
7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2">
<code class="sig-name descname"><span class="pre">Oauth2</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigType(string='Oauth2')</span></em><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2" title="Permalink to this definition"></a></dt>
<dd><p>Config for OAuth2. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc">
<code class="sig-name descname"><span class="pre">Oidc</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigType(string='Oidc')</span></em><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc" title="Permalink to this definition"></a></dt>
<dd><p>Config for OIDC. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oauth2</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oidc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">org_ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_query_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idm_protocol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idm_endpoints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active_directory_over_ldap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upn_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.CreateSpec</span></code> class contains the information used to create
an identity provider. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>config_tag</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType" title="com.vmware.vcenter.identity_client.Providers.ConfigType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ConfigType</span></code></a>) The config type of the identity provider. This attribute was added
in vSphere API 7.0.0.0.</p></li>
<li><p><strong>oauth2</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2CreateSpec" title="com.vmware.vcenter.identity_client.Providers.Oauth2CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Oauth2CreateSpec</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
<li><p><strong>oidc</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.OidcCreateSpec" title="com.vmware.vcenter.identity_client.Providers.OidcCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.OidcCreateSpec</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
<li><p><strong>org_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>is_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specifies whether the provider is the default provider. Setting
<code class="docutils literal notranslate"><span class="pre">isDefault</span></code> 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.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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</p></li>
<li><p><strong>domain_names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 users 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.</p></li>
<li><p><strong>auth_query_params</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>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 “&amp;” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. This attribute was added in vSphere API 7.0.0.0.
If None, the map will be empty.</p>
</p></li>
<li><p><strong>idm_protocol</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol" title="com.vmware.vcenter.identity_client.Providers.IdmProtocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.IdmProtocol</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>idm_endpoints</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">idmProtocol</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.REST" title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.REST"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.IdmProtocol.REST</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM" title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.IdmProtocol.SCIM</span></code></a>, or
<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM2_0" title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM2_0"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.IdmProtocol.SCIM2_0</span></code></a>.</p></li>
<li><p><strong>active_directory_over_ldap</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ActiveDirectoryOverLdap" title="com.vmware.vcenter.identity_client.Providers.ActiveDirectoryOverLdap"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ActiveDirectoryOverLdap</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">idmProtocol</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.LDAP" title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.LDAP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.IdmProtocol.LDAP</span></code></a>.</p></li>
<li><p><strong>upn_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>groups_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.IdmProtocol">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">IdmProtocol</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.IdmProtocol</span></code> class contains the possible types of
communication protocols to the identity management endpoints. This
enumeration was added in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">IdmProtocol</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.identity_client.Providers.IdmProtocol.LDAP">
<code class="sig-name descname"><span class="pre">LDAP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IdmProtocol(string='LDAP')</span></em><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.LDAP" title="Permalink to this definition"></a></dt>
<dd><p>LDAP protocol based identity management endpoints. This class attribute was
added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.identity_client.Providers.IdmProtocol.REST">
<code class="sig-name descname"><span class="pre">REST</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IdmProtocol(string='REST')</span></em><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.REST" title="Permalink to this definition"></a></dt>
<dd><p>REST protocol based identity management endpoints. This class attribute was
added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM">
<code class="sig-name descname"><span class="pre">SCIM</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IdmProtocol(string='SCIM')</span></em><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM" title="Permalink to this definition"></a></dt>
<dd><p>SCIM V1.1 protocol based identity management endpoints. This class
attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM2_0">
<code class="sig-name descname"><span class="pre">SCIM2_0</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IdmProtocol(string='SCIM2_0')</span></em><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM2_0" title="Permalink to this definition"></a></dt>
<dd><p>SCIM V2.0 protocol based identity management endpoints. This class
attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">org_ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oauth2</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oidc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_query_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idm_protocol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idm_endpoints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active_directory_over_ldap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upn_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Info</span></code> class contains the information about an identity
provider. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>org_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>config_tag</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType" title="com.vmware.vcenter.identity_client.Providers.ConfigType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ConfigType</span></code></a>) The config type of the identity provider. This attribute was added
in vSphere API 7.0.0.0.</p></li>
<li><p><strong>oauth2</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2Info" title="com.vmware.vcenter.identity_client.Providers.Oauth2Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Oauth2Info</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
<li><p><strong>oidc</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.OidcInfo" title="com.vmware.vcenter.identity_client.Providers.OidcInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.OidcInfo</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
<li><p><strong>is_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Specifies whether the provider is the default provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>domain_names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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 users 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.</p></li>
<li><p><strong>auth_query_params</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) <p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>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 “&amp;” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. 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.</p>
</p></li>
<li><p><strong>idm_protocol</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol" title="com.vmware.vcenter.identity_client.Providers.IdmProtocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.IdmProtocol</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>idm_endpoints</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">idmProtocol</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.REST" title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.REST"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.IdmProtocol.REST</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM" title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.IdmProtocol.SCIM</span></code></a>, or
<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM2_0" title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM2_0"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.IdmProtocol.SCIM2_0</span></code></a>.</p></li>
<li><p><strong>active_directory_over_ldap</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ActiveDirectoryOverLdap" title="com.vmware.vcenter.identity_client.Providers.ActiveDirectoryOverLdap"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ActiveDirectoryOverLdap</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">idmProtocol</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.LDAP" title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.LDAP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.IdmProtocol.LDAP</span></code></a>.</p></li>
<li><p><strong>upn_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>groups_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Oauth2AuthenticationMethod</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Oauth2AuthenticationMethod</span></code> class contains the possible
types of OAuth2 authentication methods. This enumeration was added in
vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Oauth2AuthenticationMethod</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.CLIENT_SECRET_BASIC">
<code class="sig-name descname"><span class="pre">CLIENT_SECRET_BASIC</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Oauth2AuthenticationMethod(string='CLIENT_SECRET_BASIC')</span></em><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.CLIENT_SECRET_BASIC" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.CLIENT_SECRET_JWT">
<code class="sig-name descname"><span class="pre">CLIENT_SECRET_JWT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Oauth2AuthenticationMethod(string='CLIENT_SECRET_JWT')</span></em><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.CLIENT_SECRET_JWT" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.CLIENT_SECRET_POST">
<code class="sig-name descname"><span class="pre">CLIENT_SECRET_POST</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Oauth2AuthenticationMethod(string='CLIENT_SECRET_POST')</span></em><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.CLIENT_SECRET_POST" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.PRIVATE_KEY_JWT">
<code class="sig-name descname"><span class="pre">PRIVATE_KEY_JWT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Oauth2AuthenticationMethod(string='PRIVATE_KEY_JWT')</span></em><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.PRIVATE_KEY_JWT" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Oauth2CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">public_key_uri</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_secret</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">claim_map</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issuer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">authentication_method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_query_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Oauth2CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Oauth2CreateSpec</span></code> class contains the information used to
create an OAuth2 identity provider. This class was added in vSphere API
7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>auth_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Authentication/authorization endpoint of the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>token_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Token endpoint of the provider. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>public_key_uri</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Endpoint to retrieve the provider public key for validation. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_secret</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The secret shared between the client and the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>claim_map</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)) 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.</p></li>
<li><p><strong>issuer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>authentication_method</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod" title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Oauth2AuthenticationMethod</span></code></a>) Authentication method used by the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>auth_query_params</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>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 “&amp;” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. This attribute was added in vSphere API 7.0.0.0.
If None, the map will be empty.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Oauth2Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">public_key_uri</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_secret</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">claim_map</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issuer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">authentication_method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_query_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Oauth2Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Oauth2Info</span></code> class contains the information about an OAuth2
identity provider. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>auth_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Authentication/authorization endpoint of the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>token_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Token endpoint of the provider. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>public_key_uri</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Endpoint to retrieve the provider public key for validation. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_secret</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The secret shared between the client and the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>claim_map</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)) 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.</p></li>
<li><p><strong>issuer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>authentication_method</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod" title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Oauth2AuthenticationMethod</span></code></a>) Authentication method used by the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>auth_query_params</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) <p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>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 “&amp;” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. This attribute was added in vSphere API 7.0.0.0.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Oauth2Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">authentication_header</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_query_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Oauth2Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Oauth2Summary</span></code> class contains commonly used information
about an OAuth2 identity provider. This class was added in vSphere API
7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>auth_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Authentication/authorization endpoint of the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>token_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Token endpoint of the provider. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>client_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>authentication_header</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>auth_query_params</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) <p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>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 “&amp;” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. This attribute was added in vSphere API 7.0.0.0.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.Oauth2UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Oauth2UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">public_key_uri</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_secret</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">claim_map</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issuer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">authentication_method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_query_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Oauth2UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Oauth2UpdateSpec</span></code> class contains the information used to
update the OAuth2 identity provider. This class was added in vSphere API
7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>auth_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Authentication/authorization endpoint of the provider. This
attribute was added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>token_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Token endpoint of the provider. This attribute was added in vSphere
API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>public_key_uri</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>client_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>client_secret</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Shared secret between identity provider and client. This attribute
was added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>claim_map</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>issuer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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.</p></li>
<li><p><strong>authentication_method</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod" title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Oauth2AuthenticationMethod</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Authentication method used by the provider. This attribute was
added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>auth_query_params</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 “&amp;” 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.OidcCreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">OidcCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">discovery_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_secret</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">claim_map</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.OidcCreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.OidcCreateSpec</span></code> class contains the information used to
create an OIDC identity provider. This class was added in vSphere API
7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>discovery_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Endpoint to retrieve the provider metadata. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_secret</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The secret shared between the client and the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>claim_map</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.OidcInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">OidcInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">discovery_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logout_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">public_key_uri</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_secret</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">claim_map</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issuer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">authentication_method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_query_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.OidcInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.OidcInfo</span></code> class contains information about an OIDC
identity provider. OIDC is a discovery protocol for OAuth2 configuration
metadata, so <code class="docutils literal notranslate"><span class="pre">Providers.OidcInfo</span></code> contains additional discovered OAuth2
metadata. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>discovery_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Endpoint to retrieve the provider metadata. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>logout_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The endpoint to use for terminating the users 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.</p></li>
<li><p><strong>auth_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Authentication/authorization endpoint of the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>token_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Token endpoint of the provider. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>public_key_uri</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Endpoint to retrieve the provider public key for validation. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_secret</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The secret shared between the client and the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>claim_map</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)) 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.</p></li>
<li><p><strong>issuer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>authentication_method</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod" title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Oauth2AuthenticationMethod</span></code></a>) Authentication method used by the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>auth_query_params</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) <p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>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 “&amp;” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. This attribute was added in vSphere API 7.0.0.0.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.OidcSummary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">OidcSummary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">discovery_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logout_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">authentication_header</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_query_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.OidcSummary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.OidcSummary</span></code> class contains commonly used information
about an OIDC identity provider. OIDC is a discovery protocol for OAuth2
configuration metadata, so <code class="docutils literal notranslate"><span class="pre">Providers.OidcSummary</span></code> contains discovered
OAuth2 metadata. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>discovery_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>logout_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The endpoint to use for terminating the users 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.</p></li>
<li><p><strong>auth_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Authentication/authorization endpoint of the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>token_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Token endpoint of the provider. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>client_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>authentication_header</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>auth_query_params</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) <p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>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 “&amp;” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. This attribute was added in vSphere API 7.0.0.0.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.OidcUpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">OidcUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">discovery_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_secret</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">claim_map</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.OidcUpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.OidcUpdateSpec</span></code> class contains the information used to
update the OIDC identity provider. This class was added in vSphere API
7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>discovery_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Endpoint to retrieve the provider metadata. This attribute was
added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>client_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>client_secret</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The secret shared between the client and the provider. This
attribute was added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>claim_map</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>)) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oauth2</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oidc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_query_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Summary</span></code> class contains commonly used information about an
identity provider. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.identity.Providers</span></code>. When methods return a
value of this class as a return value, the attribute will be an
identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.identity.Providers</span></code>.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>config_tag</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType" title="com.vmware.vcenter.identity_client.Providers.ConfigType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ConfigType</span></code></a>) The config type of the identity provider. This attribute was added
in vSphere API 7.0.0.0.</p></li>
<li><p><strong>oauth2</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2Summary" title="com.vmware.vcenter.identity_client.Providers.Oauth2Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Oauth2Summary</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
<li><p><strong>oidc</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.OidcSummary" title="com.vmware.vcenter.identity_client.Providers.OidcSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.OidcSummary</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
<li><p><strong>is_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Specifies whether the provider is the default provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>domain_names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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 users 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.</p></li>
<li><p><strong>auth_query_params</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) <p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>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 “&amp;” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. 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.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.Providers.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config_tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oauth2</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oidc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">org_ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">make_default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_query_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idm_protocol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idm_endpoints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active_directory_over_ldap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upn_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset_upn_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">groups_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset_groups_claim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.UpdateSpec</span></code> class contains the information used to update
the identity provider. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>config_tag</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType" title="com.vmware.vcenter.identity_client.Providers.ConfigType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ConfigType</span></code></a>) The config type of the identity provider. This attribute was added
in vSphere API 7.0.0.0.</p></li>
<li><p><strong>oauth2</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Oauth2UpdateSpec" title="com.vmware.vcenter.identity_client.Providers.Oauth2UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Oauth2UpdateSpec</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
<li><p><strong>oidc</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.OidcUpdateSpec" title="com.vmware.vcenter.identity_client.Providers.OidcUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.OidcUpdateSpec</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">configTag</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc" title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
<li><p><strong>org_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>make_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specifies whether to make this the default provider. If
<code class="docutils literal notranslate"><span class="pre">makeDefault</span></code> 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
<code class="docutils literal notranslate"><span class="pre">makeDefault</span></code> is set to false, this providers default flag will
not be modified. This attribute was added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>domain_names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 users 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.</p></li>
<li><p><strong>auth_query_params</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 “&amp;” 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.</p></li>
<li><p><strong>idm_protocol</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol" title="com.vmware.vcenter.identity_client.Providers.IdmProtocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.IdmProtocol</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>idm_endpoints</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">idmProtocol</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.REST" title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.REST"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.IdmProtocol.REST</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM" title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.IdmProtocol.SCIM</span></code></a>, or
<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM2_0" title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM2_0"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.IdmProtocol.SCIM2_0</span></code></a>.</p></li>
<li><p><strong>active_directory_over_ldap</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.ActiveDirectoryOverLdap" title="com.vmware.vcenter.identity_client.Providers.ActiveDirectoryOverLdap"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ActiveDirectoryOverLdap</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">idmProtocol</span></code> is <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.LDAP" title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.LDAP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.IdmProtocol.LDAP</span></code></a>.</p></li>
<li><p><strong>upn_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>reset_upn_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Flag indicating whether the user principal name (UPN) claim should
be set back to its default value. If this field is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>,
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
<code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing user principal name (UPN) claim will be
changed to the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.UpdateSpec.upn_claim</span></code>, 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.UpdateSpec.upn_claim</span></code>, if any.</p></li>
<li><p><strong>groups_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>reset_groups_claim</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Flag indicating whether any existing groups claim value should be
removed. If this field is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, 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 <code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing groups claim will be
changed to the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.UpdateSpec.groups_claim</span></code>, 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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.UpdateSpec.groups_claim</span></code>, if any.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.identity_client.Providers.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.create" title="Permalink to this definition"></a></dt>
<dd><p>Create a vCenter Server identity provider. This method was added in
vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.CreateSpec" title="com.vmware.vcenter.identity_client.Providers.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.CreateSpec</span></code></a>) the CreateSpec contains the information used to create the provider</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The identifier of the created identity provider.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.identity.Providers</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if authorization is not given to caller.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if invalid arguments are provided in createSpec.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if provider exists for provider ID in given spec.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIdentityProviders.Create</span></code> and
<code class="docutils literal notranslate"><span class="pre">VcIdentityProviders.Manage</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.identity_client.Providers.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete a vCenter Server identity provider. This method was added in
vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) the identifier of the provider to delete
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.identity.Providers</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if authorization is not given to caller.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if no provider found with the given provider identifier.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIdentityProviders.Manage</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.identity_client.Providers.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve detailed information of the specified identity provider. This
method was added in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) the identifier of the provider
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.identity.Providers</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Info" title="com.vmware.vcenter.identity_client.Providers.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Detailed information of the specified identity provider.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if authorization is not given to caller.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if no provider found with the given provider identifier.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIdentityProviders.Read</span></code> and
<code class="docutils literal notranslate"><span class="pre">VcIdentityProviders.Manage</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.identity_client.Providers.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.list" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve all identity providers. This method was added in vSphere API
7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.list" title="com.vmware.vcenter.identity_client.Providers.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.Summary" title="com.vmware.vcenter.identity_client.Providers.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Summary</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Commonly used information about the identity providers.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if authorization is not given to caller.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIdentityProviders.Read</span></code> and
<code class="docutils literal notranslate"><span class="pre">VcIdentityProviders.Manage</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.identity_client.Providers.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.Providers.update" title="Permalink to this definition"></a></dt>
<dd><p>Update a vCenter Server identity provider. This method was added in
vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) the identifier of the provider to update
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.identity.Providers</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.identity_client.Providers.UpdateSpec" title="com.vmware.vcenter.identity_client.Providers.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.UpdateSpec</span></code></a>) the UpdateSpec contains the information used to update the provider</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if authorization is not given to caller.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if invalid arguments are provided in updateSpec.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if no provider found with the given provider identifier.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIdentityProviders.Manage</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.identity_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.identity_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.identity_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.inventory_client">
<span id="com-vmware-vcenter-inventory-client-module"></span><h2>com.vmware.vcenter.inventory_client module<a class="headerlink" href="#module-com.vmware.vcenter.inventory_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.inventory_client</span></code> component provides methods and
classes for retrieving vCenter datastore and network information for a given
<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of identifiers.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.inventory_client.Datastore">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.inventory_client.</span></code><code class="sig-name descname"><span class="pre">Datastore</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Datastore" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> class provides methods to retrieve information about
datastores.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.inventory_client.Datastore.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Datastore.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Datastore.Info</span></code> class contains information about a datastore.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Type of the datastore.
When clients pass a value of this class as a parameter, the
attribute must be one of <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> or <code class="docutils literal notranslate"><span class="pre">StoragePod</span></code>. When
methods return a value of this class as a return value, the
attribute will be one of <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> or <code class="docutils literal notranslate"><span class="pre">StoragePod</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.inventory_client.Datastore.find">
<code class="sig-name descname"><span class="pre">find</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datastores</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Datastore.find" title="Permalink to this definition"></a></dt>
<dd><p>Returns datastore information for the specified datastores. The key in
the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the datastore identifier and the
value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the datastore information.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>datastores</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifiers of the datastores for which information will be
returned.
The parameter must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<a class="reference internal" href="#com.vmware.vcenter.inventory_client.Datastore.Info" title="com.vmware.vcenter.inventory_client.Datastore.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Datastore.Info</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>)</p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Datastore information for the specified datastores. The key in the
return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the datastore identifier and the
value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the datastore information.
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if no datastore can be found for one or more of the datastore
identifiers in <code class="docutils literal notranslate"><span class="pre">datastores</span></code></p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">datastores</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.inventory_client.Network">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.inventory_client.</span></code><code class="sig-name descname"><span class="pre">Network</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Network" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Network</span></code> class provides methods to retrieve information about
vCenter Server networks.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.inventory_client.Network.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Network.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Network.Info</span></code> class contains information about a vCenter Server
network.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Type of the vCenter Server network.
When clients pass a value of this class as a parameter, the
attribute must be one of <code class="docutils literal notranslate"><span class="pre">Network</span></code>,
<code class="docutils literal notranslate"><span class="pre">DistributedVirtualPortgroup</span></code>, or <code class="docutils literal notranslate"><span class="pre">OpaqueNetwork</span></code>. When methods
return a value of this class as a return value, the attribute will
be one of <code class="docutils literal notranslate"><span class="pre">Network</span></code>, <code class="docutils literal notranslate"><span class="pre">DistributedVirtualPortgroup</span></code>, or
<code class="docutils literal notranslate"><span class="pre">OpaqueNetwork</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.inventory_client.Network.find">
<code class="sig-name descname"><span class="pre">find</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">networks</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.inventory_client.Network.find" title="Permalink to this definition"></a></dt>
<dd><p>Returns network information for the specified vCenter Server networks.
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the network identifier and
the value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the network information.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>networks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifiers of the vCenter Server networks for which information
will be returned.
The parameter must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">Network</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and (<a class="reference internal" href="#com.vmware.vcenter.inventory_client.Network.Info" title="com.vmware.vcenter.inventory_client.Network.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Network.Info</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>)</p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Network information for the specified vCenter Server networks. The
key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the network identifier and
the value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the network information.
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if no datastore can be found for one or more of the vCenter Server
network identifiers in <code class="docutils literal notranslate"><span class="pre">networks</span></code></p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Network</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">networks</span></code>
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.inventory_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.inventory_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.inventory_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.iso_client">
<span id="com-vmware-vcenter-iso-client-module"></span><h2>com.vmware.vcenter.iso_client module<a class="headerlink" href="#module-com.vmware.vcenter.iso_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.iso_client</span></code> module provides classes and classes that
will let its client mount or unmount an ISO image on a virtual machine as a
CD-ROM.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.iso_client.Image">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.iso_client.</span></code><code class="sig-name descname"><span class="pre">Image</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.iso_client.Image" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>Provides an interface to mount and unmount an ISO image on a virtual
machine.</p>
<p>This is an API that will let its client mount or unmount an ISO image on a
virtual machine as a CD-ROM.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py method">
<dt id="com.vmware.vcenter.iso_client.Image.mount">
<code class="sig-name descname"><span class="pre">mount</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">library_item</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.iso_client.Image.mount" title="Permalink to this definition"></a></dt>
<dd><p>Mounts an ISO image from a content library on a virtual machine.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The identifier of the virtual machine where the specified ISO image
will be mounted.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If either <code class="docutils literal notranslate"><span class="pre">vm</span></code> or the <code class="docutils literal notranslate"><span class="pre">library_item</span></code> is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If no .iso file is present on the library item.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
When the operation is not allowed on the virtual machine in its
current state.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.Config.AddRemoveDevice</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">library_item</span></code> requires
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.DownloadSession</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.iso_client.Image.unmount">
<code class="sig-name descname"><span class="pre">unmount</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cdrom</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.iso_client.Image.unmount" title="Permalink to this definition"></a></dt>
<dd><p>Unmounts a previously mounted CD-ROM using an ISO image as a backing.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The identifier of the virtual machine from which to unmount the
virtual CD-ROM.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
<li><p><strong>cdrom</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The device identifier of the CD-ROM.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If the virtual machine identified by <code class="docutils literal notranslate"><span class="pre">vm</span></code> is not found or the
<code class="docutils literal notranslate"><span class="pre">cdrom</span></code> does not identify a virtual CD-ROM in the virtual
machine.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
When the operation is not allowed on the virtual machine in its
current state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.Config.AddRemoveDevice</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Cdrom</span></code> referenced
by the parameter <code class="docutils literal notranslate"><span class="pre">cdrom</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.iso_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.iso_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.iso_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.lcm_client">
<span id="com-vmware-vcenter-lcm-client-module"></span><h2>com.vmware.vcenter.lcm_client module<a class="headerlink" href="#module-com.vmware.vcenter.lcm_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm_client</span></code> module provides classes for managing the
vCenter Server lifecycle. Copyright 2021 VMware, Inc. All rights reserved.
VMware Confidential</p>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm_client.Notification">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm_client.</span></code><code class="sig-name descname"><span class="pre">Notification</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resolution</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm_client.Notification" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Notification</span></code> class describes a notification that can be reported by
the appliance task, which can be of type info, warning or errors.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The notification id.</p></li>
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The time the notification was raised/found.
Only if the time information is available.</p></li>
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) The notification message.</p></li>
<li><p><strong>resolution</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The resolution message, if any.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> for warnings and errors.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm_client.Notifications">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm_client.</span></code><code class="sig-name descname"><span class="pre">Notifications</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">warnings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm_client.Notifications" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Notifications</span></code> class contains info/warning/error messages that can
be reported be the appliance task.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.lcm_client.Notification" title="com.vmware.vcenter.lcm_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Info notification messages reported.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an info was reported by the appliance task.</p></li>
<li><p><strong>warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.lcm_client.Notification" title="com.vmware.vcenter.lcm_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Warning notification messages reported.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an warning was reported by the appliance task.</p></li>
<li><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.lcm_client.Notification" title="com.vmware.vcenter.lcm_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Error notification messages reported.
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an error was reported by the appliance task.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm_client.Reports">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm_client.</span></code><code class="sig-name descname"><span class="pre">Reports</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm_client.Reports" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Report</span></code> class provides an method to download the report generated by
the interop and precheck operations. To download a report, you must use the
<code class="docutils literal notranslate"><span class="pre">get</span></code> method. A <code class="docutils literal notranslate"><span class="pre">Report.Location</span></code> class represents the location of the
file which has <code class="docutils literal notranslate"><span class="pre">Report.Token</span></code> class which represents the token ID
(\&#64;name String) and the expiration time of the token
<code class="docutils literal notranslate"><span class="pre">Report.Token.expiry</span></code> DateTime. <code class="docutils literal notranslate"><span class="pre">Report.Location</span></code> class also has the
URI for the file which needs to be downloaded.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm_client.Reports.Location">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Location</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uri</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">download_file_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm_client.Reports.Location" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Reports.Location</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>uri</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Report Download URI.</p></li>
<li><p><strong>download_file_token</strong> (<a class="reference internal" href="#com.vmware.vcenter.lcm_client.Reports.Token" title="com.vmware.vcenter.lcm_client.Reports.Token"><code class="xref py py-class docutils literal notranslate"><span class="pre">Reports.Token</span></code></a>) Information about the token required in the HTTP GET request to
retrieve the report</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm_client.Reports.Token">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Token</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expiry</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm_client.Reports.Token" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Reports.Token</span></code> class contains information about the token required
in the HTTP GET request to generate the report.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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”.</p></li>
<li><p><strong>expiry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) Expiry time of the token</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.lcm_client.Reports.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">report</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm_client.Reports.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the location <a class="reference internal" href="#com.vmware.vcenter.lcm_client.Reports.Location" title="com.vmware.vcenter.lcm_client.Reports.Location"><code class="xref py py-class docutils literal notranslate"><span class="pre">Reports.Location</span></code></a> information for
downloading the report for the specified file name.</p>
<blockquote>
<div><p>Retrieving a report involves two steps:</p>
</div></blockquote>
<ul class="simple">
<li><p>Step 1: Invoke the <a class="reference internal" href="#com.vmware.vcenter.lcm_client.Reports.get" title="com.vmware.vcenter.lcm_client.Reports.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Reports.get()</span></code></a> method to provision a token
and a URI.</p></li>
<li><p>Step 2: Make an HTTP GET request by using the URI and the token
returned in step 1 to retrieve the report.</p></li>
</ul>
<blockquote>
<div><p>The HTTP GET request will:</p>
</div></blockquote>
<ul class="simple">
<li><p>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)</p></li>
<li><p>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.</p></li>
</ul>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>report</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.lcm.report</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.lcm_client.Reports.Location" title="com.vmware.vcenter.lcm_client.Reports.Location"><code class="xref py py-class docutils literal notranslate"><span class="pre">Reports.Location</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no file associated with <code class="docutils literal notranslate"><span class="pre">report</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is some unknown internal error. The accompanying error
message will give more details about the failure.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.lcm_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.lcm_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.lcm_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.namespace_management_client">
<span id="com-vmware-vcenter-namespace-management-client-module"></span><h2>com.vmware.vcenter.namespace_management_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management_client</span></code> module provides classes
for managing Namespaces.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.CNSFileConfig">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">CNSFileConfig</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vsan_clusters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.CNSFileConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CNSFileConfig</span></code> class contains the specification required to set the
configuration for Cloud Native Storage file volume support on Supervisor.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>vsan_clusters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) <p><code class="xref py py-attr docutils literal notranslate"><span class="pre">CNSFileConfig.vsan_clusters</span></code> is a list of clusters to be
used for provisioning file volumes.</p>
<p>As a prerequisite these clusters must have vSAN and vSAN file
services enabled, and must be in the same vCenter as the
Supervisor.</p>
<p>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.</p>
<p>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 <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.enable" title="com.vmware.vcenter.namespace_management_client.Clusters.enable"><code class="xref py py-func docutils literal notranslate"><span class="pre">Clusters.enable()</span></code></a>, <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.update" title="com.vmware.vcenter.namespace_management_client.Clusters.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Clusters.update()</span></code></a> and
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.set" title="com.vmware.vcenter.namespace_management_client.Clusters.set"><code class="xref py py-func docutils literal notranslate"><span class="pre">Clusters.set()</span></code></a> APIs.</p>
<p>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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.ClusterAvailableVersions">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">ClusterAvailableVersions</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ClusterAvailableVersions" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The {\&#64;name cluster-available-versions} class provides methods to
retrieve available upgrade versions of WCP and detailed information about
each upgrade.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.ClusterAvailableVersions.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_notes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ClusterAvailableVersions.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterAvailableVersions.Summary</span></code> class contains the information
about each available upgrade version.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Version of the upgrade.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the upgrade.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Description of the upgrade.</p></li>
<li><p><strong>release_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) Release date of the upgrade.</p></li>
<li><p><strong>release_notes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Release details of the upgrade.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.ClusterAvailableVersions.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ClusterAvailableVersions.list" title="Permalink to this definition"></a></dt>
<dd><p>Get information about each available upgrade.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ClusterAvailableVersions.list" title="com.vmware.vcenter.namespace_management_client.ClusterAvailableVersions.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ClusterAvailableVersions.Summary" title="com.vmware.vcenter.namespace_management_client.ClusterAvailableVersions.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterAvailableVersions.Summary</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Information for each upgrade.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.ClusterCompatibility">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">ClusterCompatibility</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterCompatibility</span></code> class provides methods to get
Namespace-related compatibility information for clusters in this vCenter.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compatible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterCompatibility.FilterSpec</span></code> class contains attributes used to
filter the results when listing clusters (see
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.list" title="com.vmware.vcenter.namespace_management_client.ClusterCompatibility.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">ClusterCompatibility.list()</span></code></a>) and their compatibility information.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>compatible</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>network_provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NetworkProvider</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.ClusterCompatibility.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compatible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">incompatibility_reasons</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterCompatibility.Summary</span></code> class contains the information about
the compatibility of a vSphere cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>compatible</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Compatibility of this vSphere cluster. If false, the list of
incompatibility issues will be given in the
<code class="docutils literal notranslate"><span class="pre">incompatibilityReasons</span></code> field.</p></li>
<li><p><strong>incompatibility_reasons</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) Reasons for incompatibility.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.ClusterCompatibility.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns Namespaces compatibility information for all vSphere clusters
in the vCenter Server matching the
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec" title="com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterCompatibility.FilterSpec</span></code></a>. The result contains only
visible (subject to permission checks) clusters.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec" title="com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterCompatibility.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specification of matching clusters for which information should be
returned.
If None, the behavior is equivalent to a
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec" title="com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterCompatibility.FilterSpec</span></code></a> with all attributes None
which means all NSX-T clusters the user is authorized to view will
be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.list" title="com.vmware.vcenter.namespace_management_client.ClusterCompatibility.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.Summary" title="com.vmware.vcenter.namespace_management_client.ClusterCompatibility.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterCompatibility.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Namespaces compatibility information for the clusters matching the
the <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec" title="com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterCompatibility.FilterSpec</span></code></a>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">filter</span></code> contains any error.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege on the vSphere
clusters.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.ClusterSizeInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">ClusterSizeInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The {\&#64;name cluster-size-info} class provides methods to retrieve
various sizes available for enabling Namespaces and information about each
size.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_supported_pods</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_supported_services</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_service_cidr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_pod_cidr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_vm_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">worker_vm_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterSizeInfo.Info</span></code> class contains the information about limits
associated with a <code class="docutils literal notranslate"><span class="pre">SizingHint</span></code>.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>num_supported_pods</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The maximum number of supported pods.</p></li>
<li><p><strong>num_supported_services</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The maximum number of supported services.</p></li>
<li><p><strong>default_service_cidr</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a>) Default CIDR range from which Kubernetes allocates service cluster
IP addresses.</p></li>
<li><p><strong>default_pod_cidr</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a>) Default CIDR range from which Kubernetes allocates pod IP
addresses.</p></li>
<li><p><strong>master_vm_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.VmInfo" title="com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.VmInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterSizeInfo.VmInfo</span></code></a>) Information about Kubernetes API server virtual machine
configuration.</p></li>
<li><p><strong>worker_vm_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.VmInfo" title="com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.VmInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterSizeInfo.VmInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Information about worker virtual machine configuration.
If None, the configuration of the worker VM is not fixed.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.VmInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VmInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cores_per_socket</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.VmInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterSizeInfo.VmInfo</span></code> class contains the information about the
configuration of the virtual machines which would be created for
Namespaces.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Number of CPU cores.</p></li>
<li><p><strong>cores_per_socket</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Number of CPU cores per socket.</p></li>
<li><p><strong>memory</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Memory size, in mebibytes.</p></li>
<li><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Overall capacity of the disks in the virtual machine, in mebibytes.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.get" title="Permalink to this definition"></a></dt>
<dd><p>Get information about the default values associated with various sizes.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SizingHint" title="com.vmware.vcenter.namespace_management_client.SizingHint"><code class="xref py py-class docutils literal notranslate"><span class="pre">SizingHint</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.Info" title="com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterSizeInfo.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Information for each size.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">Clusters</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters</span></code> class provides methods to enable and disable vSphere
Namespaces on a vSphere cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ConfigStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.ConfigStatus</span></code> class describes the status of reaching the
desired state configuration for the cluster.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus.CONFIGURING">
<code class="sig-name descname"><span class="pre">CONFIGURING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='CONFIGURING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus.CONFIGURING" title="Permalink to this definition"></a></dt>
<dd><p>The Namespace configuration is being applied to the cluster.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Failed to apply the Namespace configuration to the cluster, user
intervention needed.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus.REMOVING">
<code class="sig-name descname"><span class="pre">REMOVING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='REMOVING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus.REMOVING" title="Permalink to this definition"></a></dt>
<dd><p>The Namespace configuration is being removed from the cluster.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus.RUNNING">
<code class="sig-name descname"><span class="pre">RUNNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='RUNNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus.RUNNING" title="Permalink to this definition"></a></dt>
<dd><p>The cluster is configured correctly with the Namespace configuration.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.EnableSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">EnableSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size_hint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service_cidr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncp_cluster_network_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">workload_networks_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">workload_ntp_servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">load_balancer_config_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_management_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_dns</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">worker_dns</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_dns_search_domains</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_ntp_servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_storage_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ephemeral_storage_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cns_file_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">login_banner</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_dns_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_image_registry</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</sp
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.EnableSpec</span></code> class contains the specification required to
enable vSphere Namespaces on a cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>size_hint</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SizingHint" title="com.vmware.vcenter.namespace_management_client.SizingHint"><code class="xref py py-class docutils literal notranslate"><span class="pre">SizingHint</span></code></a>) This affects the size and resources allocated to the Kubernetes API
server. It also affects the suggested default serviceCidr and
podCidrs.</p></li>
<li><p><strong>service_cidr</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a>) CIDR block from which Kubernetes allocates service cluster IP
addresses. This range should not overlap with those in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkEnableSpec.pod_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkEnableSpec.ingress_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkEnableSpec.egress_cidrs</span></code>, or other
services running in the datacenter.</p></li>
<li><p><strong>network_provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NetworkProvider</span></code></a>) The provider of cluster networking for this vSphere Namespaces
cluster.</p></li>
<li><p><strong>ncp_cluster_network_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkEnableSpec" title="com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkEnableSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkEnableSpec</span></code></a>) Specification for the NSX Container Plugin cluster network.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN</span></code></a>.</p></li>
<li><p><strong>workload_networks_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.WorkloadNetworksEnableSpec" title="com.vmware.vcenter.namespace_management_client.Clusters.WorkloadNetworksEnableSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.WorkloadNetworksEnableSpec</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.VSPHERE_NETWORK</span></code></a>.</p></li>
<li><p><strong>workload_ntp_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>load_balancer_config_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.ConfigSpec" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.ConfigSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.ConfigSpec</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.VSPHERE_NETWORK</span></code></a>.</p></li>
<li><p><strong>master_management_network</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NetworkSpec</span></code></a>) Specification for the management network on Kubernetes API server.
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkSpec.mode</span></code> must be STATICRANGE as we require
Kubernetes API server to have a stable address.</p></li>
<li><p><strong>master_dns</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>worker_dns</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>master_dns_search_domains</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>master_ntp_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>master_storage_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>.</p></li>
<li><p><strong>ephemeral_storage_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>.</p></li>
<li><p><strong>cns_file_config</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.CNSFileConfig" title="com.vmware.vcenter.namespace_management_client.CNSFileConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">CNSFileConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>login_banner</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Disclaimer to be displayed prior to login via the Kubectl plugin.
If None, just skip it.</p></li>
<li><p><strong>master_dns_names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>image_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec" title="com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.ImageStorageSpec</span></code></a>) Specification for storage to be used for container images.</p></li>
<li><p><strong>default_image_registry</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry" title="com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.ImageRegistry</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>default_image_repository</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>default_kubernetes_service_content_library</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Identifier of the Content Library which holds the VM Images for
vSphere Kubernetes Service. This Content Library should be
subscribed to VMwares 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.
If None, the Content Library will be automatically generated and
configured to the cluster.</p></li>
<li><p><strong>cluster_proxy_config</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ProxyConfiguration" title="com.vmware.vcenter.namespace_management_client.ProxyConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProxyConfiguration</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ImageRegistry</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.ImageRegistry</span></code> class contains the specification required to
configure container image registry endpoint.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) IP address or the hostname of container image registry.</p></li>
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Port number of the container image registry.
If None, defaults to 443.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ImageStorageSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">storage_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.ImageStorageSpec</span></code> class contains the specification required
to configure storage used for container images.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>storage_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size_hint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stat_summary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kubernetes_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kubernetes_status_messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_server_management_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_server_cluster_endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_management_endpoint_certificate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_endpoint_certificate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncp_cluster_network_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">workload_networks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">workload_ntp_servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">load_balancers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service_cidr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_management_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_dns</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">Non
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Info</span></code> class contains detailed information about the cluster
statistics and status related to vSphere Namespaces.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>size_hint</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SizingHint" title="com.vmware.vcenter.namespace_management_client.SizingHint"><code class="xref py py-class docutils literal notranslate"><span class="pre">SizingHint</span></code></a>) Current setting for <code class="docutils literal notranslate"><span class="pre">SizingHint</span></code>. 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.</p></li>
<li><p><strong>stat_summary</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.Stats" title="com.vmware.vcenter.namespace_management_client.Clusters.Stats"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Stats</span></code></a>) Basic runtime statistics for the cluster.</p></li>
<li><p><strong>config_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus" title="com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.ConfigStatus</span></code></a>) Current setting for <code class="docutils literal notranslate"><span class="pre">Clusters.ConfigStatus</span></code>.</p></li>
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.Message" title="com.vmware.vcenter.namespace_management_client.Clusters.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Message</span></code></a>) Current set of messages associated with the object.</p></li>
<li><p><strong>kubernetes_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus" title="com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.KubernetesStatus</span></code></a>) Current setting for <code class="docutils literal notranslate"><span class="pre">Clusters.KubernetesStatus</span></code>.</p></li>
<li><p><strong>kubernetes_status_messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.Message" title="com.vmware.vcenter.namespace_management_client.Clusters.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Message</span></code></a>) Current set of messages associated with the object.</p></li>
<li><p><strong>api_server_management_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>api_server_cluster_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>api_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the Kubernetes API servers. These are the IP
addresses of the VM instances for the Kubernetes control plane on
the management network.</p></li>
<li><p><strong>tls_management_endpoint_certificate</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> only when
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.Info.api_server_management_endpoint</span></code> is used.</p></li>
<li><p><strong>tls_endpoint_certificate</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) PEM-encoded x509 certificate used by TLS endpoint on Kubernetes API
servers when accessed via the load balancer, e.g. devops user on
corporate network.
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> only when
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.Info.api_server_management_endpoint</span></code> is used.</p></li>
<li><p><strong>network_provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NetworkProvider</span></code></a>) The provider of cluster networking for this vSphere Namespaces
cluster.</p></li>
<li><p><strong>ncp_cluster_network_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkInfo" title="com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkInfo</span></code></a>) Specification for the NSX Container Plugin cluster network.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN</span></code></a>.</p></li>
<li><p><strong>workload_networks</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.WorkloadNetworksInfo" title="com.vmware.vcenter.namespace_management_client.Clusters.WorkloadNetworksInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.WorkloadNetworksInfo</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.VSPHERE_NETWORK</span></code></a>.</p></li>
<li><p><strong>workload_ntp_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>load_balancers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Info" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.Info</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.VSPHERE_NETWORK</span></code></a>.</p></li>
<li><p><strong>service_cidr</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a>) CIDR block from which Kubernetes allocates service cluster IP
addresses.</p></li>
<li><p><strong>master_management_network</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NetworkSpec</span></code></a>) 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.</p></li>
<li><p><strong>master_dns</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>worker_dns</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>master_storage_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>ephemeral_storage_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>cns_file_config</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.CNSFileConfig" title="com.vmware.vcenter.namespace_management_client.CNSFileConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">CNSFileConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>login_banner</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>master_dns_names</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>image_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec" title="com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.ImageStorageSpec</span></code></a>) 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.</p></li>
<li><p><strong>default_image_registry</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry" title="com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.ImageRegistry</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>default_image_repository</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>master_dns_search_domains</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>master_ntp_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>default_kubernetes_service_content_library</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Identifier of the Content Library which holds the VM Images for
vSphere Kubernetes Service. This Content Library should be
subscribed to VMwares 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.
If None, a default subscribed Content Library will be created. It
will sync VMware-supplied images for Tanzu Kubernetes Grid over the
internet.</p></li>
<li><p><strong>cluster_proxy_config</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ProxyConfiguration" title="com.vmware.vcenter.namespace_management_client.ProxyConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProxyConfiguration</span></code></a>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.Ipv4Range">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Ipv4Range</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">starting_address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subnet_mask</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.Ipv4Range" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Ipv4Range</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>starting_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The IPv4 address denoting the start of the range.</p></li>
<li><p><strong>address_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The number of IP addresses in the range. Addresses are derived by
incrementing <code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.Ipv4Range.starting_address</span></code>.</p></li>
<li><p><strong>subnet_mask</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Subnet mask to be set.</p></li>
<li><p><strong>gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The IPv4 address of the gateway associated with the range indicated
by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.Ipv4Range.starting_address</span></code> and
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.Ipv4Range.address_count</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">KubernetesStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.KubernetesStatus</span></code> class describes the clusters ability to
deploy pods.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">KubernetesStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">KubernetesStatus(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>The cluster may not be able to accept pods and has error messages.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus.READY">
<code class="sig-name descname"><span class="pre">READY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">KubernetesStatus(string='READY')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus.READY" title="Permalink to this definition"></a></dt>
<dd><p>The cluster is able to accept pods.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus.WARNING">
<code class="sig-name descname"><span class="pre">WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">KubernetesStatus(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus.WARNING" title="Permalink to this definition"></a></dt>
<dd><p>The cluster may be able to accept pods, but has warning messages.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.Message">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Message</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">severity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.Message" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Message</span></code> class contains the information about the object
configuration.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>severity</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity" title="com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Message.Severity</span></code></a>) Type of the message.</p></li>
<li><p><strong>details</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Details about the message.
If None, message details are not required for taking actions.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Severity</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Message.Severity</span></code> class represents the severity of the
message.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Severity</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Severity(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Error message. This is accompanied by vCenter event and/or alarm.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity.INFO">
<code class="sig-name descname"><span class="pre">INFO</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Severity(string='INFO')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity.INFO" title="Permalink to this definition"></a></dt>
<dd><p>Informational message. This may be accompanied by vCenter event.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity.WARNING">
<code class="sig-name descname"><span class="pre">WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Severity(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity.WARNING" title="Permalink to this definition"></a></dt>
<dd><p>Warning message. This may be accompanied by vCenter event.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkEnableSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NCPClusterNetworkEnableSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pod_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ingress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">egress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster_distributed_switch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsx_edge_cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsx_tier0_gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespace_subnet_prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">routed_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkEnableSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkEnableSpec</span></code> class encapsulates the NSX
Container Plugin-specific cluster networking configuration parameters for
the vSphere Namespaces Cluster Enable operation.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>pod_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a>) CIDR blocks from which Kubernetes allocates pod IP addresses. This
range should not overlap with those in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.EnableSpec.service_cidr</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkEnableSpec.ingress_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkEnableSpec.egress_cidrs</span></code>, or other
services running in the datacenter. All Pod CIDR blocks must be of
at least subnet size /23.</p></li>
<li><p><strong>ingress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkEnableSpec.pod_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.EnableSpec.service_cidr</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkEnableSpec.egress_cidrs</span></code>, or other
services running in the datacenter.</p></li>
<li><p><strong>egress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkEnableSpec.pod_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.EnableSpec.service_cidr</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkEnableSpec.ingress_cidrs</span></code>, or
other services running in the datacenter.</p></li>
<li><p><strong>cluster_distributed_switch</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">vSphereDistributedSwitch</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">vSphereDistributedSwitch</span></code>.
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.</p></li>
<li><p><strong>nsx_edge_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">NSXEdgeCluster</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">NSXEdgeCluster</span></code>.
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.</p></li>
<li><p><strong>nsx_tier0_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">NSXTier0Gateway</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">NSXTier0Gateway</span></code>.
This field is required when configuring a cluster that uses NSX-T.</p></li>
<li><p><strong>namespace_subnet_prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Size of the subnet reserved for namespaces segments. This attribute
was added in vSphere API 7.0.2.0.
If None, defaults to 28.</p></li>
<li><p><strong>routed_mode</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Routed mode for this cluster. When set to True, the traffic in the
cluster is not NATed. When this field is set to True,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkEnableSpec.egress_cidrs</span></code> is not
allowed. This attribute was added in vSphere API 7.0.2.0.
If None, defaults to False.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NCPClusterNetworkInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pod_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ingress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">egress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster_distributed_switch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsx_edge_cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_ingress_tls_certificate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsx_tier0_gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespace_subnet_prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">routed_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkInfo</span></code> class contains the NSX Container
Plugin-specific cluster networking configuration.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>pod_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a>) CIDR blocks from which Kubernetes allocates pod IP addresses.</p></li>
<li><p><strong>ingress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a>) CIDR blocks from which NSX assigns IP addresses for Kubernetes
Ingresses and Kubernetes Services of type LoadBalancer.</p></li>
<li><p><strong>egress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a>) CIDR blocks from which NSX assigns IP addresses used for performing
SNAT from container IPs to external IPs.</p></li>
<li><p><strong>cluster_distributed_switch</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">vSphereDistributedSwitch</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">vSphereDistributedSwitch</span></code>.</p></li>
<li><p><strong>nsx_edge_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">NSXEdgeCluster</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">NSXEdgeCluster</span></code>.</p></li>
<li><p><strong>default_ingress_tls_certificate</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) PEM-encoded x509 certificate used by NSX as a default fallback
certificate for Kubernetes Ingress services.</p></li>
<li><p><strong>nsx_tier0_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">NSXTier0Gateway</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">NSXTier0Gateway</span></code>.
This is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> when the cluster uses NSX-T.</p></li>
<li><p><strong>namespace_subnet_prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Size of the subnet reserved for namespaces segments. This attribute
was added in vSphere API 7.0.2.0.
If None, defaults to 28.</p></li>
<li><p><strong>routed_mode</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Routed mode for this cluster. This attribute was added in vSphere
API 7.0.2.0.
If None, defaults to False.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkSetSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NCPClusterNetworkSetSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pod_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ingress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">egress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_ingress_tls_certificate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkSetSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkSetSpec</span></code> class encapsulates the NSX
Container Plugin-specific cluster networking configuration parameters for
the vSphere Namespaces Cluster Set operation.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>pod_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a>) CIDR blocks from which Kubernetes allocates pod IP addresses. This
range should not overlap with those in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.EnableSpec.service_cidr</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkSetSpec.ingress_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkSetSpec.egress_cidrs</span></code>, 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.</p></li>
<li><p><strong>ingress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkSetSpec.pod_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.EnableSpec.service_cidr</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkSetSpec.egress_cidrs</span></code>, or other
services running in the datacenter. A set operation only allows for
addition of new CIDR blocks to the existing list.</p></li>
<li><p><strong>egress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkSetSpec.pod_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.EnableSpec.service_cidr</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkSetSpec.ingress_cidrs</span></code>, or other
services running in the datacenter. A set operation only allows for
addition of new CIDR blocks to the existing list.</p></li>
<li><p><strong>default_ingress_tls_certificate</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) PEM-encoded x509 certificate used by NSX as a default fallback
certificate for Kubernetes Ingress services.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkUpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NCPClusterNetworkUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pod_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ingress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">egress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_ingress_tls_certificate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkUpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkUpdateSpec</span></code> class encapsulates the NSX
Container Plugin-specific cluster networking configuration parameters for
the vSphere Namespaces Cluster Update operation.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>pod_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) CIDR blocks from which Kubernetes allocates pod IP addresses. This
range should not overlap with those in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.EnableSpec.service_cidr</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkUpdateSpec.ingress_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkUpdateSpec.egress_cidrs</span></code>, 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.</p></li>
<li><p><strong>ingress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkUpdateSpec.pod_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.EnableSpec.service_cidr</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkUpdateSpec.egress_cidrs</span></code>, 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.</p></li>
<li><p><strong>egress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkUpdateSpec.pod_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.EnableSpec.service_cidr</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkUpdateSpec.ingress_cidrs</span></code>, 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.</p></li>
<li><p><strong>default_ingress_tls_certificate</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NetworkProvider</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>Identifies the network plugin that cluster networking functionalities for
this vSphere Namespaces Cluster.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkProvider</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN">
<code class="sig-name descname"><span class="pre">NSXT_CONTAINER_PLUGIN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetworkProvider(string='NSXT_CONTAINER_PLUGIN')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="Permalink to this definition"></a></dt>
<dd><p>NSX-T Container Plugin.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK">
<code class="sig-name descname"><span class="pre">VSPHERE_NETWORK</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetworkProvider(string='VSPHERE_NETWORK')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK" title="Permalink to this definition"></a></dt>
<dd><p>vSphere Networking. This class attribute was added in vSphere API 7.0.1.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NetworkSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">floating_ip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address_range</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.NetworkSpec</span></code> contains information related to network
configuration for one or more interfaces.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>floating_ip</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.</p></li>
<li><p><strong>mode</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NetworkSpec.Ipv4Mode</span></code></a>) The address assignment mode.</p></li>
<li><p><strong>address_range</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.Ipv4Range" title="com.vmware.vcenter.namespace_management_client.Clusters.Ipv4Range"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Ipv4Range</span></code></a>) Settings for the interfaces on the network.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">mode</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode.STATICRANGE" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode.STATICRANGE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkSpec.Ipv4Mode.STATICRANGE</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Ipv4Mode</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.NetworkSpec.Ipv4Mode</span></code> class defines various IPv4 address
assignment modes.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Mode</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode.DHCP">
<code class="sig-name descname"><span class="pre">DHCP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Ipv4Mode(string='DHCP')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode.DHCP" title="Permalink to this definition"></a></dt>
<dd><p>The address is automatically assigned by a DHCP server.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode.STATICRANGE">
<code class="sig-name descname"><span class="pre">STATICRANGE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Ipv4Mode(string='STATICRANGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode.STATICRANGE" title="Permalink to this definition"></a></dt>
<dd><p>The address is static.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.SetSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">SetSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size_hint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">floating_ip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncp_cluster_network_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_dns</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">worker_dns</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_dns_search_domains</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_ntp_servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_storage_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ephemeral_storage_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cns_file_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">login_banner</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_image_registry</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_image_repository</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_kubernetes_service_content_library</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">workload_ntp_servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster_proxy_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.SetSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.SetSpec</span></code> class contains the specification required to set a
new configuration on the Cluster. This class is applied in entirety,
replacing the current specification fully.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>size_hint</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SizingHint" title="com.vmware.vcenter.namespace_management_client.SizingHint"><code class="xref py py-class docutils literal notranslate"><span class="pre">SizingHint</span></code></a>) This affects the size and resources allocated to the Kubernetes API
server.</p></li>
<li><p><strong>floating_ip</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.EnableSpec.master_management_network</span></code>. 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.</p></li>
<li><p><strong>network_provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NetworkProvider</span></code></a>) The provider of cluster networking for this vSphere Namespaces
cluster.</p></li>
<li><p><strong>ncp_cluster_network_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkSetSpec" title="com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkSetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkSetSpec</span></code></a>) Specification for the NSX Container Plugin cluster network.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN</span></code></a>.</p></li>
<li><p><strong>master_dns</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>worker_dns</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>master_dns_search_domains</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>master_ntp_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>master_storage_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>.</p></li>
<li><p><strong>ephemeral_storage_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>.</p></li>
<li><p><strong>cns_file_config</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.CNSFileConfig" title="com.vmware.vcenter.namespace_management_client.CNSFileConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">CNSFileConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>login_banner</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>image_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec" title="com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.ImageStorageSpec</span></code></a>) Specification for storage to be used for container images.</p></li>
<li><p><strong>default_image_registry</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry" title="com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.ImageRegistry</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>default_image_repository</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>default_kubernetes_service_content_library</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Identifier of the Content Library which holds the VM Images for
vSphere Kubernetes Service. This Content Library should be
subscribed to VMwares 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 doesnt 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.
If None, the Content Library identifier will be cleared.</p></li>
<li><p><strong>workload_ntp_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>cluster_proxy_config</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ProxyConfiguration" title="com.vmware.vcenter.namespace_management_client.ProxyConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProxyConfiguration</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.Stats">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Stats</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cpu_used</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_capacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_used</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_capacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_used</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_capacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.Stats" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Stats</span></code> class contains the basic runtime statistics about a
vSphere Namespaces-enabled cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cpu_used</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Overall CPU usage of the cluster, in MHz. This is the sum of CPU
usage across all worker nodes in the cluster.</p></li>
<li><p><strong>cpu_capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) 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.</p></li>
<li><p><strong>memory_used</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Overall memory usage of the cluster, in mebibytes. This is the sum
of memory usage across all worker nodes in the cluster.</p></li>
<li><p><strong>memory_capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) 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.</p></li>
<li><p><strong>storage_used</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Overall storage used by the cluster, in mebibytes. This is the sum
of storage used across all worker nodes in the cluster.</p></li>
<li><p><strong>storage_capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stats</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kubernetes_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Summary</span></code> class contains the basic information about the
cluster statistics and status related to vSphere Namespaces.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>cluster_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource.name</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource.name</span></code>.</p></li>
<li><p><strong>stats</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.Stats" title="com.vmware.vcenter.namespace_management_client.Clusters.Stats"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Stats</span></code></a>) Basic runtime statistics for the cluster.</p></li>
<li><p><strong>config_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus" title="com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.ConfigStatus</span></code></a>) Current setting for <code class="docutils literal notranslate"><span class="pre">Clusters.ConfigStatus</span></code>.</p></li>
<li><p><strong>kubernetes_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus" title="com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.KubernetesStatus</span></code></a>) Current setting for <code class="docutils literal notranslate"><span class="pre">Clusters.KubernetesStatus</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size_hint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">floating_ip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncp_cluster_network_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_dns</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">worker_dns</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_dns_search_domains</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_ntp_servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_storage_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ephemeral_storage_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cns_file_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">login_banner</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_image_registry</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_image_repository</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_endpoint_certificate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_kubernetes_service_content_library</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">workload_ntp_servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster_proxy_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.UpdateSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>size_hint</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SizingHint" title="com.vmware.vcenter.namespace_management_client.SizingHint"><code class="xref py py-class docutils literal notranslate"><span class="pre">SizingHint</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>floating_ip</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.EnableSpec.master_management_network</span></code>. 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.</p></li>
<li><p><strong>network_provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NetworkProvider</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The provider of cluster networking for this vSphere Namespaces
cluster.
If None, the existing effective cluster network specification will
not be modified.</p></li>
<li><p><strong>ncp_cluster_network_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkUpdateSpec" title="com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkUpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Updated specification for the cluster network configuration.
If None, the existing effective cluster network specification will
not be modified.</p></li>
<li><p><strong>master_dns</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) List of DNS server IP addresses to use on Kubernetes API server,
specified in order of preference.
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, DNS servers set on Kubernetes API server will be
replaced. Otherwise, they will not be modified.</p></li>
<li><p><strong>worker_dns</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) List of DNS server IP addresses to use on the worker nodes,
specified in order of preference.
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, DNS servers set on worker nodes will be replaced.
Otherwise, they will not be modified.</p></li>
<li><p><strong>master_dns_search_domains</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, DNS search domains on Kubernetes API server will
be replaced. Otherwise, they will not be modified.</p></li>
<li><p><strong>master_ntp_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) List of NTP server DNS names or IP addresses to use on Kubernetes
API server, specified in order of preference.
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, NTP servers on Kubernetes API server will be
replaced. Otherwise, they will not be modified.</p></li>
<li><p><strong>master_storage_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Identifier of 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:
<code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>.
If None, storage policy associated with Kubernetes API server will
not be modified.</p></li>
<li><p><strong>ephemeral_storage_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Identifier of 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:
<code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>.
If None, storage policy associated with ephemeral disks of all the
Kubernetes Pods will not be modified.</p></li>
<li><p><strong>cns_file_config</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.CNSFileConfig" title="com.vmware.vcenter.namespace_management_client.CNSFileConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">CNSFileConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>login_banner</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>image_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec" title="com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.ImageStorageSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specification for storage to be used for container images.
If None, configuration of storage used for container images is not
modified.</p></li>
<li><p><strong>default_image_registry</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry" title="com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.ImageRegistry</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>default_image_repository</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>tls_endpoint_certificate</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Certificate issued for Kubernetes API Server. Certificate 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
<code class="docutils literal notranslate"><span class="pre">Clusters.UpdateSpec</span></code> to specify this
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.UpdateSpec.tls_endpoint_certificate</span></code> on an existing
cluster rather than during initially enabling Namespaces on a
cluster.
If None, Kubernetes API Server certificate will not be modified.</p></li>
<li><p><strong>default_kubernetes_service_content_library</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Identifier of the Content Library which holds the VM Images for
vSphere Kubernetes Service. This Content Library should be
subscribed to VMwares 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 doesnt 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.
If None, the Content Library will will not be modified.</p></li>
<li><p><strong>workload_ntp_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>cluster_proxy_config</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ProxyConfiguration" title="com.vmware.vcenter.namespace_management_client.ProxyConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProxyConfiguration</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.WorkloadNetworksEnableSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">WorkloadNetworksEnableSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_primary_workload_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_list</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.WorkloadNetworksEnableSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.WorkloadNetworksEnableSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor_primary_workload_network</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.CreateSpec" title="com.vmware.vcenter.namespace_management_client.Networks.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.CreateSpec</span></code></a>) 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.</p></li>
<li><p><strong>network_list</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.CreateSpec" title="com.vmware.vcenter.namespace_management_client.Networks.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.WorkloadNetworksInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">WorkloadNetworksInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_primary_workload_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_list</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.WorkloadNetworksInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.WorkloadNetworksInfo</span></code> contains information related to
configuration of vSphere Namespaces Network objects. This class was added
in vSphere API 7.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor_primary_workload_network</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.Info" title="com.vmware.vcenter.namespace_management_client.Networks.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.Info</span></code></a>) 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.</p></li>
<li><p><strong>network_list</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.Info" title="com.vmware.vcenter.namespace_management_client.Networks.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.Info</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.disable">
<code class="sig-name descname"><span class="pre">disable</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.disable" title="Permalink to this definition"></a></dt>
<dd><p>Disable vSphere Namespaces on the cluster. This operation tears down
the Kubernetes instance and the worker nodes associated with vSphere
Namespaces enabled cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster for which vSphere Namespaces will be
disabled.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the Supervisor cluster is being restored from a backup. When a
Supervisor cluster is restored, theres a window of time during
which the restored Supervisor clusters state is being synchronized
back to vCenter. During that time, Supervisor clusters disablement
is not allowed.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the Supervisor cluster could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.enable">
<code class="sig-name descname"><span class="pre">enable</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.enable" title="Permalink to this definition"></a></dt>
<dd><p>Enable vSphere Namespaces on the cluster. This operation sets up
Kubernetes instance for the cluster along with worker nodes.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster on which vSphere Namespaces will be
enabled.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.EnableSpec" title="com.vmware.vcenter.namespace_management_client.Clusters.EnableSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.EnableSpec</span></code></a>) Specification for setting up the Kubernetes API server and the
worker nodes.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if the cluster already has vSphere Namespaces enabled.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if resources/objects could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contain any errors.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
if the specified cluster is not licensed or resource pool
reservation for control plane VMs fails.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Manage privilege.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the specified cluster is not supported for vSphere Namespaces,
the clusters hosts do not have the required ESX version, or for
any other incompatibilities.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about a specific cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster on which vSphere Namespaces are enabled.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.Info" title="com.vmware.vcenter.namespace_management_client.Clusters.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the desired state of the specified cluster.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if cluster could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the specified cluster does not have vSphere Namespaces enabled.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about all clusters on which vSphere Namespaces are
enabled on this vCenter.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.list" title="com.vmware.vcenter.namespace_management_client.Clusters.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.Summary" title="com.vmware.vcenter.namespace_management_client.Clusters.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Summary</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of summary of all clusters with vSphere Namespaces enabled.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.rotate_password">
<code class="sig-name descname"><span class="pre">rotate_password</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.rotate_password" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster for which the password is being
generated.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if cluster could not be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Manage privilege.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the cluster is in the process of password rotation.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.set">
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.set" title="Permalink to this definition"></a></dt>
<dd><p>Set a new configuration on the cluster object. The specified
configuration is applied in entirety and will replace the current
configuration fully.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster on which vSphere Namespaces is enabled.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.SetSpec" title="com.vmware.vcenter.namespace_management_client.Clusters.SetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.SetSpec</span></code></a>) New specification for the Supervisor cluster.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contain any errors.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if 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, theres a window of time during
which the restored Supervisor clusters state is being synchronized
back to vCenter. During that time, Supervisor clusters
configuration modifications are not allowed.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the Supervisor cluster could not be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Manage privilege.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the Supervisor clusters hosts are not configured with
sufficient resources for the new Kubernetes API Server size.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.Clusters.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Clusters.update" title="Permalink to this definition"></a></dt>
<dd><p>Update configuration on the cluster object. The specified configuration
is applied partially and None fields in <code class="docutils literal notranslate"><span class="pre">spec</span></code> will leave those parts
of configuration as-is.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster on which vSphere Namespaces is enabled.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.UpdateSpec" title="com.vmware.vcenter.namespace_management_client.Clusters.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.UpdateSpec</span></code></a>) New specification for the Supervisor cluster.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contain any errors.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if 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, theres a window of time during
which the restored Supervisor clusters state is being synchronized
back to vCenter. During that time, Supervisor clusters
configuration modifications are not allowed.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the Supervisor cluster could not be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Manage privilege.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the Supervisor clusters hosts are not configured with
sufficient resources for the new Kubernetes API Server size.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">DistributedSwitchCompatibility</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DistributedSwitchCompatibility</span></code> class provides methods to get
Namespaces compatibility information of Distributed Switches in this
vCenter.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.FilterSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compatible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DistributedSwitchCompatibility.FilterSpec</span></code> class contains attributes
used to filter the results when listing Distributed Switches (see
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.list" title="com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">DistributedSwitchCompatibility.list()</span></code></a>) and their compatibility
information.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>compatible</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>network_provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NetworkProvider</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">distributed_switch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compatible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">incompatibility_reasons</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compatible_networks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DistributedSwitchCompatibility.Summary</span></code> class contains information
about the compatibility of a vSphere Distributed Switch with the Namespaces
feature.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>distributed_switch</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the switch. If
<code class="xref py py-attr docutils literal notranslate"><span class="pre">DistributedSwitchCompatibility.Summary.network_provider</span></code> 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:
<code class="docutils literal notranslate"><span class="pre">vSphereDistributedSwitch</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">vSphereDistributedSwitch</span></code>.</p></li>
<li><p><strong>compatible</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Compatibility of this switch with vSphere Namespaces.</p></li>
<li><p><strong>incompatibility_reasons</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) List of reasons for incompatibility.
If None, this Distributed Switch is compatible.</p></li>
<li><p><strong>network_provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NetworkProvider</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>compatible_networks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">Network</span></code>. When methods return a value of this class as a return
value, the attribute will contain identifiers for the resource
type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns Namespaces compatibility information of Distributed Switches in
vCenter associated with the vCenter cluster, matching the
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.FilterSpec" title="com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DistributedSwitchCompatibility.FilterSpec</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.FilterSpec" title="com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DistributedSwitchCompatibility.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specification of matching Distributed Switches for which
information should be returned.
If None, the behavior is equivalent to a
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.FilterSpec" title="com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DistributedSwitchCompatibility.FilterSpec</span></code></a> with all
attributes None which means all Distributed Switches match the
filter.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.list" title="com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.Summary" title="com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">DistributedSwitchCompatibility.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Namespaces compatibility information for Distributed Switches
matching the the
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.FilterSpec" title="com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DistributedSwitchCompatibility.FilterSpec</span></code></a>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InternalServerError" title="com.vmware.vapi.std.errors_client.InternalServerError"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code></a>
if the server reports an unknown internal error.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if no cluster with the given <code class="docutils literal notranslate"><span class="pre">cluster</span></code> ID can be found</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">EdgeClusterCompatibility</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">EdgeClusterCompatibility</span></code> class provides methods to get Namespaces
compatibility information of NSX Edge Clusters.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compatible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">EdgeClusterCompatibility.FilterSpec</span></code> class contains attributes used
to filter the results when listing Edge Clusters (see
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.list" title="com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">EdgeClusterCompatibility.list()</span></code></a>) and their compatibility information.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>compatible</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">edge_cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compatible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">incompatibility_reasons</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">EdgeClusterCompatibility.Summary</span></code> class contains information about
an NSX-T Edge Cluster, including its compatibility with the vCenter
Namespaces feature.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>edge_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">NSXEdgeCluster</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">NSXEdgeCluster</span></code>.</p></li>
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Display name of the Edge Cluster.</p></li>
<li><p><strong>compatible</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Compatibility of this Edge Cluster with Namespaces feature.</p></li>
<li><p><strong>incompatibility_reasons</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) List of reasons for incompatibility.
If None, this Edge Cluster is compatible.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">distributed_switch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns Namespaces compatibility information of NSX-T Edge Clusters
matching the <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec" title="com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeClusterCompatibility.FilterSpec</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>distributed_switch</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">vSphereDistributedSwitch</span></code>.</p></li>
<li><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec" title="com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeClusterCompatibility.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specification of matching Edge Clusters for which information
should be returned.
If None, the behavior is equivalent to a
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec" title="com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeClusterCompatibility.FilterSpec</span></code></a> with all attributes
None which means all Edge Clusters match the filter.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.list" title="com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.Summary" title="com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeClusterCompatibility.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of summaries of Edge Clusters associated with the given
vCenter Cluster and Distributed Switch matching the
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec" title="com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">EdgeClusterCompatibility.FilterSpec</span></code></a>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InternalServerError" title="com.vmware.vapi.std.errors_client.InternalServerError"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code></a>
if the server reports an unknown internal error.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if no cluster with the given <code class="docutils literal notranslate"><span class="pre">cluster</span></code> ID can be found</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.HostsConfig">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">HostsConfig</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.HostsConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">HostsConfig</span></code> class provides methods to retrieve information about
vSphere Namespaces support and licensing.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.HostsConfig.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespaces_supported</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespaces_licensed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.HostsConfig.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">HostsConfig.Info</span></code> class contains information about vSphere
Namespaces support and licensing.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>namespaces_supported</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) True if vSphere Namespace feature is supported in this VC.</p></li>
<li><p><strong>namespaces_licensed</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) True if vSphere Namespace feature is licensed on any hosts in this
VC.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.HostsConfig.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.HostsConfig.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns support and licensing information about hosts under a VC.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.HostsConfig.Info" title="com.vmware.vcenter.namespace_management_client.HostsConfig.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostsConfig.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Information about vSphere Namespaces support and licensing.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.IPRange">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">IPRange</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.IPRange" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">IPRange</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The starting address of the range. This attribute was added in
vSphere API 7.0.1.0.</p></li>
<li><p><strong>count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The number of IP addresses in the range. This attribute was added
in vSphere API 7.0.1.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Ipv4Cidr">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">Ipv4Cidr</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The IPv4 address.</p></li>
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The CIDR prefix.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">LoadBalancers</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">LoadBalancers</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.AviConfigCreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">AviConfigCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_authority_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.AviConfigCreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">LoadBalancers.AviConfigCreateSpec</span></code> captures the configuration data
required for integration with the Avi Software Load Balancer. This class
was added in vSphere API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>server</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Server" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Server"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.Server</span></code></a>) Server is the address for the Avi Controller, used to configure
Virtual Servers. This attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) An administrator user name for accessing the Avi Controller. This
attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The password for the administrator user. This attribute was added
in vSphere API 7.0.2.0.</p></li>
<li><p><strong>certificate_authority_chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.AviConfigSetSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">AviConfigSetSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_authority_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.AviConfigSetSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">LoadBalancers.AviConfigSetSpec</span></code> captures the configuration data required
for integration with the Avi Software Load Balancer. This class was added
in vSphere API 7.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>server</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Server" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Server"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.Server</span></code></a>) 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.</p></li>
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) An administrator user name for accessing the Avi Controller. This
attribute was added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The password for the administrator user. This attribute was added
in vSphere API 7.0.3.0.</p></li>
<li><p><strong>certificate_authority_chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.AviConfigUpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">AviConfigUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_authority_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.AviConfigUpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">LoadBalancers.AviConfigUpdateSpec</span></code> captures the configuration data
required for integration with the Avi Software Load Balancer. This class
was added in vSphere API 7.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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.</p></li>
<li><p><strong>certificate_authority_chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.AviInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">AviInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_authority_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.AviInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.AviInfo</span></code> contains information related to the Avi
software load balancer in the namespace. This class was added in vSphere
API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>server</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Server" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Server"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.Server</span></code></a>) Server is the address for the Avi Controller, used to configure
Virtual Servers. This attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) An administrator user name for accessing the Avi Controller. This
attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>certificate_authority_chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.ConfigSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ConfigSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address_ranges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_proxy_config_create_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">avi_config_create_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.ConfigSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.ConfigSpec</span></code> encapsulates load balancer configuration
on vSphere Namespaces. This class was added in vSphere API 7.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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 `
&lt;<a class="reference external" href="https://tools.ietf.org/html/rfc1123">https://tools.ietf.org/html/rfc1123</a>&gt;`_. 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.LoadBalancerConfig</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.LoadBalancerConfig</span></code>.</p></li>
<li><p><strong>address_ranges</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.IPRange" title="com.vmware.vcenter.namespace_management_client.IPRange"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRange</span></code></a>) List of address ranges that will be used to derive frontend IP
addresses for L4 virtual servers. At least one range must be
provided. This attribute was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.Provider</span></code></a>) The <code class="xref py py-attr docutils literal notranslate"><span class="pre">LoadBalancers.ConfigSpec.provider</span></code> 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.</p></li>
<li><p><strong>ha_proxy_config_create_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyConfigCreateSpec" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyConfigCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.HAProxyConfigCreateSpec</span></code></a>) The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.HAProxyConfigCreateSpec</span></code> 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 <code class="docutils literal notranslate"><span class="pre">provider</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.HA_PROXY" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.HA_PROXY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LoadBalancers.Provider.HA_PROXY</span></code></a>.</p></li>
<li><p><strong>avi_config_create_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.AviConfigCreateSpec" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.AviConfigCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.AviConfigCreateSpec</span></code></a>) The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.AviConfigCreateSpec</span></code> 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 <code class="docutils literal notranslate"><span class="pre">provider</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.AVI" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.AVI"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LoadBalancers.Provider.AVI</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyConfigCreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">HAProxyConfigCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_authority_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyConfigCreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">LoadBalancers.HAProxyConfigCreateSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Server" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Server"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.Server</span></code></a>) 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.</p></li>
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) An administrator user name for accessing the HAProxy Data Plane API
server. This attribute was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The password for the administrator user. This attribute was added
in vSphere API 7.0.1.0.</p></li>
<li><p><strong>certificate_authority_chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyConfigSetSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">HAProxyConfigSetSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_authority_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyConfigSetSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">LoadBalancers.HAProxyConfigSetSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Server" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Server"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.Server</span></code></a>) 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.</p></li>
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) An administrator user name for accessing the HAProxy Data Plane API
server. This attribute was added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The password for the administrator user. This attribute was added
in vSphere API 7.0.3.0.</p></li>
<li><p><strong>certificate_authority_chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyConfigUpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">HAProxyConfigUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_authority_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyConfigUpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">LoadBalancers.HAProxyConfigUpdateSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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.</p></li>
<li><p><strong>certificate_authority_chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">HAProxyInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_authority_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.HAProxyInfo</span></code> contains information related to the
HAProxy load balancer in the namespace. This class was added in vSphere API
7.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Server" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Server"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.Server</span></code></a>) 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.</p></li>
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) An administrator user name for accessing the HAProxy Data Plane API
server. This attribute was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>certificate_authority_chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address_ranges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_proxy_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">avi_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.Info</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.LoadBalancerConfig</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.LoadBalancerConfig</span></code>.</p></li>
<li><p><strong>address_ranges</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.IPRange" title="com.vmware.vcenter.namespace_management_client.IPRange"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRange</span></code></a>) IP address range from which virtual servers are assigned their IPs.
This attribute was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.Provider</span></code></a>) Load balancer provider for the namespace. This attribute was added
in vSphere API 7.0.1.0.</p></li>
<li><p><strong>ha_proxy_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyInfo" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.HAProxyInfo</span></code></a>) The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.HAProxyInfo</span></code> 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 <code class="docutils literal notranslate"><span class="pre">provider</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.HA_PROXY" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.HA_PROXY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LoadBalancers.Provider.HA_PROXY</span></code></a>.</p></li>
<li><p><strong>avi_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.AviInfo" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.AviInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.AviInfo</span></code></a>) The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.AviInfo</span></code> 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 <code class="docutils literal notranslate"><span class="pre">provider</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.AVI" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.AVI"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LoadBalancers.Provider.AVI</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Provider</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.Provider</span></code> enumerates the kinds of load balancers
supported by vSphere Namespaces. This enumeration was added in vSphere API
7.0.1.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Provider</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.AVI">
<code class="sig-name descname"><span class="pre">AVI</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Provider(string='AVI')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.AVI" title="Permalink to this definition"></a></dt>
<dd><p>NSX Advanced Load Balancer. This class attribute was added in vSphere API
7.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.HA_PROXY">
<code class="sig-name descname"><span class="pre">HA_PROXY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Provider(string='HA_PROXY')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.HA_PROXY" title="Permalink to this definition"></a></dt>
<dd><p>HAProxy load balancer. This class attribute was added in vSphere API
7.0.1.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.Server">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Server</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Server" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A <code class="docutils literal notranslate"><span class="pre">LoadBalancers.Server</span></code> represents an endpoint used to configure load
balancers. This class was added in vSphere API 7.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Load balancer hostname or IPv4 address. This attribute was added in
vSphere API 7.0.1.0.</p></li>
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Load balancer port. This attribute was added in vSphere API
7.0.1.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.SetSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">SetSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address_ranges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_proxy_config_set_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">avi_config_set_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.SetSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.SetSpec</span></code> encapsulates configuration allowed for
setting a new configuration for a load balancer. This class was added in
vSphere API 7.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>address_ranges</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.IPRange" title="com.vmware.vcenter.namespace_management_client.IPRange"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRange</span></code></a>) List of address ranges that will be used to derive frontend IP
addresses for L4 virtual servers. 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.</p></li>
<li><p><strong>provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.Provider</span></code></a>) The <code class="xref py py-attr docutils literal notranslate"><span class="pre">LoadBalancers.SetSpec.provider</span></code> 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.</p></li>
<li><p><strong>ha_proxy_config_set_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyConfigSetSpec" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyConfigSetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.HAProxyConfigSetSpec</span></code></a>) The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.HAProxyConfigSetSpec</span></code> 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 <code class="docutils literal notranslate"><span class="pre">provider</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.HA_PROXY" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.HA_PROXY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LoadBalancers.Provider.HA_PROXY</span></code></a>.</p></li>
<li><p><strong>avi_config_set_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.AviConfigSetSpec" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.AviConfigSetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.AviConfigSetSpec</span></code></a>) The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.AviConfigSetSpec</span></code> 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 <code class="docutils literal notranslate"><span class="pre">provider</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.AVI" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.AVI"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LoadBalancers.Provider.AVI</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.Summary</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.LoadBalancerConfig</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.LoadBalancerConfig</span></code>.</p></li>
<li><p><strong>provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.Provider</span></code></a>) Load balancer provider for the namespace. This attribute was added
in vSphere API 7.0.1.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address_ranges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_proxy_config_update_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">avi_config_update_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.UpdateSpec</span></code> encapsulates configuration allowed for
when updating configuration for load balancers. This class was added in
vSphere API 7.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>address_ranges</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.IPRange" title="com.vmware.vcenter.namespace_management_client.IPRange"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRange</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) List of address ranges that will be used to derive frontend IP
addresses for L4 virtual servers. 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.</p></li>
<li><p><strong>provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.Provider</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The <code class="xref py py-attr docutils literal notranslate"><span class="pre">LoadBalancers.UpdateSpec.provider</span></code> 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 <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, 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.</p></li>
<li><p><strong>ha_proxy_config_update_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyConfigUpdateSpec" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyConfigUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.HAProxyConfigUpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.HAProxyConfigUpdateSpec</span></code> 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.</p></li>
<li><p><strong>avi_config_update_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.AviConfigUpdateSpec" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.AviConfigUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.AviConfigUpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The <code class="docutils literal notranslate"><span class="pre">LoadBalancers.AviConfigUpdateSpec</span></code> 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Info" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.Info</span></code></a> about the load balancer
associated with the given cluster. This method was added in vSphere API
7.0.1.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the cluster the load balancer is associated with.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the load balancer
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LoadBalancers.ConfigSpec.id</span></code>.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.LoadBalancerConfig</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Info" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about load balancer associated with a cluster.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or <code class="docutils literal notranslate"><span class="pre">id</span></code> cannot be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the specified cluster does not have vSphere Namespaces enabled.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about all load balancers associated with the given
cluster. This method was added in vSphere API 7.0.1.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the cluster the load balancers are associated with.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.list" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Summary" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of summary of all load balancers associated with a clusters.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">cluster</span></code> cannot be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the specified cluster does not have vSphere Namespaces enabled.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.set">
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.set" title="Permalink to this definition"></a></dt>
<dd><p>Applies the entire load balancer <code class="docutils literal notranslate"><span class="pre">spec</span></code> to an existing load balancer
configuration. This method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the cluster the load balancer is associated with.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the load balancer.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.LoadBalancerConfig</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.SetSpec" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.SetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.SetSpec</span></code></a>) Information about the load balancer object to be set.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contain any errors.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the associated cluster is being disabled or if the load balancer
config is already marked for delete.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or <code class="docutils literal notranslate"><span class="pre">id</span></code> cannot be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Manage privilege.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the specified cluster does not have vSphere Namespaces enabled.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.LoadBalancers.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.update" title="Permalink to this definition"></a></dt>
<dd><p>Updates the load balancer configuration. The specified configuration is
applied partially and None fields in <code class="docutils literal notranslate"><span class="pre">spec</span></code> will leave those parts of
configuration as-is. This method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the cluster the load balancer is associated with.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the load balancer.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.LoadBalancerConfig</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.UpdateSpec" title="com.vmware.vcenter.namespace_management_client.LoadBalancers.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancers.UpdateSpec</span></code></a>) Information about the load balancer object to be updated.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains any errors.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contain any errors.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the associated cluster is being disabled or if the load balancer
config is already marked for delete.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or <code class="docutils literal notranslate"><span class="pre">id</span></code> cannot be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Manage privilege.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the specified cluster does not have vSphere Namespaces enabled.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.NSXTier0Gateway">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">NSXTier0Gateway</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.NSXTier0Gateway" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NSXTier0Gateway</span></code> provides methods to get information of NSX Tier0
Gateways. This class was added in vSphere API 7.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.NSXTier0Gateway.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tier0_gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.NSXTier0Gateway.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NSXTier0Gateway.Summary</span></code> class contains information about an NSX-T
Tier0 Gateway. This class was added in vSphere API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier0_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the Tier0 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:
<code class="docutils literal notranslate"><span class="pre">NSXTier0Gateway</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">NSXTier0Gateway</span></code>.</p></li>
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Display name of the Tier0 Gateway. This attribute was added in
vSphere API 7.0.2.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.NSXTier0Gateway.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">distributed_switch</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.NSXTier0Gateway.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns information of NSX-T Tier0 Gateways associated with a
Distributed Switch. This method was added in vSphere API 7.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>distributed_switch</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">vSphereDistributedSwitch</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.NSXTier0Gateway.list" title="com.vmware.vcenter.namespace_management_client.NSXTier0Gateway.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.NSXTier0Gateway.Summary" title="com.vmware.vcenter.namespace_management_client.NSXTier0Gateway.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">NSXTier0Gateway.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of summaries of Tier0 Gateways associated with the given
Distributed Switch.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InternalServerError" title="com.vmware.vapi.std.errors_client.InternalServerError"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code></a>
if the server reports an unknown internal error.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if no existing Tier0 Gateways associated with the given Distributed
Switch can be found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.NamespaceResourceOptions">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">NamespaceResourceOptions</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.NamespaceResourceOptions" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NamespaceResourceOptions</span></code> class provides methods to get the objects
used to create and modify resource quotas on a namespace.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.NamespaceResourceOptions.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">create_resource_quota_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update_resource_quota_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.NamespaceResourceOptions.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NamespaceResourceOptions.Info</span></code> class contains the information about
the objects used to set and update resource quota keys on a namespace.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>create_resource_quota_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p></li>
<li><p><strong>update_resource_quota_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.NamespaceResourceOptions.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.NamespaceResourceOptions.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the information about the objects used to set and update resource
quota keys for version of Kubernetes running on {#link cluster}.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.NamespaceResourceOptions.Info" title="com.vmware.vcenter.namespace_management_client.NamespaceResourceOptions.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceResourceOptions.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the structures representing the resource spec.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if cluster could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the specified cluster is not enabled for Namespaces.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Networks">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">Networks</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Networks</span></code> class provides lifecycle methods on vSphere Namespaces
networks associated with a vSphere cluster. This class was added in vSphere
API 7.0.1.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vsphere_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsx_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Networks.CreateSpec</span></code> class contains the specification required to
create a vSphere Namespaces network object. This class was added in vSphere
API 7.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the network. This has DNS_LABEL restrictions as
specified in ` &lt;<a class="reference external" href="https://tools.ietf.org/html/rfc1123">https://tools.ietf.org/html/rfc1123</a>&gt;`_. 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>.</p></li>
<li><p><strong>network_provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NetworkProvider</span></code></a>) The network provider that will manage the vSphere Namespaces
network object. This attribute was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>vsphere_network</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkCreateSpec" title="com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.VsphereDVPGNetworkCreateSpec</span></code></a>) The create spec for a DVPG-backed Namespaces network object,
supported by <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.VSPHERE_NETWORK</span></code></a>
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 <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.VSPHERE_NETWORK</span></code></a>.</p></li>
<li><p><strong>nsx_network</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkCreateSpec" title="com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec</span></code></a>) The create spec for a NSXT-backed Namespaces network configuration,
supported by <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN</span></code></a>
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 <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.IPAssignmentMode">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">IPAssignmentMode</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.IPAssignmentMode" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Networks.IPAssignmentMode</span></code> class defines various IP address
assignment modes. This enumeration was added in vSphere API 7.0.3.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">IPAssignmentMode</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.IPAssignmentMode.DHCP">
<code class="sig-name descname"><span class="pre">DHCP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IPAssignmentMode(string='DHCP')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.IPAssignmentMode.DHCP" title="Permalink to this definition"></a></dt>
<dd><p>The address is automatically assigned by a DHCP server. This class
attribute was added in vSphere API 7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.IPAssignmentMode.STATICRANGE">
<code class="sig-name descname"><span class="pre">STATICRANGE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IPAssignmentMode(string='STATICRANGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.IPAssignmentMode.STATICRANGE" title="Permalink to this definition"></a></dt>
<dd><p>The address is assigned from a static range. This class attribute was added
in vSphere API 7.0.3.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vsphere_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsx_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespaces</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Networks.Info</span></code> class contains detailed information about a specific
vSphere Namespaces network. This class was added in vSphere API 7.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>.</p></li>
<li><p><strong>network_provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NetworkProvider</span></code></a>) The network provider that will manage the vSphere Namespaces
network object. This attribute was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>vsphere_network</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkInfo" title="com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.VsphereDVPGNetworkInfo</span></code></a>) Updated configuration specification for a DVPG-backed Namespaces
network object, supported by
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.VSPHERE_NETWORK</span></code></a> 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 <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.VSPHERE_NETWORK</span></code></a>.</p></li>
<li><p><strong>nsx_network</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkInfo" title="com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.NsxNetworkInfo</span></code></a>) Configuration specification for a NSXT-backed Namespaces network
configuration, supported by
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN</span></code></a> 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 <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN</span></code></a>.</p></li>
<li><p><strong>namespaces</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>. When methods return a
value of this class as a return value, the attribute will contain
identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">LoadBalancerSize</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Networks.LoadBalancerSize</span></code> 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.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancerSize</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize.LARGE">
<code class="sig-name descname"><span class="pre">LARGE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">LoadBalancerSize(string='LARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize.LARGE" title="Permalink to this definition"></a></dt>
<dd><p>Load balancer size of large. This class attribute was added in vSphere
API 7.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize.MEDIUM">
<code class="sig-name descname"><span class="pre">MEDIUM</span></code><em class="property"> <span class="pre">=</span> <span class="pre">LoadBalancerSize(string='MEDIUM')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize.MEDIUM" title="Permalink to this definition"></a></dt>
<dd><p>Load balancer size of medium. This class attribute was added in vSphere
API 7.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize.SMALL">
<code class="sig-name descname"><span class="pre">SMALL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">LoadBalancerSize(string='SMALL')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize.SMALL" title="Permalink to this definition"></a></dt>
<dd><p>Load balancer size of small. This class attribute was added in vSphere
API 7.0.2.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkCreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NsxNetworkCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace_network_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ingress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">egress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsx_tier0_gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subnet_prefix_length</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">routed_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">load_balancer_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkCreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec</span></code> class describes the configuration
specification of a NSXT-backed Namespaces Network configuration. This class
was added in vSphere API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>namespace_network_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.ingress_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.egress_cidrs</span></code>, or other
services running in the datacenter. This attribute was added in
vSphere API 7.0.2.0.
This field is required when
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.nsx_tier0_gateway</span></code> or any of
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.ingress_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.egress_cidrs</span></code> are specified.
An update operation only allows for addition of new CIDR blocks to
the existing list.</p></li>
<li><p><strong>ingress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.namespace_network_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.egress_cidrs</span></code>, or other
services running in the datacenter. This attribute was added in
vSphere API 7.0.2.0.
This field is required when
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.nsx_tier0_gateway</span></code> or any of
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.namespace_network_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.egress_cidrs</span></code> is specified. An
update operation only allows for addition of new CIDR blocks to the
existing list.</p></li>
<li><p><strong>egress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.namespace_network_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.ingress_cidrs</span></code>, or other
services running in the datacenter. This attribute was added in
vSphere API 7.0.2.0.
This field is required when
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.routed_mode</span></code> is set to False
and <code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.nsx_tier0_gateway</span></code> or any
of <code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.namespace_network_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.ingress_cidrs</span></code> is specified.
When <code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.routed_mode</span></code> is set to
True, this field is not allowed. An update operation only allows
for addition of new CIDR blocks to the existing list.</p></li>
<li><p><strong>nsx_tier0_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">NSXTier0Gateway</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">NSXTier0Gateway</span></code>.
This field is required when configuring a cluster that uses NSX-T.</p></li>
<li><p><strong>subnet_prefix_length</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>routed_mode</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.NsxNetworkCreateSpec.egress_cidrs</span></code> is not allowed.
This field does not allow update once applied.</p></li>
<li><p><strong>load_balancer_size</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize" title="com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.LoadBalancerSize</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize.SMALL" title="com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize.SMALL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.LoadBalancerSize.SMALL</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NsxNetworkInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace_network_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ingress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">egress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsx_tier0_gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subnet_prefix_length</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">routed_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">load_balancer_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Networks.NsxNetworkInfo</span></code> class describes the configuration
specification of a NSXT-backed Namespaces Network configuration. This class
was added in vSphere API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>namespace_network_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkInfo.pod_cidrs</span></code> will be applied.</p></li>
<li><p><strong>ingress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkInfo.ingress_cidrs</span></code> will be
applied.</p></li>
<li><p><strong>egress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkInfo.egress_cidrs</span></code> will be
applied.</p></li>
<li><p><strong>nsx_tier0_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">NSXTier0Gateway</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">NSXTier0Gateway</span></code>.
If None, cluster level settings specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkInfo.nsx_tier0_gateway</span></code> will be
applied.</p></li>
<li><p><strong>subnet_prefix_length</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkInfo.namespace_subnet_prefix</span></code> will
be applied.</p></li>
<li><p><strong>routed_mode</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NCPClusterNetworkInfo.routed_mode</span></code> will be applied.</p></li>
<li><p><strong>load_balancer_size</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize" title="com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.LoadBalancerSize</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize.SMALL" title="com.vmware.vcenter.namespace_management_client.Networks.LoadBalancerSize.SMALL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.LoadBalancerSize.SMALL</span></code></a> is used.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkSetSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NsxNetworkSetSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace_network_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ingress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">egress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkSetSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Networks.NsxNetworkSetSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>namespace_network_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code>
exception. Appending invalid Cidr e.g. overlapping or broadcast or
reserved Cidr will result in the operation failing with a
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code> exception.
This attribute was added in vSphere API 7.0.2.0.
If None, the current value will be retained.</p></li>
<li><p><strong>ingress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code> exception.
Appending invalid Cidr e.g. overlapping or broadcast or reserved
Cidr will result in the operation failing with a
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code> exception.
This attribute was added in vSphere API 7.0.2.0.
If None, the current value will be retained.</p></li>
<li><p><strong>egress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code> exception.
Appending invalid Cidr e.g. overlapping or broadcast or reserved
Cidr will result in the operation failing with a
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code> exception.
This attribute was added in vSphere API 7.0.2.0.
If None, the current value will be retained.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkUpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NsxNetworkUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace_network_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ingress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">egress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkUpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Networks.NsxNetworkUpdateSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>namespace_network_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code>
exception. Appending invalid Cidr e.g. overlapping or broadcast or
reserved Cidr will result in the operation failing with a
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code> exception.
This attribute was added in vSphere API 7.0.2.0.
If None, the current value will be retained.</p></li>
<li><p><strong>ingress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code> exception.
Appending invalid Cidr e.g. overlapping or broadcast or reserved
Cidr will result in the operation failing with a
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code> exception.
This attribute was added in vSphere API 7.0.2.0.
If None, the current value will be retained.</p></li>
<li><p><strong>egress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr" title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code> exception.
Appending invalid Cidr e.g. overlapping or broadcast or reserved
Cidr will result in the operation failing with a
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code> exception.
This attribute was added in vSphere API 7.0.2.0.
If None, the current value will be retained.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.namespace_management.Network'</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>The resource type for network. This class attribute was added in vSphere API
7.0.1.0.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.SetSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">SetSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vsphere_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsx_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.SetSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Networks.SetSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>network_provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NetworkProvider</span></code></a>) The network provider that will manage the vSphere Namespaces
network object. This attribute was added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>vsphere_network</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkSetSpec" title="com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkSetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.VsphereDVPGNetworkSetSpec</span></code></a>) Modified configuration specification for a DVPG-backed Namespaces
network object, supported by
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.VSPHERE_NETWORK</span></code></a> network provider.
This attribute was added in vSphere API 7.0.3.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.VSPHERE_NETWORK</span></code></a>.</p></li>
<li><p><strong>nsx_network</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkSetSpec" title="com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkSetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.NsxNetworkSetSpec</span></code></a>) Modified configuration specification for a NSXT-backed Namespaces
network configuration, supported by
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN</span></code></a> 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 <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vsphere_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsx_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Networks.UpdateSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>network_provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.NetworkProvider</span></code></a>) The network provider that will manage the vSphere Namespaces
network object. This attribute was added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>vsphere_network</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkUpdateSpec" title="com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.VsphereDVPGNetworkUpdateSpec</span></code></a>) Updated configuration specification for a DVPG-backed Namespaces
network object, supported by
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.VSPHERE_NETWORK</span></code></a> network provider.
This attribute was added in vSphere API 7.0.3.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.VSPHERE_NETWORK</span></code></a>.</p></li>
<li><p><strong>nsx_network</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkUpdateSpec" title="com.vmware.vcenter.namespace_management_client.Networks.NsxNetworkUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.NsxNetworkUpdateSpec</span></code></a>) Updated configuration specification for a NSXT-backed Namespaces
network configuration, supported by
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN</span></code></a> 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 <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkCreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VsphereDVPGNetworkCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">portgroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_assignment_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address_ranges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subnet_mask</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkCreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Networks.VsphereDVPGNetworkCreateSpec</span></code> class describes the
configuration specification of a vSphere DVPG-backed Namespaces Network
object. This class was added in vSphere API 7.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>portgroup</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.</p></li>
<li><p><strong>ip_assignment_mode</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.IPAssignmentMode" title="com.vmware.vcenter.namespace_management_client.Networks.IPAssignmentMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.IPAssignmentMode</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) IP address assignment mode. If set to DHCP, then field
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.VsphereDVPGNetworkCreateSpec.address_ranges</span></code> must
be set to an empty list and fields
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.VsphereDVPGNetworkCreateSpec.gateway</span></code> and
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Networks.VsphereDVPGNetworkCreateSpec.subnet_mask</span></code> must be
set to empty strings. This attribute was added in vSphere API
7.0.3.0.
If None, defaults to STATICRANGE.</p></li>
<li><p><strong>address_ranges</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.IPRange" title="com.vmware.vcenter.namespace_management_client.IPRange"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRange</span></code></a>) Usable IP pools on this network. This attribute was added in
vSphere API 7.0.1.0.</p></li>
<li><p><strong>gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Gateway for the network. This attribute was added in vSphere API
7.0.1.0.</p></li>
<li><p><strong>subnet_mask</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Subnet mask of the network. This attribute was added in vSphere API
7.0.1.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VsphereDVPGNetworkInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">portgroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_assignment_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address_ranges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subnet_mask</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Networks.VsphereDVPGNetworkInfo</span></code> class describes the configuration
specification of a vSphere DVPG-backed Namespaces Network object. This
class was added in vSphere API 7.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>portgroup</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.</p></li>
<li><p><strong>ip_assignment_mode</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.IPAssignmentMode" title="com.vmware.vcenter.namespace_management_client.Networks.IPAssignmentMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.IPAssignmentMode</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>address_ranges</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.IPRange" title="com.vmware.vcenter.namespace_management_client.IPRange"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRange</span></code></a>) Usable IP pools on this network. This attribute was added in
vSphere API 7.0.1.0.</p></li>
<li><p><strong>gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Gateway for the network. This attribute was added in vSphere API
7.0.1.0.</p></li>
<li><p><strong>subnet_mask</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Subnet mask of the network. This attribute was added in vSphere API
7.0.1.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkSetSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VsphereDVPGNetworkSetSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">portgroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address_ranges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subnet_mask</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkSetSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Networks.VsphereDVPGNetworkSetSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>portgroup</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the vSphere Distributed Portgroup backing the vSphere
network object. If the network object is associated with a
Namespace or is
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network</span></code>,
modification to existing portgroup will result in the operation
failing with a <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code>
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: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.</p></li>
<li><p><strong>address_ranges</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.IPRange" title="com.vmware.vcenter.namespace_management_client.IPRange"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRange</span></code></a>) Usable IP pools on this network. If the network object is
associated with a Namespace or is
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network</span></code>,
then replacement of or modification to any existing range in this
list will result in operation failing with a
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code> 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.</p></li>
<li><p><strong>gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Gateway for the network. If the network object is associated with a
Namespace or is
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network</span></code>,
then modification to existing gateway will result in the operation
failing with a <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code>
exception. This attribute was added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>subnet_mask</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Subnet mask of the network. If the network object is associated
with a Namespace or is
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network</span></code>,
then modification to existing subnet mask will result in the
operation failing with a
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code> exception. This
attribute was added in vSphere API 7.0.3.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkUpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VsphereDVPGNetworkUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">portgroup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address_ranges</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subnet_mask</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkUpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Networks.VsphereDVPGNetworkUpdateSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>portgroup</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Identifier of the vSphere Distributed Portgroup backing the vSphere
network object. If the network object is associated with a
Namespace or is
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network</span></code>,
then modification to existing portgroup will result in the
operation failing with a
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code> 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: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
If None, the current value will be retained.</p></li>
<li><p><strong>address_ranges</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.IPRange" title="com.vmware.vcenter.namespace_management_client.IPRange"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRange</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Usable IP pools on this network. If the network object is
associated with a Namespace or is
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network</span></code>,
then replacement of or modification to any existing range in this
list will result in operation failing with a
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code> 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.</p></li>
<li><p><strong>gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Gateway for the network. If the network object is associated with a
Namespace or is
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network</span></code>,
then modification to existing gateway will result in the operation
failing with a <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code>
exception. This attribute was added in vSphere API 7.0.3.0.
If None, the current value will be retained.</p></li>
<li><p><strong>subnet_mask</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Subnet mask of the network. If the network object is associated
with a Namespace or is
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.WorkloadNetworksEnableSpec.supervisor_primary_workload_network</span></code>,
then modification to existing subnet mask will result in the
operation failing with a
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code> exception. This
attribute was added in vSphere API 7.0.3.0.
If None, the current value will be retained.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.create" title="Permalink to this definition"></a></dt>
<dd><p>Create a vSphere Namespaces network object associated with the given
cluster. This method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.CreateSpec" title="com.vmware.vcenter.namespace_management_client.Networks.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.CreateSpec</span></code></a>) Information about the network object to be created.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if a network by the name as specified in the
<code class="docutils literal notranslate"><span class="pre">Networks.CreateSpec</span></code> already exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains any errors.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the associated cluster is being disabled.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">cluster</span></code> cannot be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains NsxNetworkCreateSpec which is unsupported via
create API.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete the vSphere Namespaces object in the cluster. This method was
added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the vSphere Namespaces network.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if cluster or network could not be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
if the network is associated with a Namespace.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.get" title="Permalink to this definition"></a></dt>
<dd><p>Return information about a specific vSphere Namespaces network. This
method was added in vSphere API 7.0.1.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the vSphere Namespaces network.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.Info" title="com.vmware.vcenter.namespace_management_client.Networks.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of information about all vSphere Namespaces networks in the
cluster.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if cluster or network could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.list" title="Permalink to this definition"></a></dt>
<dd><p>Return information about all vSphere Namespaces networks in the
cluster. This method was added in vSphere API 7.0.1.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.list" title="com.vmware.vcenter.namespace_management_client.Networks.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.Info" title="com.vmware.vcenter.namespace_management_client.Networks.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the specified vSphere Namespaces network..</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if cluster or network could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.set">
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.set" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the vSphere Namespaces network.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.SetSpec" title="com.vmware.vcenter.namespace_management_client.Networks.SetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.SetSpec</span></code></a>) Information about the network object to be set.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains any errors.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the associated cluster is being disabled.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or the <code class="docutils literal notranslate"><span class="pre">network</span></code> cannot be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
if the network is in use and the <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains field values
that are un-settable in such a case.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.Networks.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.Networks.update" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the vSphere Namespaces network.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.Networks.UpdateSpec" title="com.vmware.vcenter.namespace_management_client.Networks.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Networks.UpdateSpec</span></code></a>) Information about the network object to be updated.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains any errors.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the associated cluster is being disabled.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or the <code class="docutils literal notranslate"><span class="pre">network</span></code> cannot be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
if the network is in use and the <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains field values
that are un-updatable in such a case.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.ProxyConfiguration">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">ProxyConfiguration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proxy_settings_source</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">https_proxy_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_proxy_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_proxy_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_root_ca_bundle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ProxyConfiguration" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ProxyConfiguration</span></code> class defines proxy configuration to be used by
the Supervisor. This class was added in vSphere API 7.0.3.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>proxy_settings_source</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ProxySettingsSource" title="com.vmware.vcenter.namespace_management_client.ProxySettingsSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProxySettingsSource</span></code></a>) The source of the proxy settings. If
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ProxySettingsSource.VC_INHERITED" title="com.vmware.vcenter.namespace_management_client.ProxySettingsSource.VC_INHERITED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ProxySettingsSource.VC_INHERITED</span></code></a> or
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ProxySettingsSource.NONE" title="com.vmware.vcenter.namespace_management_client.ProxySettingsSource.NONE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ProxySettingsSource.NONE</span></code></a> is specified, then the other
configuration in <code class="docutils literal notranslate"><span class="pre">ProxyConfiguration</span></code> will be ignored. This
attribute was added in vSphere API 7.0.3.00100.</p></li>
<li><p><strong>https_proxy_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>HTTPS proxy configuration. Examples:</p>
<ul>
<li><p><a class="reference external" href="http://username:password">http://username:password</a>\&#64;proxy.vmware.com:8080</p></li>
<li><p><a class="reference external" href="https://proxy.vmware.com:4443">https://proxy.vmware.com:4443</a></p></li>
</ul>
<p>This will be used if <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ProxySettingsSource.CLUSTER_CONFIGURED" title="com.vmware.vcenter.namespace_management_client.ProxySettingsSource.CLUSTER_CONFIGURED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ProxySettingsSource.CLUSTER_CONFIGURED</span></code></a>
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.</p>
</p></li>
<li><p><strong>http_proxy_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>HTTP proxy configuration. Examples:</p>
<ul>
<li><p><a class="reference external" href="http://username:password">http://username:password</a>\&#64;proxy.vmware.com:8080</p></li>
<li><p><a class="reference external" href="https://proxy.vmware.com:4443">https://proxy.vmware.com:4443</a></p></li>
</ul>
<p>This will be used if <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ProxySettingsSource.CLUSTER_CONFIGURED" title="com.vmware.vcenter.namespace_management_client.ProxySettingsSource.CLUSTER_CONFIGURED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ProxySettingsSource.CLUSTER_CONFIGURED</span></code></a>
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.</p>
</p></li>
<li><p><strong>no_proxy_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) List of addresses that should be accessed directly. This will be
used if <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ProxySettingsSource.CLUSTER_CONFIGURED" title="com.vmware.vcenter.namespace_management_client.ProxySettingsSource.CLUSTER_CONFIGURED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ProxySettingsSource.CLUSTER_CONFIGURED</span></code></a> is used for
the source, otherwise this will be ignored. This attribute was
added in vSphere API 7.0.3.00100.
If None there wont be any excluded addresses.</p></li>
<li><p><strong>tls_root_ca_bundle</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Proxy TLS root CA bundle which will be used to verify the proxies
certificates. Every certificate in the bundle is expected to be in
PEM format. This will be used if
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ProxySettingsSource.CLUSTER_CONFIGURED" title="com.vmware.vcenter.namespace_management_client.ProxySettingsSource.CLUSTER_CONFIGURED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ProxySettingsSource.CLUSTER_CONFIGURED</span></code></a> 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.ProxySettingsSource">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">ProxySettingsSource</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ProxySettingsSource" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The 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.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ProxySettingsSource" title="com.vmware.vcenter.namespace_management_client.ProxySettingsSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProxySettingsSource</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.ProxySettingsSource.CLUSTER_CONFIGURED">
<code class="sig-name descname"><span class="pre">CLUSTER_CONFIGURED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ProxySettingsSource(string='CLUSTER_CONFIGURED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ProxySettingsSource.CLUSTER_CONFIGURED" title="Permalink to this definition"></a></dt>
<dd><p>Proxy settings will be configured at the cluster level. This class
attribute was added in vSphere API 7.0.3.00100.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.ProxySettingsSource.NONE">
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ProxySettingsSource(string='NONE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ProxySettingsSource.NONE" title="Permalink to this definition"></a></dt>
<dd><p>No proxy settings will be applied to the cluster. This class attribute was
added in vSphere API 7.0.3.00100.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.ProxySettingsSource.VC_INHERITED">
<code class="sig-name descname"><span class="pre">VC_INHERITED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ProxySettingsSource(string='VC_INHERITED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.ProxySettingsSource.VC_INHERITED" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SizingHint">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">SizingHint</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SizingHint" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SizingHint</span></code> 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
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.get" title="com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">ClusterSizeInfo.get()</span></code></a> to get information associated with a
<code class="docutils literal notranslate"><span class="pre">SizingHint</span></code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SizingHint" title="com.vmware.vcenter.namespace_management_client.SizingHint"><code class="xref py py-class docutils literal notranslate"><span class="pre">SizingHint</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.SizingHint.LARGE">
<code class="sig-name descname"><span class="pre">LARGE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">SizingHint(string='LARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SizingHint.LARGE" title="Permalink to this definition"></a></dt>
<dd><p>Cluster size of large.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.SizingHint.MEDIUM">
<code class="sig-name descname"><span class="pre">MEDIUM</span></code><em class="property"> <span class="pre">=</span> <span class="pre">SizingHint(string='MEDIUM')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SizingHint.MEDIUM" title="Permalink to this definition"></a></dt>
<dd><p>Cluster size of medium.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.SizingHint.SMALL">
<code class="sig-name descname"><span class="pre">SMALL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">SizingHint(string='SMALL')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SizingHint.SMALL" title="Permalink to this definition"></a></dt>
<dd><p>Cluster size of small.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.SizingHint.TINY">
<code class="sig-name descname"><span class="pre">TINY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">SizingHint(string='TINY')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SizingHint.TINY" title="Permalink to this definition"></a></dt>
<dd><p>Cluster size of tiny.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">SupervisorServices</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.CheckResult">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CheckResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vsphere_apps_check_result</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">warning_messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.CheckResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices.CheckResult</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.ValidationStatus" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.ValidationStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.ValidationStatus</span></code></a>) Indicates if the provided content is valid. This attribute was
added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>content_type</strong> (<a class="reference internal" href="com.vmware.vcenter.namespace_management.html#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType" title="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The type of the provided content. When this <code class="docutils literal notranslate"><span class="pre">contentType</span></code> is
<a class="reference internal" href="com.vmware.vcenter.namespace_management.html#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType.CUSTOM_YAML" title="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType.CUSTOM_YAML"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType.CUSTOM_YAML</span></code></a>,
the <code class="docutils literal notranslate"><span class="pre">status</span></code> is always <code class="docutils literal notranslate"><span class="pre">VALID</span></code> because a custom format is not
validated. This attribute was added in vSphere API 7.0.3.0.
If None, the content type cannot be determined from the provided
content.</p></li>
<li><p><strong>vsphere_apps_check_result</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.VsphereAppsCheckResult" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.VsphereAppsCheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.VsphereAppsCheckResult</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The information about the Supervisor Service version retrieved from
the provided content as a result of validation checks if the
content is in the vSphere application format. This attribute was
added in vSphere API 7.0.3.0.
If None, the content is not in the vSphere application service
format, or the <code class="docutils literal notranslate"><span class="pre">status</span></code> is <code class="docutils literal notranslate"><span class="pre">INVALID</span></code>.</p></li>
<li><p><strong>warning_messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) A list of messages indicating why the content was considered valid
but contains information that should be reviewed closely. This
attribute was added in vSphere API 7.0.3.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.ValidationStatus.VALID_WITH_WARNINGS" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.ValidationStatus.VALID_WITH_WARNINGS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SupervisorServices.ValidationStatus.VALID_WITH_WARNINGS</span></code></a>.</p></li>
<li><p><strong>error_messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) A list of messages indicating why the content was considered
invalid. This attribute was added in vSphere API 7.0.3.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.ValidationStatus.INVALID" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.ValidationStatus.INVALID"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SupervisorServices.ValidationStatus.INVALID</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.ContentCheckSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ContentCheckSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">content</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.ContentCheckSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices.ContentCheckSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>content</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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 <code class="docutils literal notranslate"><span class="pre">InvalidArgument</span></code> will
be thrown.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">custom_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vsphere_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices.CreateSpec</span></code> class provides a specification
required to create a Supervisor Service. Exactly one of
<code class="xref py py-attr docutils literal notranslate"><span class="pre">SupervisorServices.CreateSpec.custom_spec</span></code> or
<code class="xref py py-attr docutils literal notranslate"><span class="pre">SupervisorServices.CreateSpec.vsphere_spec</span></code> must be <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>.
This class was added in vSphere API 7.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>custom_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.CustomCreateSpec" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.CustomCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.CustomCreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>The specification required to create a Supervisor Service with a
version from inline content that is based on a plain Kubernetes
YAML format.</p>
<p>. This attribute was added in vSphere API 7.0.3.0.
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, the service will be created from a version based
on a plain Kubernetes YAML format.</p>
</p></li>
<li><p><strong>vsphere_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.VsphereCreateSpec" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.VsphereCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.VsphereCreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>The specification required to create a Supervisor Service with a
version from inline content that is based on the vSphere
application service format.</p>
<p>. This attribute was added in vSphere API 7.0.3.0.
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, the service will be created from a version based
on the vSphere application service format.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.CustomCreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CustomCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.CustomCreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices.CustomCreateSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The identifier of the Supervisor Service. This has DNS_LABEL
restrictions as specified in `
&lt;<a class="reference external" href="https://tools.ietf.org/html/rfc1123">https://tools.ietf.org/html/rfc1123</a>&gt;`_. 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>. When
methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p></li>
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) A human readable name of the Supervisor Service. This attribute was
added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>version_spec</strong> (<a class="reference internal" href="com.vmware.vcenter.namespace_management.html#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CustomCreateSpec" title="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CustomCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CustomCreateSpec</span></code></a>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices.Info</span></code> class contains detailed information about a
Supervisor Service. This class was added in vSphere API 7.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The human readable name of the Supervisor Service. This attribute
was added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.State" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.State</span></code></a>) The current <code class="docutils literal notranslate"><span class="pre">SupervisorServices.State</span></code> of the Supervisor Service.
This attribute was added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.State">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">State</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.State" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices.State</span></code> class defines the state of a Supervisor
Service. This enumeration was added in vSphere API 7.0.3.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.State.ACTIVATED">
<code class="sig-name descname"><span class="pre">ACTIVATED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='ACTIVATED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.State.ACTIVATED" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.State.DEACTIVATED">
<code class="sig-name descname"><span class="pre">DEACTIVATED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='DEACTIVATED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.State.DEACTIVATED" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices.Summary</span></code> class contains the basic information
about a Supervisor Service version. This class was added in vSphere API
7.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>. When
methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p></li>
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The human readable name of the Supervisor Service. This attribute
was added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.State" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.State</span></code></a>) The current <code class="docutils literal notranslate"><span class="pre">SupervisorServices.State</span></code> of the Supervisor Service.
This attribute was added in vSphere API 7.0.3.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices.UpdateSpec</span></code> class provides a specification
required to update a Supervisor Service. This class was added in vSphere
API 7.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.ValidationStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ValidationStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.ValidationStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices.ValidationStatus</span></code> 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.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ValidationStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.ValidationStatus.INVALID">
<code class="sig-name descname"><span class="pre">INVALID</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ValidationStatus(string='INVALID')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.ValidationStatus.INVALID" title="Permalink to this definition"></a></dt>
<dd><p>Indicates the content is invalid for a Supervisor Service version, in which
case the reasons can be found in <code class="docutils literal notranslate"><span class="pre">errorMessages</span></code>. This class attribute
was added in vSphere API 7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.ValidationStatus.VALID">
<code class="sig-name descname"><span class="pre">VALID</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ValidationStatus(string='VALID')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.ValidationStatus.VALID" title="Permalink to this definition"></a></dt>
<dd><p>Indicates the content is valid for a Supervisor Service version. This class
attribute was added in vSphere API 7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.ValidationStatus.VALID_WITH_WARNINGS">
<code class="sig-name descname"><span class="pre">VALID_WITH_WARNINGS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ValidationStatus(string='VALID_WITH_WARNINGS')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.ValidationStatus.VALID_WITH_WARNINGS" title="Permalink to this definition"></a></dt>
<dd><p>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 <code class="docutils literal notranslate"><span class="pre">warningMessages</span></code>. 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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.VsphereAppsCheckResult">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VsphereAppsCheckResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eula</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.VsphereAppsCheckResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices.VsphereAppsCheckResult</span></code> 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
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.check_content" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.check_content"><code class="xref py py-func docutils literal notranslate"><span class="pre">SupervisorServices.check_content()</span></code></a> method. This class was added in
vSphere API 7.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>. When
methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services.Version</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services.Version</span></code>.</p></li>
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) A human readable name of the Supervisor Service version. This
attribute was added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>eula</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.VsphereCreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VsphereCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.VsphereCreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices.VsphereCreateSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>version_spec</strong> (<a class="reference internal" href="com.vmware.vcenter.namespace_management.html#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.VsphereCreateSpec" title="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.VsphereCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.VsphereCreateSpec</span></code></a>) 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.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.activate">
<code class="sig-name descname"><span class="pre">activate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.activate" title="Permalink to this definition"></a></dt>
<dd><p>Activate a Supervisor Service. This method will change the
<code class="docutils literal notranslate"><span class="pre">SupervisorServices.State</span></code> of the supervisor service to in
<code class="docutils literal notranslate"><span class="pre">ACTIVATED</span></code> state, and activate all versions of the supervisor
service. This method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the Supervisor Service.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the Supervisor Service is already in <code class="docutils literal notranslate"><span class="pre">ACTIVATED</span></code> state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor Service with the ID <code class="docutils literal notranslate"><span class="pre">supervisor_service</span></code> could not
be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the SupervisorServices.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.check_content">
<code class="sig-name descname"><span class="pre">check_content</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.check_content" title="Permalink to this definition"></a></dt>
<dd><p>Perform validation checks on the content of a Supervisor Service
version defined in the <code class="docutils literal notranslate"><span class="pre">spec</span></code>. 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
<code class="docutils literal notranslate"><span class="pre">VALID</span></code> status. Only vSphere and Carvel packages can return multiple
validation statuses. This method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.ContentCheckSpec" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.ContentCheckSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.ContentCheckSpec</span></code></a>) Specification for the content to be checked.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.CheckResult" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.CheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.CheckResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>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.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the provided <code class="docutils literal notranslate"><span class="pre">spec</span></code> is invalid. For example, the provided
<code class="xref py py-attr docutils literal notranslate"><span class="pre">SupervisorServices.ContentCheckSpec.content</span></code> is empty or not
base64 encoded.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.create" title="Permalink to this definition"></a></dt>
<dd><p>Create a Supervisor Service. If version specs are provided in the
<code class="docutils literal notranslate"><span class="pre">spec</span></code>, new Supervisor Service versions will be created as part of
the operation. This method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.CreateSpec" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.CreateSpec</span></code></a>) Specification for the Supervisor Service with version definition.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if a Supervisor Service with the same identifier already exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> 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.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the SupervisorServices.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.deactivate">
<code class="sig-name descname"><span class="pre">deactivate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.deactivate" title="Permalink to this definition"></a></dt>
<dd><p>Deactivate a Supervisor Service. This method will change the
<code class="docutils literal notranslate"><span class="pre">SupervisorServices.State</span></code> of the supervisor service to
<code class="docutils literal notranslate"><span class="pre">DEACTIVATED</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the Supervisor Service.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the Supervisor Service is already in <code class="docutils literal notranslate"><span class="pre">DEACTIVATED</span></code> state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor Service with the ID <code class="docutils literal notranslate"><span class="pre">supervisor_service</span></code> could not
be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the SupervisorServices.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete a Supervisor Service. This method only deletes the Supervisor
Service from vCenter if the Supervisor Service is in <code class="docutils literal notranslate"><span class="pre">DEACTIVATED</span></code>
state, and all versions of the Supervisor Service are removed from
vCenter. Note that the <code class="docutils literal notranslate"><span class="pre">deactivate</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the Supervisor Service.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the Supervisor Service cannot be deleted in the current state,
e.g. a version of the Supervisor Service is not in <code class="docutils literal notranslate"><span class="pre">DEACTIVATED</span></code>
state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor Service with the ID <code class="docutils literal notranslate"><span class="pre">supervisor_service</span></code> could not
be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the SupervisorServices.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.get" title="Permalink to this definition"></a></dt>
<dd><p>Return the information for the specified Supervisor Service. This
method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the Supervisor Service.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.Info" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information for the specified Supervisor Service.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor Service with the ID <code class="docutils literal notranslate"><span class="pre">supervisor_service</span></code> could not
be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.list" title="Permalink to this definition"></a></dt>
<dd><p>Return the information about all Supervisor Services on this vCenter.
This method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.list" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.Summary" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.Summary</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The list of summary of all Supervisor Services.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.SupervisorServices.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.update" title="Permalink to this definition"></a></dt>
<dd><p>Update a Supervisor Service. This method was added in vSphere API
7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the Supervisor Service.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupervisorServices.UpdateSpec" title="com.vmware.vcenter.namespace_management_client.SupervisorServices.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.UpdateSpec</span></code></a>) Specification for the Supervisor Service metadata to be updated.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contain any errors or if an invalid name is specified.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor Service with the ID <code class="docutils literal notranslate"><span class="pre">supervisor_service</span></code> could not
be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the SupervisorServices.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SupportBundle">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">SupportBundle</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupportBundle" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupportBundle</span></code> class provides methods to retrieve the clusters
Namespaces-related support bundle download location.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SupportBundle.Location">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Location</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wcp_support_bundle_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupportBundle.Location" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupportBundle.Location</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Support Bundle Download URL.</p></li>
<li><p><strong>wcp_support_bundle_token</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupportBundle.Token" title="com.vmware.vcenter.namespace_management_client.SupportBundle.Token"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupportBundle.Token</span></code></a>) Information about the token required in the HTTP GET request to
generate the support bundle.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.SupportBundle.Token">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Token</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expiry</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupportBundle.Token" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupportBundle.Token</span></code> class contains information about the token
required in the HTTP GET request to generate the support bundle.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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”.</p></li>
<li><p><strong>expiry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Expiry time of the token</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.SupportBundle.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.SupportBundle.create" title="Permalink to this definition"></a></dt>
<dd><p>Returns the location <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupportBundle.Location" title="com.vmware.vcenter.namespace_management_client.SupportBundle.Location"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupportBundle.Location</span></code></a> information for
downloading the Namespaces-related support bundle for the specified
cluster.</p>
<blockquote>
<div><p>Retrieving a support bundle involves two steps:</p>
</div></blockquote>
<ul class="simple">
<li><p>Step 1: Invoke method to provision a token and a URI.</p></li>
<li><p>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.</p></li>
</ul>
<p>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
<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupportBundle.Location" title="com.vmware.vcenter.namespace_management_client.SupportBundle.Location"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupportBundle.Location</span></code></a> response.</p>
<blockquote>
<div><p>The HTTP GET request will:</p>
</div></blockquote>
<ul class="simple">
<li><p>return 401 (Not Authorized) if the download URL is recognized, but
the token is invalid.</p></li>
<li><p>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 responses Content-Disposition header.</p></li>
</ul>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of cluster for which the Namespaces-related support
bundle should be generated.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.SupportBundle.Location" title="com.vmware.vcenter.namespace_management_client.SupportBundle.Location"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupportBundle.Location</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>the download location of the support bundle for the cluster.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the specified cluster is not registered on this vCenter server.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Global.Diagnostics privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management_client.</span></code><code class="sig-name descname"><span class="pre">VirtualMachineClasses</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VirtualMachineClasses</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.ConfigStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ConfigStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.ConfigStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>ConfigStatus represents the config status of the VM class. This enumeration
was added in vSphere API 7.0.2.00100.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.ConfigStatus.READY">
<code class="sig-name descname"><span class="pre">READY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='READY')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.ConfigStatus.READY" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that the instance of the <code class="docutils literal notranslate"><span class="pre">VirtualMachineClasses</span></code> is ready to be
used. This class attribute was added in vSphere API 7.0.2.00100.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.ConfigStatus.REMOVING">
<code class="sig-name descname"><span class="pre">REMOVING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='REMOVING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.ConfigStatus.REMOVING" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that the instance of the <code class="docutils literal notranslate"><span class="pre">VirtualMachineClasses</span></code> 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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_reservation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_mb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_reservation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">devices</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance_storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VirtualMachineClasses.CreateSpec</span></code> class contains the specification
required to create a VM class object. This class was added in vSphere API
7.0.2.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the virtual machine class. This has DNS_LABEL
restrictions as specified in `
&lt;<a class="reference external" href="https://tools.ietf.org/html/rfc1123">https://tools.ietf.org/html/rfc1123</a>&gt;`_. 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.VirtualMachineClass</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.VirtualMachineClass</span></code>.</p></li>
<li><p><strong>cpu_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The number of CPUs configured for virtual machine of this class.
This attribute was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>cpu_reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>memory_mb</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The amount of memory in MB configured for virtual machine of this
class. This attribute was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>memory_reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Description 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.</p></li>
<li><p><strong>devices</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.VirtualDevices" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.VirtualDevices"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.VirtualDevices</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>instance_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.InstanceStorage" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.InstanceStorage"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.InstanceStorage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.DynamicDirectPathIODevice">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DynamicDirectPathIODevice</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vendor_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.DynamicDirectPathIODevice" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VirtualMachineClasses.DynamicDirectPathIODevice</span></code> class contains the
configuration corresponding to a Dynamic DirectPath I/O device. This class
was added in vSphere API 7.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vendor_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The vendor ID of this device. This attribute was added in vSphere
API 7.0.3.0.</p></li>
<li><p><strong>device_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The device ID of this device. This attribute was added in vSphere
API 7.0.3.0.</p></li>
<li><p><strong>custom_label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_reservation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_mb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_reservation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespaces</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">devices</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance_storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VirtualMachineClasses.Info</span></code> class contains detailed information
about the virtual machine class. This class was added in vSphere API
7.0.2.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.VirtualMachineClass</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.VirtualMachineClass</span></code>.</p></li>
<li><p><strong>cpu_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The number of CPUs configured for virtual machine of this class.
This attribute was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>cpu_reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>memory_mb</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The amount of memory in MB configured for virtual machine of this
class. This attribute was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>memory_reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Description of the VM class. This attribute was added in vSphere
API 7.0.2.00100.</p></li>
<li><p><strong>namespaces</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>. When methods return a
value of this class as a return value, the attribute will contain
identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>.</p></li>
<li><p><strong>vms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>. When methods return a value of this class as a
return value, the attribute will contain identifiers for the
resource type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
<li><p><strong>config_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.ConfigStatus" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.ConfigStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.ConfigStatus</span></code></a>) Configstatus of VM class. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.Message</span></code></a>) Current set of messages associated with the object. This attribute
was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>devices</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.VirtualDevices" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.VirtualDevices"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.VirtualDevices</span></code></a>) 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.</p></li>
<li><p><strong>instance_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.InstanceStorage" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.InstanceStorage"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.InstanceStorage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.InstanceStorage">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">InstanceStorage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volumes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.InstanceStorage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VirtualMachineClasses.InstanceStorage</span></code> class encapsulates
information about storage policy and instance storage volumes. This class
was added in vSphere API 8.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>.</p></li>
<li><p><strong>volumes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.InstanceStorageVolume" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.InstanceStorageVolume"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.InstanceStorageVolume</span></code></a>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.InstanceStorageVolume">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">InstanceStorageVolume</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.InstanceStorageVolume" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VirtualMachineClasses.InstanceStorageVolume</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) 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.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Message</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">severity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VirtualMachineClasses.Message</span></code> class contains the information about
the object configuration. This class was added in vSphere API 7.0.2.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>severity</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.Message.MessageSeverity</span></code></a>) Type of the message. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>details</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Details about the message. This attribute was added in vSphere API
7.0.2.00100.
If None, message details are not required for taking actions.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">MessageSeverity</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VirtualMachineClasses.Message.MessageSeverity</span></code> class represents the
severity of the message. This enumeration was added in vSphere API
7.0.2.00100.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">MessageSeverity</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MessageSeverity(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Error message. This is accompanied by vCenter event and/or alarm. This
class attribute was added in vSphere API 7.0.2.00100.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity.INFO">
<code class="sig-name descname"><span class="pre">INFO</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MessageSeverity(string='INFO')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity.INFO" title="Permalink to this definition"></a></dt>
<dd><p>Informational message. This may be accompanied by vCenter event. This class
attribute was added in vSphere API 7.0.2.00100.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity.WARNING">
<code class="sig-name descname"><span class="pre">WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MessageSeverity(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity.WARNING" title="Permalink to this definition"></a></dt>
<dd><p>Warning message. This may be accompanied by vCenter event. This class
attribute was added in vSphere API 7.0.2.00100.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.namespace_management.VirtualMachineClass'</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>The resource type for VM class. This class attribute was added in vSphere API
7.0.2.00100.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cpu_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_reservation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_mb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_reservation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">devices</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance_storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VirtualMachineClasses.UpdateSpec</span></code> class contains the specification
required to update a VM class object. This class was added in vSphere API
7.0.2.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cpu_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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.</p></li>
<li><p><strong>cpu_reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>memory_mb</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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.</p></li>
<li><p><strong>memory_reservation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Description for the VM class. This attribute was added in vSphere
API 7.0.2.00100.
If None, description is not updated.</p></li>
<li><p><strong>devices</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.VirtualDevices" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.VirtualDevices"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.VirtualDevices</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>instance_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.InstanceStorage" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.InstanceStorage"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.InstanceStorage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.VGPUDevice">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VGPUDevice</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.VGPUDevice" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VirtualMachineClasses.VGPUDevice</span></code> class contains the configuration
corresponding to a vGPU device. This class was added in vSphere API
7.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>profile_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Profile name corresponding to the device. This attribute was added
in vSphere API 7.0.3.0.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.VirtualDevices">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VirtualDevices</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vgpu_devices</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dynamic_direct_path_io_devices</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.VirtualDevices" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VirtualMachineClasses.VirtualDevices</span></code> class contains information
about the virtual devices associated with a VM class. This class was added
in vSphere API 7.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vgpu_devices</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.VGPUDevice" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.VGPUDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.VGPUDevice</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) List of vGPU devices. This attribute was added in vSphere API
7.0.3.0.
If None, no vGPU devices are present.</p></li>
<li><p><strong>dynamic_direct_path_io_devices</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.DynamicDirectPathIODevice" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.DynamicDirectPathIODevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.DynamicDirectPathIODevice</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.create" title="Permalink to this definition"></a></dt>
<dd><p>Create a VM class object. This method was added in vSphere API
7.0.2.00100.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.CreateSpec" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.CreateSpec</span></code></a>) Information about the VM class object to be created.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if a VM class by the name as specified in the <code class="docutils literal notranslate"><span class="pre">spec</span></code> already
exists in the vCenter inventory.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the input {\&#64;param.spec.instanceStorage.policy} refers to an
invalid storage policy or if the input <code class="docutils literal notranslate"><span class="pre">spec</span></code> includes settings
that are out of acceptable bounds or a combination of settings that
are not internally consistent with the input <code class="docutils literal notranslate"><span class="pre">spec</span></code>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have VirtualMachineClasses.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_class</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete the VM class object. This method was added in vSphere API
7.0.2.00100.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>vm_class</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the VM class.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.VirtualMachineClass</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
- TBD</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
VM class could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have VirtualMachineClasses.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_class</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.get" title="Permalink to this definition"></a></dt>
<dd><p>Return information about a VM class. This method was added in vSphere
API 7.0.2.00100.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>vm_class</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the VM class.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.VirtualMachineClass</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Info" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the specified VM class.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if VM class can not be found in the vCenter inventory.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.list" title="Permalink to this definition"></a></dt>
<dd><p>Return information about all VirtualMachine classes. This method was
added in vSphere API 7.0.2.00100.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.list" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Info" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of information about all VirtualMachine classes</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_class</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.update" title="Permalink to this definition"></a></dt>
<dd><p>Update the configuration of the VM class object. This method was added
in vSphere API 7.0.2.00100.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm_class</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the VM class.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.VirtualMachineClass</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.UpdateSpec" title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VirtualMachineClasses.UpdateSpec</span></code></a>) Information about the VM class object to be updated.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if a VM class by the name as specified in the <code class="docutils literal notranslate"><span class="pre">spec</span></code> already
exists in the vCenter inventory.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the input {\&#64;param.spec.instanceStorage.policy} refers to an
invalid storage policy or if the input <code class="docutils literal notranslate"><span class="pre">spec</span></code> includes settings
that are out of acceptable bounds or a combination of settings that
are not internally consistent with the input <code class="docutils literal notranslate"><span class="pre">spec</span></code>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if or the <code class="docutils literal notranslate"><span class="pre">vm_class</span></code> cannot be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have VirtualMachineClasses.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.namespaces_client">
<span id="com-vmware-vcenter-namespaces-client-module"></span><h2>com.vmware.vcenter.namespaces_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespaces_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces_client</span></code> module provides classes for
managing namespaces related methods.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Access">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespaces_client.</span></code><code class="sig-name descname"><span class="pre">Access</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Access" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Access</span></code> class provides methods to manage access control of subjects
on namespaces.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Access.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Access.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Access.CreateSpec</span></code> class contains the specification required to
create access control on the namespace.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>role</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Access.Role" title="com.vmware.vcenter.namespaces_client.Access.Role"><code class="xref py py-class docutils literal notranslate"><span class="pre">Access.Role</span></code></a>) Role to be assigned.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Access.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inherited</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Access.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Access.Info</span></code> class contains the information about the access control
of the subject on given domain on the namespace.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>role</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Access.Role" title="com.vmware.vcenter.namespaces_client.Access.Role"><code class="xref py py-class docutils literal notranslate"><span class="pre">Access.Role</span></code></a>) Role of the subject on the namespace.</p></li>
<li><p><strong>inherited</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Flag to indicate if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Access.Info.role</span></code> is direct or
inherited. The value is set to <code class="docutils literal notranslate"><span class="pre">true</span></code> if the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Access.Info.role</span></code> 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Access.Role">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Role</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Access.Role" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Access.Role</span></code> class lists the default roles which can be associated
with a subject on a domain on the namespace.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Access.Role.EDIT">
<code class="sig-name descname"><span class="pre">EDIT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Role(string='EDIT')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Access.Role.EDIT" title="Permalink to this definition"></a></dt>
<dd><p>This role allows modification of the namespace.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Access.Role.OWNER">
<code class="sig-name descname"><span class="pre">OWNER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Role(string='OWNER')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Access.Role.OWNER" title="Permalink to this definition"></a></dt>
<dd><p>This role allows modification and deletion of the namespace. This class
attribute was added in vSphere API 7.0.2.00100.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Access.Role.VIEW">
<code class="sig-name descname"><span class="pre">VIEW</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Role(string='VIEW')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Access.Role.VIEW" title="Permalink to this definition"></a></dt>
<dd><p>This is a read-only role on the namespace.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Access.SetSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">SetSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Access.SetSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Access.SetSpec</span></code> class contains the specification required to set new
access control on the namespace.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>role</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Access.Role" title="com.vmware.vcenter.namespaces_client.Access.Role"><code class="xref py py-class docutils literal notranslate"><span class="pre">Access.Role</span></code></a>) Role to be assigned.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Access.SubjectType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">SubjectType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Access.SubjectType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Access.SubjectType</span></code> class lists the types of subjects who can be
associated with a <code class="docutils literal notranslate"><span class="pre">Access.Role</span></code> on the namespace.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">SubjectType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Access.SubjectType.GROUP">
<code class="sig-name descname"><span class="pre">GROUP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">SubjectType(string='GROUP')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Access.SubjectType.GROUP" title="Permalink to this definition"></a></dt>
<dd><p>Group of users.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Access.SubjectType.USER">
<code class="sig-name descname"><span class="pre">USER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">SubjectType(string='USER')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Access.SubjectType.USER" title="Permalink to this definition"></a></dt>
<dd><p>Single user.</p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.Access.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Access.create" title="Permalink to this definition"></a></dt>
<dd><p>Set up access control for the subject on given domain on the namespace.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the namespace.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>.</p></li>
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The domain of the subject.</p></li>
<li><p><strong>subject</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The principal for this operation.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Access.SubjectType" title="com.vmware.vcenter.namespaces_client.Access.SubjectType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Access.SubjectType</span></code></a>) The type of subject (user or group).</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Access.CreateSpec" title="com.vmware.vcenter.namespaces_client.Access.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Access.CreateSpec</span></code></a>) Information about the access control to be created.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if the specified principal on given domain is already associated
with a role on the namespace.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the namespace is marked for deletion or the associated cluster
is being disabled.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">namespace</span></code> cannot be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Configure privilege or the
namespace identifier begins with “vmware-system” prefix.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.Access.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Access.delete" title="Permalink to this definition"></a></dt>
<dd><p>Remove access control of the subject on given domain from the
namespace.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the namespace.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>.</p></li>
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The domain of the subject.</p></li>
<li><p><strong>subject</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The principal for this operation.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Access.SubjectType" title="com.vmware.vcenter.namespaces_client.Access.SubjectType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Access.SubjectType</span></code></a>) The type of subject (user or group).</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the namespace is marked for deletion or the associated cluster
is being disabled.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">namespace</span></code> cannot be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the specified principal on given domain is not associated with
the namespace.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Configure privilege or the
namespace identifier begins with “vmware-system” prefix.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.Access.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Access.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the information about the access control of the subject on given
domain on the namespace.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the namespace.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>.</p></li>
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The domain of the subject.</p></li>
<li><p><strong>subject</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The principal for this operation.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Access.SubjectType" title="com.vmware.vcenter.namespaces_client.Access.SubjectType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Access.SubjectType</span></code></a>) The type of subject (user or group).</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Access.Info" title="com.vmware.vcenter.namespaces_client.Access.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Access.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the subject including the type and the role on
the namespace.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">namespace</span></code> cannot be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the specified principal on given domain is not associated with
the namespace.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.Access.set">
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Access.set" title="Permalink to this definition"></a></dt>
<dd><p>Set new access control on the namespace for the subject on given
domain.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the namespace.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>.</p></li>
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The domain of the subject.</p></li>
<li><p><strong>subject</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The principal for this operation.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Access.SubjectType" title="com.vmware.vcenter.namespaces_client.Access.SubjectType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Access.SubjectType</span></code></a>) The type of subject (user or group).</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Access.SetSpec" title="com.vmware.vcenter.namespaces_client.Access.SetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Access.SetSpec</span></code></a>) Information about the new access control to be assigned.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the namespace is marked for deletion or the associated cluster
is being disabled.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">namespace</span></code> cannot be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the specified principal on given domain is not associated with
the namespace.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Configure privilege or the
namespace identifier begins with “vmware-system” prefix.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespaces_client.</span></code><code class="sig-name descname"><span class="pre">Instances</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances</span></code> class provides methods to create and delete a namespace
object. In this version, an Instance is an abstraction around a Kubernetes
namespace.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.Access">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Access</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subject_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.Access" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.Access</span></code> class contains the access control information for
a subject on a namespace.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>subject_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Access.SubjectType" title="com.vmware.vcenter.namespaces_client.Access.SubjectType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Access.SubjectType</span></code></a>) Type of the subject.</p></li>
<li><p><strong>subject</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the subject.</p></li>
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Domain of the subject.</p></li>
<li><p><strong>role</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Access.Role" title="com.vmware.vcenter.namespaces_client.Access.Role"><code class="xref py py-class docutils literal notranslate"><span class="pre">Access.Role</span></code></a>) Role of the subject on the namespace instance.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.ConfigStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ConfigStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.ConfigStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.ConfigStatus</span></code> class describes the status of reaching the
desired state configuration for the namespace.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Instances.ConfigStatus.CONFIGURING">
<code class="sig-name descname"><span class="pre">CONFIGURING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='CONFIGURING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.ConfigStatus.CONFIGURING" title="Permalink to this definition"></a></dt>
<dd><p>The configuration is being applied to the namespace.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Instances.ConfigStatus.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.ConfigStatus.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Failed to apply the configuration to the namespace, user intervention
needed.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Instances.ConfigStatus.REMOVING">
<code class="sig-name descname"><span class="pre">REMOVING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='REMOVING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.ConfigStatus.REMOVING" title="Permalink to this definition"></a></dt>
<dd><p>The configuration is being removed and namespace is being deleted.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Instances.ConfigStatus.RUNNING">
<code class="sig-name descname"><span class="pre">RUNNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='RUNNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.ConfigStatus.RUNNING" title="Permalink to this definition"></a></dt>
<dd><p>The namespace is configured correctly.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">access_list</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_specs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">networks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_service_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">creator</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespace_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.CreateSpec</span></code> class contains the specification required to
set up a namespace on a single vSphere cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the namespace. This has DNS_LABEL restrictions as
specified in ` &lt;<a class="reference external" href="https://tools.ietf.org/html/rfc1123">https://tools.ietf.org/html/rfc1123</a>&gt;`_. 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>. When methods return a
value of this class as a return value, the attribute will be an
identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Description for the namespace.
If None, no description is added to the namespace.</p></li>
<li><p><strong>resource_spec</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1" title="com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1</span></code></a>.
If None, no resource limits will be set on the namespace.</p></li>
<li><p><strong>access_list</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Access" title="com.vmware.vcenter.namespaces_client.Instances.Access"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Access</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Access controls associated with the namespace.
If None, only users with Administrator role can access the
namespace.</p></li>
<li><p><strong>storage_specs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec" title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.StorageSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>networks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) vSphere Namespaces network objects to be associated with the
namespace. The values of this list need to reference names of
pre-existing
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Networks.Info</span></code> 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>. When methods
return a value of this class as a return value, the attribute will
contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>.
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 clusters Supervisor Primary
Workload Network. The field currently accepts at most only 1
vSphere Namespaces network object reference.</p></li>
<li><p><strong>vm_service_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec" title="com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.VMServiceSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>creator</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Principal" title="com.vmware.vcenter.namespaces_client.Instances.Principal"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Principal</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>namespace_network</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.NetworkCreateSpec" title="com.vmware.vcenter.namespaces_client.Instances.NetworkCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.NetworkCreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stats</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">access_list</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_specs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">networks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_service_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">creator</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">self_service_namespace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.Info</span></code> class contains the detailed information about the
namespace on a single vSphere cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>config_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.ConfigStatus" title="com.vmware.vcenter.namespaces_client.Instances.ConfigStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.ConfigStatus</span></code></a>) Current setting for <code class="docutils literal notranslate"><span class="pre">Instances.ConfigStatus</span></code>.</p></li>
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Message" title="com.vmware.vcenter.namespaces_client.Instances.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Message</span></code></a>) Current set of messages associated with the object.</p></li>
<li><p><strong>stats</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Stats" title="com.vmware.vcenter.namespaces_client.Instances.Stats"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Stats</span></code></a>) Basic runtime statistics for the namespace.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Description of the namespace.</p></li>
<li><p><strong>resource_spec</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>access_list</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Access" title="com.vmware.vcenter.namespaces_client.Instances.Access"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Access</span></code></a>) Access controls associated with the namespace.</p></li>
<li><p><strong>storage_specs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec" title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.StorageSpec</span></code></a>) Storage associated with the namespace.</p></li>
<li><p><strong>networks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>. When methods
return a value of this class as a return value, the attribute will
contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>.
This field is None if the cluster hosting this namespace uses
NSXT_CONTAINER_PLUGIN as its network provider.</p></li>
<li><p><strong>vm_service_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec" title="com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.VMServiceSpec</span></code></a>) 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.</p></li>
<li><p><strong>creator</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Principal" title="com.vmware.vcenter.namespaces_client.Instances.Principal"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Principal</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>self_service_namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.Ipv4Cidr">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Ipv4Cidr</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.Ipv4Cidr" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The specification for representing CIDR notation of IP range. This class
was added in vSphere API 7.0.2.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The IPv4 address. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The CIDR prefix. This attribute was added in vSphere API
7.0.2.00100.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.LoadBalancerSize">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">LoadBalancerSize</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.LoadBalancerSize" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.LoadBalancerSize</span></code> 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.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">LoadBalancerSize</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Instances.LoadBalancerSize.LARGE">
<code class="sig-name descname"><span class="pre">LARGE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">LoadBalancerSize(string='LARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.LoadBalancerSize.LARGE" title="Permalink to this definition"></a></dt>
<dd><p>Load balancer size of large. This class attribute was added in vSphere
API 7.0.2.00100.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Instances.LoadBalancerSize.MEDIUM">
<code class="sig-name descname"><span class="pre">MEDIUM</span></code><em class="property"> <span class="pre">=</span> <span class="pre">LoadBalancerSize(string='MEDIUM')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.LoadBalancerSize.MEDIUM" title="Permalink to this definition"></a></dt>
<dd><p>Load balancer size of medium. This class attribute was added in vSphere
API 7.0.2.00100.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Instances.LoadBalancerSize.SMALL">
<code class="sig-name descname"><span class="pre">SMALL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">LoadBalancerSize(string='SMALL')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.LoadBalancerSize.SMALL" title="Permalink to this definition"></a></dt>
<dd><p>Load balancer size of small. This class attribute was added in vSphere
API 7.0.2.00100.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.Message">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Message</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">severity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.Message" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.Message</span></code> class contains the information about the object
configuration.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>severity</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity" title="com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Message.MessageSeverity</span></code></a>) Type of the message.</p></li>
<li><p><strong>details</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Details about the message.
If None, message details are not required for taking actions.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">MessageSeverity</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.Message.MessageSeverity</span></code> class represents the severity of
the message.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">MessageSeverity</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MessageSeverity(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Error message. This is accompanied by vCenter event and/or alarm.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity.INFO">
<code class="sig-name descname"><span class="pre">INFO</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MessageSeverity(string='INFO')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity.INFO" title="Permalink to this definition"></a></dt>
<dd><p>Informational message. This may be accompanied by vCenter event.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity.WARNING">
<code class="sig-name descname"><span class="pre">WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MessageSeverity(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity.WARNING" title="Permalink to this definition"></a></dt>
<dd><p>Warning message. This may be accompanied by vCenter event.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.NetworkCreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NetworkCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network_provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.NetworkCreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.NetworkCreateSpec</span></code> class contains the specification
required to create a vSphere Namespaces network object. This class was
added in vSphere API 7.0.2.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>network_provider</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.NetworkProvider" title="com.vmware.vcenter.namespaces_client.Instances.NetworkProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.NetworkProvider</span></code></a>) The network provider that will manage the vSphere Namespaces
network object. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>network</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.NsxNetworkCreateSpec" title="com.vmware.vcenter.namespaces_client.Instances.NsxNetworkCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec</span></code></a>) The create spec for an NSXT-backed Namespaces network
configuration, supported by
<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="com.vmware.vcenter.namespaces_client.Instances.NetworkProvider.NSXT_CONTAINER_PLUGIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NetworkProvider.NSXT_CONTAINER_PLUGIN</span></code></a> network
provider. This attribute was added in vSphere API 7.0.2.00100.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">networkProvider</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="com.vmware.vcenter.namespaces_client.Instances.NetworkProvider.NSXT_CONTAINER_PLUGIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NetworkProvider.NSXT_CONTAINER_PLUGIN</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.NetworkProvider">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NetworkProvider</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.NetworkProvider" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>Identifies the network plugin that networking functionalities for this
vSphere Namespace. This enumeration was added in vSphere API 7.0.2.00100.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkProvider</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Instances.NetworkProvider.NSXT_CONTAINER_PLUGIN">
<code class="sig-name descname"><span class="pre">NSXT_CONTAINER_PLUGIN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetworkProvider(string='NSXT_CONTAINER_PLUGIN')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.NetworkProvider.NSXT_CONTAINER_PLUGIN" title="Permalink to this definition"></a></dt>
<dd><p>NSX-T Container Plugin. This class attribute was added in vSphere API
7.0.2.00100.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Instances.NetworkProvider.VSPHERE_NETWORK">
<code class="sig-name descname"><span class="pre">VSPHERE_NETWORK</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetworkProvider(string='VSPHERE_NETWORK')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.NetworkProvider.VSPHERE_NETWORK" title="Permalink to this definition"></a></dt>
<dd><p>vSphere Networking. This class attribute was added in vSphere API
7.0.2.00100.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.NsxNetworkCreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NsxNetworkCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace_network_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ingress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">egress_cidrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsx_tier0_gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subnet_prefix_length</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">routed_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">load_balancer_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.NsxNetworkCreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec</span></code> class describes the configuration
specification of a NSXT-backed Namespaces Network configuration. This class
was added in vSphere API 7.0.2.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>namespace_network_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Ipv4Cidr" title="com.vmware.vcenter.namespaces_client.Instances.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.ingress_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.egress_cidrs</span></code>, or other
services running in the datacenter. This attribute was added in
vSphere API 7.0.2.00100.
This field is required when
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.nsx_tier0_gateway</span></code> or any of
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.ingress_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.egress_cidrs</span></code> are specified.
An update operation only allows for addition of new CIDR blocks to
the existing list.</p></li>
<li><p><strong>ingress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Ipv4Cidr" title="com.vmware.vcenter.namespaces_client.Instances.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.namespace_network_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.egress_cidrs</span></code>, or other
services running in the datacenter. This attribute was added in
vSphere API 7.0.2.00100.
This field is required when
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.nsx_tier0_gateway</span></code> or any of
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.namespace_network_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.egress_cidrs</span></code> are specified.
An update operation only allows for addition of new CIDR blocks to
the existing list.</p></li>
<li><p><strong>egress_cidrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Ipv4Cidr" title="com.vmware.vcenter.namespaces_client.Instances.Ipv4Cidr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Ipv4Cidr</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.namespace_network_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.ingress_cidrs</span></code>, or other
services running in the datacenter. This attribute was added in
vSphere API 7.0.2.00100.
This field is required when
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.routed_mode</span></code> is set to False
and <code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.nsx_tier0_gateway</span></code> or any
of <code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.namespace_network_cidrs</span></code>,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.ingress_cidrs</span></code> is specified.
When <code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.routed_mode</span></code> is set to
True, this field is not allowed. An update operation only allows
for addition of new CIDR blocks to the existing list.</p></li>
<li><p><strong>nsx_tier0_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">NSXTier0Gateway</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">NSXTier0Gateway</span></code>.
If None, cluster level settings specified in
com.vmware.vcenter.namespace_management.Clusters.NCPClusterNetworkInfo#nsxTier0Gateway
will be applied.</p></li>
<li><p><strong>subnet_prefix_length</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>routed_mode</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.NsxNetworkCreateSpec.egress_cidrs</span></code> is not allowed.
This field does not allow update once applied.</p></li>
<li><p><strong>load_balancer_size</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.LoadBalancerSize" title="com.vmware.vcenter.namespaces_client.Instances.LoadBalancerSize"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.LoadBalancerSize</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.LoadBalancerSize.SMALL" title="com.vmware.vcenter.namespaces_client.Instances.LoadBalancerSize.SMALL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.LoadBalancerSize.SMALL</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.Principal">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Principal</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subject</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.Principal" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.Principal</span></code> class contains the information about the
creator of namespace. This class was added in vSphere API 7.0.2.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>subject</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the subject. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Domain of the subject. This attribute was added in vSphere API
7.0.2.00100.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.Instances.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.namespaces.Instance'</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>The resource type for namespace.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.SetSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">SetSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">access_list</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_specs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_service_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.SetSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.SetSpec</span></code> class contains the specification required to set
a new configuration on the namespace. This class is applied in entirety,
replacing the current specification fully.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Description for the namespace.
If None, the description of the namespace will be cleared.</p></li>
<li><p><strong>resource_spec</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1" title="com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1</span></code></a>.
If None, the resource constraints on the namespace will be cleared.</p></li>
<li><p><strong>access_list</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Access" title="com.vmware.vcenter.namespaces_client.Instances.Access"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Access</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>storage_specs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec" title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.StorageSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>vm_service_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec" title="com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.VMServiceSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.Stats">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Stats</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cpu_used</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_used</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_used</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.Stats" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.Stats</span></code> class contains the basic runtime statistics about
the namespace.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cpu_used</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Overall CPU usage of the namespace, in MHz. This is the sum of CPU
usage across all pods in the Kubernetes namespace.</p></li>
<li><p><strong>memory_used</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Overall memory usage of the namespace (in mebibytes). This is the
sum of memory usage across all pods.</p></li>
<li><p><strong>storage_used</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.StorageSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">StorageSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.StorageSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">SpsStorageProfile</span></code>.</p></li>
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The maximum amount of storage (in mebibytes) which can be utilized
by the namespace for this specification.
If None, no limits are placed.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stats</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">self_service_namespace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.Summary</span></code> class contains the basic information about the
namespace on a single vSphere cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>. When methods return a
value of this class as a return value, the attribute will be an
identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Description of the namespace.</p></li>
<li><p><strong>config_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.ConfigStatus" title="com.vmware.vcenter.namespaces_client.Instances.ConfigStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.ConfigStatus</span></code></a>) Current setting for <code class="docutils literal notranslate"><span class="pre">Instances.ConfigStatus</span></code>.</p></li>
<li><p><strong>stats</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Stats" title="com.vmware.vcenter.namespaces_client.Instances.Stats"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Stats</span></code></a>) Basic runtime statistics for the namespace.</p></li>
<li><p><strong>self_service_namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">access_list</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_specs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_service_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.UpdateSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Description for the namespace.
If None, the description of the namespace will not be modified.</p></li>
<li><p><strong>resource_spec</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1Update" title="com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1Update"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update</span></code></a>.
If None, the resource constraints on the namespace will not be
modified.</p></li>
<li><p><strong>access_list</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Access" title="com.vmware.vcenter.namespaces_client.Instances.Access"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Access</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>storage_specs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec" title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.StorageSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>vm_service_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec" title="com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.VMServiceSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VMServiceSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">content_libraries</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_classes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Instances.VMServiceSpec</span></code> class contains the specification required
to configure the VM Service specification associated with a namespace.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>content_libraries</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Set of content libraries for use by the VM Service. The content
libraries specified should exist in vSphere inventory. 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>vm_classes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>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.</p>
<p><strong>NOTE:</strong> 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.VirtualMachineClass</span></code>.
When methods return a value of this class as a return value, the
attribute will contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.VirtualMachineClass</span></code>.
This attribute is optional because it was added in a newer version
than its parent node.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.Instances.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.create" title="Permalink to this definition"></a></dt>
<dd><p>Create a namespace object on a single vSphere cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.CreateSpec" title="com.vmware.vcenter.namespaces_client.Instances.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.CreateSpec</span></code></a>) The specification for setting up the namespace.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if a namespace with the same name exists in vCenter server.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains any errors or if an invalid name is specified.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the associated Supervisor cluster is being disabled or if the
associated Supervisor cluster is being restored from a backup. When
a Supervisor cluster is restored, theres a window of time during
which the restored Supervisor clusters state is being synchronized
back to vCenter. During that time, namespace creation is not
allowed.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.CreateSpec.cluster</span></code> is not registered on this
vCenter server.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if:attr:<cite>Instances.CreateSpec.cluster</cite> is not enabled for
Namespaces, or if the networks field is set when the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Instances.CreateSpec.cluster</span></code> hosting the namespace uses
NSXT_CONTAINER_PLUGIN as its network provider, or if the Supervisor
cluster does not support customizable VM classes.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Configure privilege or the
namespace identifier begins with “vmware-system” prefix.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.Instances.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete the namespace object in the cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the namespace.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the associated Supervisor cluster is being restored from a
backup. When a Supervisor cluster is restored, theres a window of
time during which the restored Supervisor clusters state is being
synchronized back to vCenter. During that time, namespace deletion
is not allowed.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the specified namespace could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Configure privilege or the
namespace identifier begins with “vmware-system” prefix.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.Instances.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about a specific namespace on a single vSphere
cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the namespace.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Info" title="com.vmware.vcenter.namespaces_client.Instances.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the desired state of the specified namespace.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if namespace could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.Instances.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns the information about all namespaces in this vCenter Server.
The information is tied to a single vSphere cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.list" title="com.vmware.vcenter.namespaces_client.Instances.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Summary" title="com.vmware.vcenter.namespaces_client.Instances.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Summary</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Information about all namespaces in this vCenter server.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.Instances.set">
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.set" title="Permalink to this definition"></a></dt>
<dd><p>Set a new configuration on the namespace object. The specified
configuration is applied in entirety and will replace the current
configuration fully.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the namespace.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.SetSpec" title="com.vmware.vcenter.namespaces_client.Instances.SetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.SetSpec</span></code></a>) New specification for the namespace.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contain any errors.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the 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, theres a window of time during
which the restored Supervisor clusters state is being synchronized
back to vCenter. During that time, namespace configuration
modifications are not allowed.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if namespace with the name <code class="docutils literal notranslate"><span class="pre">namespace</span></code> could not be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Configure privilege or the
namespace identifier begins with “vmware-system” prefix.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if customizable VM classes are not suported for this Supervisor
cluster.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.Instances.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.Instances.update" title="Permalink to this definition"></a></dt>
<dd><p>Update the namespace object. The specified configuration is applied
partially and None fields in <code class="docutils literal notranslate"><span class="pre">spec</span></code> will leave those parts of
configuration as-is.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the namespace.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.UpdateSpec" title="com.vmware.vcenter.namespaces_client.Instances.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.UpdateSpec</span></code></a>) Specification for updating the namespace.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contain any errors.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the 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, theres a window of time during
which the restored Supervisor clusters state is being synchronized
back to vCenter. During that time, namespace configuration
modifications are not allowed.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if namespace with the name <code class="docutils literal notranslate"><span class="pre">namespace</span></code> could not be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Configure privilege or the
namespace identifier begins with “vmware-system” prefix.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if customizable VM classes are not suported for this Supervisor
cluster.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespaces_client.</span></code><code class="sig-name descname"><span class="pre">NamespaceSelfService</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NamespaceSelfService</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.ActivateTemplateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ActivateTemplateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_specs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">networks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_service_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.ActivateTemplateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NamespaceSelfService.ActivateTemplateSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>template</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.NamespaceTemplate</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.NamespaceTemplate</span></code>.</p></li>
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.Subject" title="com.vmware.vcenter.namespaces_client.NamespaceTemplates.Subject"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceTemplates.Subject</span></code></a>) Namespace Self Service permission to subjects. This attribute was
added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>resource_spec</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code>) 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 <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1" title="com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1</span></code></a>. This
attribute was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>storage_specs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec" title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.StorageSpec</span></code></a>) Storage associated with the self service namespace. This attribute
was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>networks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) vSphere Namespaces network objects to be associated with the
namespace. The values of this list need to reference names of
pre-existing
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Networks.Info</span></code> 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
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 clusters Supervisor Primary
Workload Network. The field currently accepts at most only 1
vSphere Namespaces network object reference.</p></li>
<li><p><strong>vm_service_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec" title="com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.VMServiceSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">NamespaceSelfService.ActivateTemplateSpec.vm_service_spec</span></code>
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 Content Libraries by
default.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Capability</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NamespaceSelfService.Capability</span></code> 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.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Capability</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability.NOTSUPPORTED">
<code class="sig-name descname"><span class="pre">NOTSUPPORTED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Capability(string='NOTSUPPORTED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability.NOTSUPPORTED" title="Permalink to this definition"></a></dt>
<dd><p>The value that indicates the cluster doesnt support the self-service
namespace capability. The expected transition UNKNOWN &gt; NOTSUPPORTED.
This class attribute was added in vSphere API 7.0.2.00100.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability.SUPPORTED">
<code class="sig-name descname"><span class="pre">SUPPORTED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Capability(string='SUPPORTED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability.SUPPORTED" title="Permalink to this definition"></a></dt>
<dd><p>The value that indicates the cluster supports self-service namespace
capability. The expected transition UNKNOWN &gt; SUPPORTED. This class
attribute was added in vSphere API 7.0.2.00100.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability.UNKNOWN">
<code class="sig-name descname"><span class="pre">UNKNOWN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Capability(string='UNKNOWN')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability.UNKNOWN" title="Permalink to this definition"></a></dt>
<dd><p>The initial value that represents the in-progress activity of determining
the clusters self-service namespace capability. This class attribute was
added in vSphere API 7.0.2.00100.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NamespaceSelfService.Info</span></code> class contains detailed information about
the namespace self service. This class was added in vSphere API
7.0.2.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>capability</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability" title="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceSelfService.Capability</span></code></a>) The self-service namespace capability of the cluster with vSphere
Namespaces enabled. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status" title="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceSelfService.Status</span></code></a>) The current status of the namespace-self-service. This attribute
was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.Message" title="com.vmware.vcenter.namespaces_client.Instances.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.Message</span></code></a>) Current set of messages associated with the object. This attribute
was added in vSphere API 7.0.2.00100.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The 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.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status.CONFIGURING">
<code class="sig-name descname"><span class="pre">CONFIGURING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='CONFIGURING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status.CONFIGURING" title="Permalink to this definition"></a></dt>
<dd><p>The configuration is being applied to the service. This class attribute was
added in vSphere API 7.0.2.00100.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status.DEACTIVATED">
<code class="sig-name descname"><span class="pre">DEACTIVATED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='DEACTIVATED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status.DEACTIVATED" title="Permalink to this definition"></a></dt>
<dd><p>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 &gt; RUNNING &gt; REMOVING &gt;
DEACTIVATED 2. CONFIGURING &gt; REMOVING &gt; DEACTIVATED. This class
attribute was added in vSphere API 7.0.2.00100.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>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 &gt; ERROR 2. CONFIGURING &gt; RUNNING
&gt; ERROR 3. CONFIGURING &gt; RUNNING &gt; REMOVING &gt; ERROR 4. CONFIGURING
&gt; REMOVING &gt; ERROR The <code class="xref py py-attr docutils literal notranslate"><span class="pre">NamespaceSelfService.Info.messages</span></code> field
captures the relevant error messages explaining this ERROR status. This
class attribute was added in vSphere API 7.0.2.00100.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status.REMOVING">
<code class="sig-name descname"><span class="pre">REMOVING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='REMOVING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status.REMOVING" title="Permalink to this definition"></a></dt>
<dd><p>The configuration is being removed and service is being deleted. The
expected transitions: 1. CONFIGURING &gt; RUNNING &gt; REMOVING 2.
CONFIGURING &gt; REMOVING. This class attribute was added in vSphere API
7.0.2.00100.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status.RUNNING">
<code class="sig-name descname"><span class="pre">RUNNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='RUNNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status.RUNNING" title="Permalink to this definition"></a></dt>
<dd><p>The namespace self service is configured correctly. The expected
transitions: 1. CONFIGURING &gt; RUNNING 2. RUNNING &gt; 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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capability</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NamespaceSelfService.Summary</span></code> class contains basic information about
the namespace service. This class was added in vSphere API 7.0.2.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>capability</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability" title="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceSelfService.Capability</span></code></a>) The self-service namespace capability of the cluster with vSphere
Namespaces enabled. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status" title="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceSelfService.Status</span></code></a>) The current status of the namespace-self-service. This attribute
was added in vSphere API 7.0.2.00100.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.activate">
<code class="sig-name descname"><span class="pre">activate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.activate" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster on which vSphere Namespaces will be
enabled.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if the cluster already has Namespace Self Service activated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if cluster with vSphere Namespaces enabled could not be located or
no namespace templates exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
if the specified cluster is not licensed.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.SelfServiceManage privilege.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the service is marked for deactivation or the associated cluster
is being disabled or no namespace template exists in the system.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.activate_with_template">
<code class="sig-name descname"><span class="pre">activate_with_template</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.activate_with_template" title="Permalink to this definition"></a></dt>
<dd><p>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 templates 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster on which vSphere Namespaces will be
enabled.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.ActivateTemplateSpec" title="com.vmware.vcenter.namespaces_client.NamespaceSelfService.ActivateTemplateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceSelfService.ActivateTemplateSpec</span></code></a>) Specification for activating namespace self service on the cluster
by granting users/groups to create Supervisor Namespaces.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if the cluster already has Namespace Self Service activated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if cluster with vSphere Namespaces enabled could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contain any errors.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
if the specified cluster is not licensed.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.SelfServiceManage privilege.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the service is marked for deactivation or the associated cluster
is being disabled.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.deactivate">
<code class="sig-name descname"><span class="pre">deactivate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.deactivate" title="Permalink to this definition"></a></dt>
<dd><p>Deactivate Namespace Self Service on the cluster on which vSphere
Namespaces enabled. This operation reverses Dev Users/Groups
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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster for which vSphere Namespaces will be
disabled.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if cluster with vSphere Namespaced enabled is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.SelfServiceManage privilege.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the service is not activated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.get" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster on which vSphere Namespaces are enabled.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Info" title="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceSelfService.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the namespace self service associated with the
specified cluster.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if cluster with vSphere Namespaced enabled could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceSelfService.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.list" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.list" title="com.vmware.vcenter.namespaces_client.NamespaceSelfService.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Summary" title="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceSelfService.Summary</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of summary of Namespace Self Service associated with all
clusters with vSphere Namespaces enabled.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceTemplates">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespaces_client.</span></code><code class="sig-name descname"><span class="pre">NamespaceTemplates</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NamespaceTemplates</span></code> class provides methods to create and update
namespace templates on a cluster. The namespace templates are used if the
<code class="docutils literal notranslate"><span class="pre">NamespaceSelfService</span></code> is enabled on a Supervisor. This class was added
in vSphere API 7.0.2.00100.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceTemplates.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_specs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">networks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_service_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NamespaceTemplates.CreateSpec</span></code> class contains the specification
required to create namespace template. This class was added in vSphere API
7.0.2.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>template</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the namespace template. This has DNS_LABEL
restrictions as specified in `
&lt;<a class="reference external" href="https://tools.ietf.org/html/rfc1123">https://tools.ietf.org/html/rfc1123</a>&gt;`_. 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>resource_spec</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code>) 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 <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1" title="com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1</span></code></a>. This
attribute was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>storage_specs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec" title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.StorageSpec</span></code></a>) 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.</p></li>
<li><p><strong>networks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Networks.Info</span></code> 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>. When methods
return a value of this class as a return value, the attribute will
contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>.
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 clusters Supervisor Primary
Workload Network. The field currently accepts at most only 1
vSphere Namespaces network object reference.</p></li>
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.Subject" title="com.vmware.vcenter.namespaces_client.NamespaceTemplates.Subject"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceTemplates.Subject</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>vm_service_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec" title="com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.VMServiceSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
the <code class="xref py py-attr docutils literal notranslate"><span class="pre">NamespaceTemplates.CreateSpec.vm_service_spec</span></code> 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 Content Libraries by
default.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceTemplates.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_specs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">networks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_service_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NamespaceTemplates.Info</span></code> class contains the detailed information
about the namespace template. This class was added in vSphere API
7.0.2.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>template</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.NamespaceTemplate</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.NamespaceTemplate</span></code>.</p></li>
<li><p><strong>resource_spec</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>storage_specs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec" title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.StorageSpec</span></code></a>) 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.</p></li>
<li><p><strong>networks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>. When methods
return a value of this class as a return value, the attribute will
contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>.
This field is None if the cluster hosting this namespace uses
NSXT_CONTAINER_PLUGIN as its network provider.</p></li>
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.Subject" title="com.vmware.vcenter.namespaces_client.NamespaceTemplates.Subject"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceTemplates.Subject</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>vm_service_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec" title="com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.VMServiceSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceTemplates.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.namespaces.NamespaceTemplate'</span></em><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>The resource type for namespace template. This class attribute was added in
vSphere API 7.0.2.00100.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceTemplates.Subject">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Subject</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subject_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.Subject" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NamespaceTemplates.Subject</span></code> class contains the user or group
information granted for namespace self service. This class was added in
vSphere API 7.0.2.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>subject_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Access.SubjectType" title="com.vmware.vcenter.namespaces_client.Access.SubjectType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Access.SubjectType</span></code></a>) Type of the subject. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>subject</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the subject. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Domain of the subject. This attribute was added in vSphere API
7.0.2.00100.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceTemplates.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NamespaceTemplates.Summary</span></code> class contains the basic information
about the namespace template. This class was added in vSphere API
7.0.2.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>template</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.NamespaceTemplate</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.NamespaceTemplate</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceTemplates.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resource_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_specs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">networks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">permissions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_service_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NamespaceTemplates.UpdateSpec</span></code> class contains the specification
required to update a namespace namespace template. This class was added in
vSphere API 7.0.2.00100.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>resource_spec</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1" title="com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1</span></code></a>. This
attribute was added in vSphere API 7.0.2.00100.
If None, no resource limits will be set on the namespace.</p></li>
<li><p><strong>storage_specs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec" title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.StorageSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>networks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) vSphere Namespaces network objects to be associated with the
namespace. The values of this list need to reference names of
pre-existing
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Networks.Info</span></code> 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>. When methods
return a value of this class as a return value, the attribute will
contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.Network</span></code>.
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 clusters Supervisor Primary
Workload Network. The field currently accepts at most only 1
vSphere Namespaces network object reference.</p></li>
<li><p><strong>permissions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.Subject" title="com.vmware.vcenter.namespaces_client.NamespaceTemplates.Subject"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceTemplates.Subject</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>vm_service_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec" title="com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Instances.VMServiceSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">NamespaceTemplates.UpdateSpec.vm_service_spec</span></code>. This
attribute was added in vSphere API 7.0.3.2.
If None, the virtual machine classes and Content Library
associations of the template will not be modified.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceTemplates.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.create" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster on which vSphere Namespaces are enabled.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.CreateSpec" title="com.vmware.vcenter.namespaces_client.NamespaceTemplates.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceTemplates.CreateSpec</span></code></a>) Specification for setting up the namespace template.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">cluster</span></code> doesnt exist.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> 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 as
its network provider.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if a request arrives to create a second template.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.SelfServiceManage privilege.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if the namespace template with given name already exists.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceTemplates.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.get" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster on which vSphere Namespaces are enabled.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>template</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the namespace template.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.NamespaceTemplate</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.Info" title="com.vmware.vcenter.namespaces_client.NamespaceTemplates.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceTemplates.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the namespace template.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">cluster</span></code> doesnt exist or if <code class="docutils literal notranslate"><span class="pre">template</span></code> doesnt exist.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceTemplates.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.list" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for the cluster on which vSphere Namespaces are enabled.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.list" title="com.vmware.vcenter.namespaces_client.NamespaceTemplates.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.Summary" title="com.vmware.vcenter.namespaces_client.NamespaceTemplates.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceTemplates.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of summary of all namespace templates associated with
<code class="docutils literal notranslate"><span class="pre">cluster</span></code> with vSphere Namespaces enabled.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">cluster</span></code> doesnt exist.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespaces_client.NamespaceTemplates.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.update" title="Permalink to this definition"></a></dt>
<dd><p>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 <code class="docutils literal notranslate"><span class="pre">spec</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier for cluster on which vSphere Namespaces are enabled.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>template</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the namespace template.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.NamespaceTemplate</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.UpdateSpec" title="com.vmware.vcenter.namespaces_client.NamespaceTemplates.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamespaceTemplates.UpdateSpec</span></code></a>) Specification for updating the namespace template.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">cluster</span></code> doesnt exist or if <code class="docutils literal notranslate"><span class="pre">template</span></code> doesnt exist.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contain any errors.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.SelfServiceManage privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespaces_client.</span></code><code class="sig-name descname"><span class="pre">ResourceQuotaOptionsV1</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">memory_limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_limit_default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_request_default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_limit_default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_request_default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_request_limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pod_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deployment_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">daemon_set_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replica_set_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replication_controller_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stateful_set_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_map_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">secret_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persistent_volume_claim_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">job_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1</span></code> class represents the resource quota limits
which can be applied on the namespace. Refer to `
&lt;<a class="reference external" href="https://kubernetes.io/docs/concepts/policy/resource-quotas">https://kubernetes.io/docs/concepts/policy/resource-quotas</a>&gt;`_ for
information related to the properties of this object and what they map to.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>memory_limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>memory_limit_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This 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.
&lt;<a class="reference external" href="https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/memory-default-namespace/">https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/memory-default-namespace/</a>&gt;`_
If None, no default memory limits are set on containers in the pod.</p></li>
<li><p><strong>memory_request_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This 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.
&lt;<a class="reference external" href="https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/memory-default-namespace/">https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/memory-default-namespace/</a>&gt;`_
If None, no default memory requests are set on containers in the
pod.</p></li>
<li><p><strong>cpu_limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>cpu_limit_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This 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.
&lt;<a class="reference external" href="https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/memory-default-namespace/">https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/memory-default-namespace/</a>&gt;`_</p></li>
<li><p><strong>cpu_request_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This 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.
&lt;<a class="reference external" href="https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/cpu-default-namespace/">https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/cpu-default-namespace/</a>&gt;`_</p></li>
<li><p><strong>storage_request_limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>pod_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This 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.</p></li>
<li><p><strong>service_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents count/services option which is the maximum number
of services in the namespace.
If None, no service limits are set on the namespace.</p></li>
<li><p><strong>deployment_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This 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.</p></li>
<li><p><strong>daemon_set_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This 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.</p></li>
<li><p><strong>replica_set_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This 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.</p></li>
<li><p><strong>replication_controller_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents count/replicationcontrollers option which is the
maximum number of ReplicationControllers in the namespace.
If None, no replicationcontroller limits are set on the namespace.</p></li>
<li><p><strong>stateful_set_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This 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.</p></li>
<li><p><strong>config_map_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents count/configmaps option which is the maximum
number of ConfigMaps in the namespace.
If None, no configmap limits are set on the namespace.</p></li>
<li><p><strong>secret_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents count/secrets option which is the maximum number
of secrets in the namespace.
If None, no secret limits are set on the namespace.</p></li>
<li><p><strong>persistent_volume_claim_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents count/persistentvolumeclaims option which is the
maximum number of PersistentVolumeClaims in the namespace.
If None, no persistentvolumeclaim limits are set on the namespace.</p></li>
<li><p><strong>job_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents count/jobs.batch option which is the maximum
number jobs in the namespace.
If None, no job limits are set on the namespace.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1Update">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespaces_client.</span></code><code class="sig-name descname"><span class="pre">ResourceQuotaOptionsV1Update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">memory_limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_limit_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_limit_default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_limit_default_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_request_default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_request_default_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_limit_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_limit_default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_limit_default_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_request_default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_request_default_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_request_limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_request_limit_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pod_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pod_count_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service_count_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span cla
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update</span></code> class represents the changes to
resource quota limits which are set on the namespace. Refer to ` &lt;&gt;
Kubernetes Resource Quota
&lt;<a class="reference external" href="https://kubernetes.io/docs/concepts/policy/resource-quotas">https://kubernetes.io/docs/concepts/policy/resource-quotas</a>&gt;`_ for
information related to the properties of this object and what they map to.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>memory_limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_limit_unset</span></code> is set to
<code class="docutils literal notranslate"><span class="pre">true</span></code>.
If None, the existing memory limit on the ResourcePool will be
unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_limit_unset</span></code> is None or
set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>memory_limit_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_limit</span></code>. If this field is
set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing memory limit on the ResourcePool is
removed. If this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing memory
limit will be changed to the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_limit</span></code>, if any.
If None, the existing memory limit will be changed to the value
specified in <code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_limit</span></code>, if
any.</p></li>
<li><p><strong>memory_limit_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the new value for the default memory limit (in
mebibytes) for containers in the pod. This field is ignored if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_limit_default_unset</span></code> is
set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.
If None, the existing memory limit will be unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_limit_default_unset</span></code> is
None or set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>memory_limit_default_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_limit_default</span></code>. If this
field is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing default memory limit on
containers in the pod is removed. If this field is set to
<code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing default memory limit will be changed to the
value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_limit_default</span></code>, if any.
If None, the existing default memory limit will be changed to the
value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_limit_default</span></code>, if any.</p></li>
<li><p><strong>memory_request_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the new value for the default memory request (in
mebibytes) for containers in the pod. This field is ignored if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_request_default_unset</span></code>
is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.
If None, the existing memory request will be unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_request_default_unset</span></code>
is None or set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>memory_request_default_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_request_default</span></code>. If
this field is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing default memory request
on containers in the pod will be removed. If this field is set to
<code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing default memory request will be changed to
the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_request_default</span></code>, if
any.
If None, the existing default memory request will be changed to the
value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_request_default</span></code>, if
any.</p></li>
<li><p><strong>cpu_limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.cpu_limit_unset</span></code> is set to
<code class="docutils literal notranslate"><span class="pre">true</span></code>. If specified, this limit should be at least 10 MHz.
If None, the existing CPU limit on the ResourcePool will be
unchanged if <code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.cpu_limit_unset</span></code>
is None or set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>cpu_limit_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.cpu_limit</span></code>. If this field is
set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing CPU limit on the ResourcePool is
removed. If this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing CPU limit
will be changed to the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.cpu_limit</span></code>, if any.
If None, the existing CPU limit will be changed to the value
specified in <code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.memory_limit</span></code>, if
any.</p></li>
<li><p><strong>cpu_limit_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the new value for the default CPU limit (in Mhz)
for containers in the pod. This field is ignored if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.cpu_limit_default_unset</span></code> is set
to <code class="docutils literal notranslate"><span class="pre">true</span></code>. If specified, this limit should be at least 10 MHz.
If None, the existing default CPU limit will be unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.cpu_limit_default_unset</span></code> is
None or set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>cpu_limit_default_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.cpu_limit_default</span></code>. If this
field is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing default CPU limit on
containers in the pod is removed. If this field is set to
<code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing default CPU limit will be changed to the
value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.cpu_limit_default</span></code>, if any.
If None, the existing default CPU limit will be changed to the
value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.cpu_limit_default</span></code>, if any.</p></li>
<li><p><strong>cpu_request_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the new value for the default CPU request (in Mhz)
for containers in the pod. This field is ignored if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.cpu_request_default_unset</span></code> is
set to <code class="docutils literal notranslate"><span class="pre">true</span></code>. If specified, this field should be at least 10
MHz.
If None, the existing default CPU request will be unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.cpu_request_default_unset</span></code> is
None or set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>cpu_request_default_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.cpu_request_default</span></code>. If this
field is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing default CPU request on
containers in the pod is removed. If this field is set to
<code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing default CPU request will be changed to the
value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.cpu_request_default</span></code>, if any.
If None, the existing default CPU request will be changed to the
value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.cpu_request_default</span></code>, if any.</p></li>
<li><p><strong>storage_request_limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.storage_request_limit_unset</span></code>
is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.
If None, the existing storage request limit will be unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.storage_request_limit_unset</span></code> is
None or set to <code class="docutils literal notranslate"><span class="pre">false</span></code>. the namespace.</p></li>
<li><p><strong>storage_request_limit_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.storage_request_limit</span></code>. If this
field is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing storage request limit will
be reset. If this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing storage
request limit will be changed to the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.storage_request_limit</span></code>, if any.
If None, the existing storage request limit will be changed to the
value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.storage_request_limit</span></code>, if any.</p></li>
<li><p><strong>pod_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the new value for podCount option which is the
maximum number of pods in the namespace. This field is ignored if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.pod_count_unset</span></code> is set to
<code class="docutils literal notranslate"><span class="pre">true</span></code>.
If None, the existing podCount limit will be unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.pod_count_unset</span></code> is None or set
to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>pod_count_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.pod_count</span></code>. If this field is
set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing podCount limit on the namespace
will be reset. If this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing CPU
limit will be changed to the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.pod_count</span></code>, if any.
If None, the existing podCount limit will be changed to the value
specified in <code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.pod_count</span></code>, if
any.</p></li>
<li><p><strong>service_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the new value for serviceCount option which is
the maximum number of services in the namespace. This field is
ignored if <code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.service_count_unset</span></code>
is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.
If None, the existing serviceCount limit will be unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.service_count_unset</span></code> is None or
set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>service_count_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.service_count</span></code>. If this field
is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing serviceCount limit on the
namespace will be reset. If this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the
existing service count limit will be changed to the value specified
in <code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.service_count</span></code>, if any.
If None, the existing serviceCount limit will be changed to the
value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.service_count</span></code>, if any.</p></li>
<li><p><strong>deployment_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the new value for deploymentCount option which is
the maximum number of deployments in the namespace. This field is
ignored if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.deployment_count_unset</span></code> is set
to <code class="docutils literal notranslate"><span class="pre">true</span></code>.
If None, the existing deploymentCount limit will be unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.deployment_count_unset</span></code> is None
or set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>deployment_count_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.deployment_count</span></code>. If this
field is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing deploymentCount limit on
the namespace will be reset. If this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the
existing deployment count limit will be changed to the value
specified in <code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.deployment_count</span></code>,
if any.
If None, the existing deploymentCount limit will be changed to
the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.deployment_count</span></code>, if any.</p></li>
<li><p><strong>daemon_set_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the new value for daemonSetCount option which is
the maximum number of DaemonSets in the namespace. This field is
ignored if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.daemon_set_count_unset</span></code> is set
to <code class="docutils literal notranslate"><span class="pre">true</span></code>.
If None, the existing daemonSetCount limit will be unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.daemon_set_count_unset</span></code> is None
or set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>daemon_set_count_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.daemon_set_count</span></code>. If this
field is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing daemonSetCount limit on
the namespace will be reset. If this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the
existing daemonset count limit will be changed to the value
specified in <code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.daemon_set_count</span></code>,
if any.
If None, the existing daemonSetCount limit will be changed to the
value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.daemon_set_count</span></code>, if any.</p></li>
<li><p><strong>replica_set_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the new value for replicaSetCount option which is
the maximum number of ReplicaSets in the namespace. This field is
ignored if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.replica_set_count_unset</span></code> is set
to <code class="docutils literal notranslate"><span class="pre">true</span></code>.
If None, the existing replicaSetCount limit will be unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.replica_set_count_unset</span></code> is
None or set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>replica_set_count_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.replica_set_count</span></code>. If this
field is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing replicaSetCount limit on
the namespace will be reset. If this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the
existing replicaset count limit will be changed to the value
specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.replica_set_count</span></code>, if any.
If None, the existing replicaSetCount limit will be changed to
the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.replica_set_count</span></code>, if any.</p></li>
<li><p><strong>replication_controller_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the new value for replicationControllerCount
option which is the maximum number of ReplicationControllers in the
namespace. This field is ignored if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.replication_controller_count_unset</span></code>
is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.
If None, the existing replicationControllerCount limit will be
unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.replication_controller_count_unset</span></code>
is None or set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>replication_controller_count_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.replication_controller_count</span></code>.
If this field is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing
replicationControllerCount limit on the namespace will be reset.
If this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing
replicationcontroller count limit will be changed to the value
specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.replication_controller_count</span></code>,
if any.
If None, the existing replicationControllerCount limit will be
changed to the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.replication_controller_count</span></code>,
if any.</p></li>
<li><p><strong>stateful_set_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the new value for statefulSetCount option which
is the maximum number of StatefulSets in the namespace. This field
is ignored if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.stateful_set_count_unset</span></code> is
set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.
If None, the existing statefulSetCount limit will be unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.stateful_set_count_unset</span></code> is
None or set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>stateful_set_count_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.stateful_set_count</span></code>. If this
field is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing statefulSetCount limit on
the namespace will be reset. If this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the
existing statefulset count limit will be changed to the value
specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.stateful_set_count</span></code>, if any.
If None, the existing statefulSetCount limit will be changed to
the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.stateful_set_count</span></code>, if any.</p></li>
<li><p><strong>config_map_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the new value for configMapCount option which is
the maximum number of ConfigMaps in the namespace. This field is
ignored if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.config_map_count_unset</span></code> is set
to <code class="docutils literal notranslate"><span class="pre">true</span></code>.
If None, the existing configMapCount limit will be unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.config_map_count_unset</span></code> is None
or set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>config_map_count_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.config_map_count</span></code>. If this
field is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing configMapCount limit on
the namespace will be reset. If this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the
existing configmap count limit will be changed to the value
specified in <code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.config_map_count</span></code>,
if any.
If None, the existing configMapCount limit will be changed to the
value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.config_map_count</span></code>, if any.</p></li>
<li><p><strong>secret_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the new value for secretCount option which is the
maximum number of secrets in the namespace. This field is ignored
if <code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.secret_count_unset</span></code> is set
to <code class="docutils literal notranslate"><span class="pre">true</span></code>.
If None, the existing secretCount limit will be unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.secret_count_unset</span></code> is None or
set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>secret_count_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.secret_count</span></code>. If this field is
set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing secretCount limit on the namespace
will be reset. If this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing
secret count limit will be changed to the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.secret_count</span></code>, if any.
If None, the existing secretCount limit will be changed to the
value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.secret_count</span></code>, if any.</p></li>
<li><p><strong>persistent_volume_claim_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the new value for persistentVolumeClaimCount
option which is the maximum number of PersistentVolumeClaims in the
namespace. This field is ignored if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.persistent_volume_claim_count_unset</span></code>
is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.
If None, the existing persistentVolumeClaimCount limit will be
unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.persistent_volume_claim_count_unset</span></code>
is None or set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>persistent_volume_claim_count_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.persistent_volume_claim_count</span></code>.
If this field is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing
persistentVolumeClaimCount limit on the namespace will be reset.
If this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing
replicationcontroller count limit will be changed to the value
specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.persistent_volume_claim_count</span></code>,
if any.
If None, the existing persistentVolumeClaimCount limit will be
changed to the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.persistent_volume_claim_count</span></code>,
if any.</p></li>
<li><p><strong>job_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the new value for jobCount option which is the
maximum number of jobs in the namespace. This field is ignored if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.job_count_unset</span></code> is set to
<code class="docutils literal notranslate"><span class="pre">true</span></code>.
If None, the existing jobCount limit will be unchanged if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.job_count_unset</span></code> is None or set
to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p><strong>job_count_unset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) This represents the intent of the change to
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.job_count</span></code>. If this field is
set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the existing jobCount limit on the namespace
will be reset. If this field is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the existing
secret count limit will be changed to the value specified in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.job_count</span></code>, if any.
If None, the existing jobCount limit will be changed to the value
specified in <code class="xref py py-attr docutils literal notranslate"><span class="pre">ResourceQuotaOptionsV1Update.job_count</span></code>, if
any.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespaces_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespaces_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespaces_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.ovf_client">
<span id="com-vmware-vcenter-ovf-client-module"></span><h2>com.vmware.vcenter.ovf_client module<a class="headerlink" href="#module-com.vmware.vcenter.ovf_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.ovf_client</span></code> module provides services to capture and
deploy Open Virtualization Format (OVF) packages to and from the content
library.</p>
<p>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.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.CertificateParams">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">CertificateParams</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">issuer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_valid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_self_signed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x509</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">warnings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.CertificateParams" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CertificateParams</span></code> 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.</p>
<blockquote>
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
</div></blockquote>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>issuer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>subject</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>is_valid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) 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.</p></li>
<li><p><strong>is_self_signed</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) 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.</p></li>
<li><p><strong>x509</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.WarningInfo" title="com.vmware.vcenter.ovf_client.WarningInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">WarningInfo</span></code></a>) 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
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>. When the attribute is set, the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">WarningInfo.ignored</span></code> attribute can be updated before the OVF
parameter is passed to <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> to deploy the OVF
package.</p></li>
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.DeploymentOption">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">DeploymentOption</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_choice</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.DeploymentOption" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DeploymentOption</span></code> class contains the information about a deployment
option as defined in the OVF specification.</p>
<p>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.</p>
<blockquote>
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
</div></blockquote>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>default_choice</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) A <code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.DeploymentOptionParams">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">DeploymentOptionParams</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deployment_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">selected_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.DeploymentOptionParams" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DeploymentOptionParams</span></code> class describes the possible deployment
options as well as the choice provided by the user.</p>
<blockquote>
<div><p>This information based on the ovf:DeploymentOptionSection.</p>
<p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
</div></blockquote>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>deployment_options</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.DeploymentOption" title="com.vmware.vcenter.ovf_client.DeploymentOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeploymentOption</span></code></a>) <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> 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.</p></li>
<li><p><strong>selected_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The selected deployment option. Identifies the
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.DeploymentOption" title="com.vmware.vcenter.ovf_client.DeploymentOption"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeploymentOption</span></code></a> in the list in the <code class="docutils literal notranslate"><span class="pre">deploymentOptions</span></code>
attribute with a matching value in the <code class="xref py py-attr docutils literal notranslate"><span class="pre">DeploymentOption.key</span></code>
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 its the first one in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">DeploymentOptionParams.deployment_options</span></code> <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>.
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.</p></li>
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.DiskProvisioningType">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">DiskProvisioningType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DiskProvisioningType</span></code> class defines the virtual disk provisioning
types that can be set for a disk on the target platform.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType" title="com.vmware.vcenter.ovf_client.DiskProvisioningType"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiskProvisioningType</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.DiskProvisioningType.eagerZeroedThick">
<code class="sig-name descname"><span class="pre">eagerZeroedThick</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DiskProvisioningType(string='eagerZeroedThick')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType.eagerZeroedThick" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
<p>Disks specified as eager zeroed thick may take longer time to create than
disks specified with the other disk provisioning types.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.DiskProvisioningType.thick">
<code class="sig-name descname"><span class="pre">thick</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DiskProvisioningType(string='thick')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType.thick" title="Permalink to this definition"></a></dt>
<dd><p>A thick provisioned virtual disk has all space allocated at creation time
and the space is zeroed on demand as the space is used.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.DiskProvisioningType.thin">
<code class="sig-name descname"><span class="pre">thin</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DiskProvisioningType(string='thin')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType.thin" title="Permalink to this definition"></a></dt>
<dd><p>A thin provisioned virtual disk has space allocated and zeroed on demand as
the space is used.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.ExportFlag">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">ExportFlag</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ExportFlag" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ExportFlag</span></code> class provides methods for retrieving information about
the export flags supported by the server. Export flags can be specified in
a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.CreateSpec</span></code></a> to customize an OVF export.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.ExportFlag.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">option</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ExportFlag.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ExportFlag.Info</span></code> class describes an export flag supported by the
server.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>option</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of the export flag that is supported by the server.</p></li>
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) Localizable description of the export flag.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.ovf_client.ExportFlag.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ExportFlag.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about the supported export flags by the server.</p>
<blockquote>
<div><p>The supported flags are:</p>
</div></blockquote>
<dl>
<dt>PRESERVE_MAC</dt><dd><p>Include MAC addresses for network adapters.</p>
</dd>
<dt>EXTRA_CONFIG</dt><dd><blockquote>
<div><p>Include extra configuration in OVF export.</p>
</div></blockquote>
<p>Future server versions might support additional flags.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExportFlag.list" title="com.vmware.vcenter.ovf_client.ExportFlag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExportFlag.Info" title="com.vmware.vcenter.ovf_client.ExportFlag.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExportFlag.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExportFlag.list" title="com.vmware.vcenter.ovf_client.ExportFlag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of supported export flags.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.ExtraConfig">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">ExtraConfig</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">virtual_system_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ExtraConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ExtraConfig</span></code> class contains the information about a vmw:ExtraConfig
element which can be used to specify configuration settings that are
transferred directly to the <code class="docutils literal notranslate"><span class="pre">.vmx</span></code> file. The behavior of the
vmw:ExtraConfig element is similar to the <code class="docutils literal notranslate"><span class="pre">extraConfig</span></code> property of the
<code class="docutils literal notranslate"><span class="pre">VirtualMachineConfigSpec</span></code> 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 <code class="docutils literal notranslate"><span class="pre">VirtualMachineConfigSpec</span></code> object.
See the VMware vSphere API reference for details on this.</p>
<p>vmw:ExtraConfig elements may occur as direct child elements of a
VirtualHardwareSection, or as child elements of individual virtual hardware
items.</p>
<blockquote>
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
</div></blockquote>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>virtual_system_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.ExtraConfigParams">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">ExtraConfigParams</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extra_configs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_keys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_keys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ExtraConfigParams" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ExtraConfigParams</span></code> class contains the parameters with information
about the vmw:ExtraConfig elements in an OVF package.</p>
<p>vmw:ExtraConfig elements can be used to specify configuration settings that
are transferred directly to the <code class="docutils literal notranslate"><span class="pre">.vmx</span></code> file.</p>
<p>The behavior of the vmw:ExtraConfig element is similar to the
<code class="docutils literal notranslate"><span class="pre">extraConfig</span></code> property of the <code class="docutils literal notranslate"><span class="pre">VirtualMachineConfigSpec</span></code> 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
<code class="docutils literal notranslate"><span class="pre">VirtualMachineConfigSpec</span></code> object. See the VMware vSphere API reference
for details on this.</p>
<blockquote>
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
</div></blockquote>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>extra_configs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExtraConfig" title="com.vmware.vcenter.ovf_client.ExtraConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExtraConfig</span></code></a>) <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> 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 <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> if there are no extra
configuration elements in the OVF package.</p></li>
<li><p><strong>exclude_keys</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) <p>Specifies which extra configuration items in the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> in
the <code class="docutils literal notranslate"><span class="pre">extraConfigs</span></code> <code class="docutils literal notranslate"><span class="pre">field</span></code> should be ignored during deployment.</p>
<p>If set, the given keys for extra configurations will be ignored
during deployment. The key is defined in the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExtraConfig.key</span></code> attribute.
This attribute is optional in the input parameters when deploying
an OVF package. It is an error to set both this and
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExtraConfigParams.include_keys</span></code>. This attribute is optional
in the result when retrieving information about an OVF package. It
is an error to set both this and
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExtraConfigParams.include_keys</span></code>.</p>
</p></li>
<li><p><strong>include_keys</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) <p>Specifies which extra configuration items in the <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> in
the <code class="docutils literal notranslate"><span class="pre">extraConfigs</span></code> <code class="docutils literal notranslate"><span class="pre">field</span></code> should be included during
deployment.</p>
<p>If set, all but the given keys for extra configurations will be
ignored during deployment. The key is defined in the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExtraConfig.key</span></code> attribute.
This attribute is optional in the input parameters when deploying
an OVF package. It is an error to set both this and
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExtraConfigParams.exclude_keys</span></code>. This attribute is optional
in the result when retrieving information about an OVF package. It
is an error to set both this and
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ExtraConfigParams.exclude_keys</span></code>.</p>
</p></li>
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.ImportFlag">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">ImportFlag</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ImportFlag" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ImportFlag</span></code> class provides methods for retrieving information about
the import flags supported by the deployment platform. Import flags can be
specified in a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a> to customize
an OVF deployment.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.ImportFlag.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">option</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ImportFlag.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ImportFlag.Info</span></code> class describes an import flag supported by the
deployment platform.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>option</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of the import flag that is supported by the deployment
platform.</p></li>
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) Localizable description of the import flag.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.ovf_client.ImportFlag.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ImportFlag.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about the import flags supported by the deployment
platform.</p>
<blockquote>
<div><p>The supported flags are:</p>
</div></blockquote>
<dl>
<dt>LAX</dt><dd><blockquote>
<div><p>Lax mode parsing of the OVF descriptor.</p>
</div></blockquote>
<p>Future server versions might support additional flags.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>rp</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The identifier of resource pool target for retrieving the import
flag(s).
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.ImportFlag.list" title="com.vmware.vcenter.ovf_client.ImportFlag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ImportFlag.Info" title="com.vmware.vcenter.ovf_client.ImportFlag.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImportFlag.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ImportFlag.list" title="com.vmware.vcenter.ovf_client.ImportFlag.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of supported import flags.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If the resource pool associated with <code class="docutils literal notranslate"><span class="pre">rp</span></code> does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">rp</span></code>
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">IpAllocationParams</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supported_allocation_scheme</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">supported_ip_allocation_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_allocation_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">supported_ip_protocol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip_protocol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">IpAllocationParams</span></code> 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.</p>
<p>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.</p>
<p>The settings in <code class="docutils literal notranslate"><span class="pre">IpAllocationParams</span></code> 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.</p>
<blockquote>
<div><p>This information is based on the vmw:IpAssignmentSection in OVF package.</p>
<p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
</div></blockquote>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supported_allocation_scheme</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme" title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpAllocationParams.IpAllocationScheme</span></code></a>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">IpAllocationParams.ip_allocation_policy</span></code>.
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.</p></li>
<li><p><strong>supported_ip_allocation_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy" title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpAllocationParams.IpAllocationPolicy</span></code></a>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">IpAllocationParams.supported_allocation_scheme</span></code> 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.</p></li>
<li><p><strong>ip_allocation_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy" title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpAllocationParams.IpAllocationPolicy</span></code></a>) 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.</p></li>
<li><p><strong>supported_ip_protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol" title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpAllocationParams.IpProtocol</span></code></a>) 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.</p></li>
<li><p><strong>ip_protocol</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol" title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpAllocationParams.IpProtocol</span></code></a>) Specifies the chosen IP protocol for this deployment. This must be
one of the IP protocols supported by the guest software. See
<code class="xref py py-attr docutils literal notranslate"><span class="pre">IpAllocationParams.supported_ip_protocol</span></code>.
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.</p></li>
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">IpAllocationPolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">IpAllocationParams.IpAllocationPolicy</span></code> class defines the possible IP
allocation policy for a deployment.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">IpAllocationPolicy</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.DHCP">
<code class="sig-name descname"><span class="pre">DHCP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAllocationPolicy(string='DHCP')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.DHCP" title="Permalink to this definition"></a></dt>
<dd><p>Specifies that DHCP will be used to allocate IP addresses.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.STATIC_IPPOOL">
<code class="sig-name descname"><span class="pre">STATIC_IPPOOL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAllocationPolicy(string='STATIC_IPPOOL')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.STATIC_IPPOOL" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.STATIC_MANUAL">
<code class="sig-name descname"><span class="pre">STATIC_MANUAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAllocationPolicy(string='STATIC_MANUAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.STATIC_MANUAL" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.TRANSIENT_IPPOOL">
<code class="sig-name descname"><span class="pre">TRANSIENT_IPPOOL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAllocationPolicy(string='TRANSIENT_IPPOOL')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.TRANSIENT_IPPOOL" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">IpAllocationScheme</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">IpAllocationParams.IpAllocationScheme</span></code> class defines the possible IP
allocation schemes that can be supported by the guest software.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">IpAllocationScheme</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme.DHCP">
<code class="sig-name descname"><span class="pre">DHCP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAllocationScheme(string='DHCP')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme.DHCP" title="Permalink to this definition"></a></dt>
<dd><p>It supports DHCP to acquire IP configuration.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme.OVF_ENVIRONMENT">
<code class="sig-name descname"><span class="pre">OVF_ENVIRONMENT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpAllocationScheme(string='OVF_ENVIRONMENT')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme.OVF_ENVIRONMENT" title="Permalink to this definition"></a></dt>
<dd><p>It supports setting the IP configuration through the properties provided in
the OVF environment.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">IpProtocol</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">IpAllocationParams.IpProtocol</span></code> class defines the IP protocols
supported by the guest software.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">IpProtocol</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV4">
<code class="sig-name descname"><span class="pre">IPV4</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpProtocol(string='IPV4')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV4" title="Permalink to this definition"></a></dt>
<dd><p>It supports the IPv4 protocol.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV6">
<code class="sig-name descname"><span class="pre">IPV6</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpProtocol(string='IPV6')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV6" title="Permalink to this definition"></a></dt>
<dd><p>It supports the IPv6 protocol.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">LibraryItem</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem</span></code> 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.</p>
<blockquote>
<div><p>To deploy a virtual machine or a virtual appliance from a library item:</p>
</div></blockquote>
<ol class="arabic simple">
<li><p>Create a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget</span></code></a> to specify the target
deployment type and target deployment designation.</p></li>
<li><p>Create a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a> to specify the
parameters for the target deployment.</p></li>
<li><p>Use the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method with the created target and parameter
specifications, along with the identifier of the specified source content
library item. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a>.</p></li>
</ol>
<p>To create a library item in content library from a virtual machine or
virtual appliance:</p>
<ol class="arabic simple">
<li><p>Create a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity" title="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeployableIdentity</span></code></a> to specify the source
virtual machine or virtual appliance to be used as the OVF template source.</p></li>
<li><p>Create a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.CreateTarget</span></code></a> to specify the target library
and library item.</p></li>
<li><p>Create a <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.CreateSpec</span></code></a> to specify the settings for the
OVF package to be created.</p></li>
<li><p>Use the <code class="docutils literal notranslate"><span class="pre">create</span></code> method with the created target and parameter
specifications, along with the specified source entity. See
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.create" title="com.vmware.vcenter.ovf_client.LibraryItem.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.create()</span></code></a>.</p></li>
</ol>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.CreateResult">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">succeeded</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ovf_library_item_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.CreateResult</span></code> class defines the result of the <code class="docutils literal notranslate"><span class="pre">create</span></code>
method. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.create" title="com.vmware.vcenter.ovf_client.LibraryItem.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.create()</span></code></a>.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>succeeded</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Whether the <code class="docutils literal notranslate"><span class="pre">create</span></code> method completed successfully.</p></li>
<li><p><strong>ovf_library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.
If None, the <code class="docutils literal notranslate"><span class="pre">create</span></code> method failed and
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.CreateResult.error</span></code> will describe the error(s)
that caused the failure.</p></li>
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo" title="com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.ResultInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Errors, warnings, and informational messages produced by the
<code class="docutils literal notranslate"><span class="pre">create</span></code> method.
If None, no errors, warnings, or informational messages were
reported by the <code class="docutils literal notranslate"><span class="pre">create</span></code> method.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.CreateSpec</span></code> class defines the information used to create
or update a library item containing an OVF package.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Name to use in the OVF descriptor stored in the library item.
If None, the server will use sources current name.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Description to use in the OVF descriptor stored in the library
item.
If None, the server will use sources current annotation.</p></li>
<li><p><strong>flags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Flags to use for OVF package creation. The supported flags can be
obtained using <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExportFlag.list" title="com.vmware.vcenter.ovf_client.ExportFlag.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">ExportFlag.list()</span></code></a>.
If None, no flags will be used.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateTarget</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">library_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">library_item_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.CreateTarget</span></code> 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
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.create" title="com.vmware.vcenter.ovf_client.LibraryItem.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.create()</span></code></a>.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>library_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Identifier of the library in which a new library item should be
created. This attribute is not used if the <code class="docutils literal notranslate"><span class="pre">libraryItemId</span></code>
attribute is specified.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.
This attribute is currently required.</p>
<p>In the future, if None, the <code class="docutils literal notranslate"><span class="pre">libraryItemId</span></code> attribute must be
specified.</p>
</p></li>
<li><p><strong>library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.
If None, a new library item will be created. The <code class="docutils literal notranslate"><span class="pre">libraryId</span></code>
attribute must be specified if this attribute is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.DEPLOYABLE">
<code class="sig-name descname"><span class="pre">DEPLOYABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">['VirtualMachine',</span> <span class="pre">'VirtualApp']</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.DEPLOYABLE" title="Permalink to this definition"></a></dt>
<dd><p>The types of resources that can be created by deploying an OVF package and can
be captured to create a library item using the <code class="docutils literal notranslate"><span class="pre">LibraryItem</span></code> class.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DeployableIdentity</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.DeployableIdentity</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Type of the deployable resource.
When clients pass a value of this class as a parameter, the
attribute must be one of <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> or <code class="docutils literal notranslate"><span class="pre">VirtualApp</span></code>. When
methods return a value of this class as a return value, the
attribute will be one of <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> or <code class="docutils literal notranslate"><span class="pre">VirtualApp</span></code>.</p></li>
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">null</span></code> or <code class="docutils literal notranslate"><span class="pre">null</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for one of
these resource types: <code class="docutils literal notranslate"><span class="pre">null</span></code> or <code class="docutils literal notranslate"><span class="pre">null</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentResult">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DeploymentResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">succeeded</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.DeploymentResult</span></code> class defines the result of the
<code class="docutils literal notranslate"><span class="pre">deploy</span></code> method. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a>.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>succeeded</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Whether the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method completed successfully.</p></li>
<li><p><strong>resource_id</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity" title="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeployableIdentity</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Identifier of the deployed resource entity.
If None, the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method failed and
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentResult.error</span></code> will describe the
error(s) that caused the failure.</p></li>
<li><p><strong>error</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo" title="com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.ResultInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Errors, warnings, and informational messages produced by the
<code class="docutils literal notranslate"><span class="pre">deploy</span></code> method.
If None, no errors, warnings, or informational messages were
reported by the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DeploymentTarget</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resource_pool_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget</span></code> class describes the location (target)
where a virtual machine or virtual appliance should be deployed. It is used
in the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> and <code class="docutils literal notranslate"><span class="pre">filter</span></code> methods. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a>
and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>resource_pool_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.</p></li>
<li><p><strong>host_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget.resource_pool_id</span></code>.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
If None, the server will automatically select a target host from
the resource pool if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget.resource_pool_id</span></code> is a
stand-alone host or a cluster with Distributed Resource Scheduling
(DRS) enabled.</p></li>
<li><p><strong>folder_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
If None, the server will choose the deployment folder.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.OvfSummary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">OvfSummary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eulas</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">networks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_groups</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.OvfSummary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.OvfSummary</span></code> class defines the result of the <code class="docutils literal notranslate"><span class="pre">filter</span></code>
method. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>. The attributes in the class
describe parameterizable information in the OVF descriptor, with respect to
a deployment target, for the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method. See
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a>.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Default name for the virtual machine or virtual appliance.
If None, the OVF descriptor did not specify a name.</p></li>
<li><p><strong>annotation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Default annotation for the virtual machine or virtual appliance.
If None, the OVF descriptor did not specify an annotation.</p></li>
<li><p><strong>eulas</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) End User License Agreements specified in the OVF descriptor. All
end user license agreements must be accepted in order for the
<code class="docutils literal notranslate"><span class="pre">deploy</span></code> method to succeed. See
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.accept_all_eula</span></code>.</p></li>
<li><p><strong>networks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Section identifiers for sections of type ovf:NetworkSection in the
OVF descriptor. These identifiers can be used as keys in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.network_mappings</span></code>.
If None, the OVF descriptor did not specify any networks.</p></li>
<li><p><strong>storage_groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Section identifiers for sections of type vmw:StorageGroupSection in
the OVF descriptor. These identifiers can be used as keys in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.storage_mappings</span></code>.
If None, the OVF descriptor did not specify any storage groups.</p></li>
<li><p><strong>additional_params</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Additional OVF parameters which can be specified for the deployment
target. These OVF parameters can be inspected, optionally modified,
and used as values in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.additional_parameters</span></code>
for the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method.
When clients pass a value of this class as a parameter, the
attribute must contain all the attributes defined in
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfParams" title="com.vmware.vcenter.ovf_client.OvfParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfParams</span></code></a>. When methods return a value of this class as a
return value, the attribute will contain all the attributes defined
in <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfParams" title="com.vmware.vcenter.ovf_client.OvfParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfParams</span></code></a>.
If None, the OVF descriptor does not require addtional parameters
or does not have additional parameters suitable for the deployment
target.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ResourcePoolDeploymentSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">annotation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">accept_all_eula</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_mappings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_mappings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_provisioning</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_profile_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">locale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_parameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_datastore_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code> class defines the deployment
parameters that can be specified for the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method where the
deployment target is a resource pool. See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a>.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Name assigned to the deployed target virtual machine or virtual
appliance.
If None, the server will use the name from the OVF package.</p></li>
<li><p><strong>annotation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Annotation assigned to the deployed target virtual machine or
virtual appliance.
If None, the server will use the annotation from the OVF package.</p></li>
<li><p><strong>accept_all_eula</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Whether to accept all End User License Agreements. See
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.OvfSummary.eulas</span></code>.</p></li>
<li><p><strong>network_mappings</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specification of the target network to use for sections of type
ovf:NetworkSection in the OVF descriptor. The key in the
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> 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 <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>. When methods return a value of this
class as a return value, the value in the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>
will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
If None, the server will choose a network mapping.</p></li>
<li><p><strong>storage_mappings</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specification of the target storage to use for sections of type
vmw:StorageGroupSection in the OVF descriptor. The key in the
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> 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
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping</span></code></a>.
If None, the server will choose a storage mapping.</p></li>
<li><p><strong>storage_provisioning</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType" title="com.vmware.vcenter.ovf_client.DiskProvisioningType"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiskProvisioningType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>storage_profile_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">StorageProfile</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">StorageProfile</span></code>.
If None, the server will choose the default profile.</p></li>
<li><p><strong>locale</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The locale to use for parsing the OVF descriptor.
If None, the server locale will be used.</p></li>
<li><p><strong>flags</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Flags to be use for deployment. The supported flag values can be
obtained using <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ImportFlag.list" title="com.vmware.vcenter.ovf_client.ImportFlag.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">ImportFlag.list()</span></code></a>.
If None, no flags will be used.</p></li>
<li><p><strong>additional_parameters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>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:</p>
<ul>
<li><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.DeploymentOptionParams" title="com.vmware.vcenter.ovf_client.DeploymentOptionParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeploymentOptionParams</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.ExtraConfigParams" title="com.vmware.vcenter.ovf_client.ExtraConfigParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExtraConfigParams</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.IpAllocationParams" title="com.vmware.vcenter.ovf_client.IpAllocationParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpAllocationParams</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.PropertyParams" title="com.vmware.vcenter.ovf_client.PropertyParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">PropertyParams</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.ScaleOutParams" title="com.vmware.vcenter.ovf_client.ScaleOutParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScaleOutParams</span></code></a></p></li>
<li><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.VcenterExtensionParams" title="com.vmware.vcenter.ovf_client.VcenterExtensionParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">VcenterExtensionParams</span></code></a></p></li>
</ul>
<p>When clients pass a value of this class as a parameter, the
attribute must contain all the attributes defined in
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfParams" title="com.vmware.vcenter.ovf_client.OvfParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfParams</span></code></a>. When methods return a value of this class as a
return value, the attribute will contain all the attributes defined
in <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfParams" title="com.vmware.vcenter.ovf_client.OvfParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfParams</span></code></a>.
If None, the server will choose default settings for all parameters
necessary for the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method. See
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a>.</p>
</p></li>
<li><p><strong>default_datastore_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
If None, the server will choose the default datastore.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ResultInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">warnings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">information</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.ResultInfo</span></code> class defines the information returned along
with the result of a <code class="docutils literal notranslate"><span class="pre">create</span></code> or <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method to describe errors,
warnings, and informational messages produced by the server.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfError" title="com.vmware.vcenter.ovf_client.OvfError"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfError</span></code></a>) Errors reported by the <code class="docutils literal notranslate"><span class="pre">create</span></code> or <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method. These
errors would have prevented the <code class="docutils literal notranslate"><span class="pre">create</span></code> or <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method
from completing successfully.</p></li>
<li><p><strong>warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfWarning" title="com.vmware.vcenter.ovf_client.OvfWarning"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfWarning</span></code></a>) Warnings reported by the <code class="docutils literal notranslate"><span class="pre">create</span></code> or <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method. These
warnings would not have prevented the <code class="docutils literal notranslate"><span class="pre">create</span></code> or <code class="docutils literal notranslate"><span class="pre">deploy</span></code>
method from completing successfully, but there might be issues that
warrant attention.</p></li>
<li><p><strong>information</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfInfo" title="com.vmware.vcenter.ovf_client.OvfInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfInfo</span></code></a>) Information messages reported by the <code class="docutils literal notranslate"><span class="pre">create</span></code> or <code class="docutils literal notranslate"><span class="pre">deploy</span></code>
method. For example, a non-required parameter was ignored.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">StorageGroupMapping</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datastore_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_profile_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provisioning</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping</span></code> class defines the storage
deployment target and storage provisioning type for a section of type
vmw:StorageGroupSection in the OVF descriptor.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping.Type</span></code></a>) Type of storage deployment target to use for the
vmw:StorageGroupSection section. The specified value must be
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping.Type.DATASTORE</span></code></a> or
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE</span></code></a>.</p></li>
<li><p><strong>datastore_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping.Type.DATASTORE</span></code></a>.</p></li>
<li><p><strong>storage_profile_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">StorageProfile</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">StorageProfile</span></code>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE" title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE</span></code></a>.</p></li>
<li><p><strong>provisioning</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.DiskProvisioningType" title="com.vmware.vcenter.ovf_client.DiskProvisioningType"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiskProvisioningType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Target provisioning type to use for the storage group.
If None,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.storage_provisioning</span></code>
will be used.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.StorageGroupMapping.Type</span></code> class defines the supported
types of storage targets for sections of type vmw:StorageGroupSection in
the OVF descriptor.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE">
<code class="sig-name descname"><span class="pre">DATASTORE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='DATASTORE')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE" title="Permalink to this definition"></a></dt>
<dd><p>Storage deployment target is a datastore.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE">
<code class="sig-name descname"><span class="pre">STORAGE_PROFILE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='STORAGE_PROFILE')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE" title="Permalink to this definition"></a></dt>
<dd><p>Storage deployment target is a storage profile.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">create_spec</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.create" title="Permalink to this definition"></a></dt>
<dd><p>Creates a library item in content library from a virtual machine or
virtual appliance.</p>
<p>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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>client_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>source</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity" title="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeployableIdentity</span></code></a>) Identifier of the virtual machine or virtual appliance to use as
the source.</p></li>
<li><p><strong>target</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.CreateTarget</span></code></a>) Specification of the target content library and library item.</p></li>
<li><p><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.CreateSpec</span></code></a>) Information used to create the OVF package from the source virtual
machine or virtual appliance.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateResult" title="com.vmware.vcenter.ovf_client.LibraryItem.CreateResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.CreateResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the success or failure of the method, along with
the details of the result or failure.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">create_spec</span></code> contains invalid arguments.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">source</span></code> describes an unexpected resource type.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine or virtual appliance specified by <code class="docutils literal notranslate"><span class="pre">source</span></code>
does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library or library item specified by <code class="docutils literal notranslate"><span class="pre">target</span></code> does not
exist.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the operation cannot be performed because of the specified
virtual machine or virtual appliances current state. For example,
if the virtual machine configuration information is not available,
or if the virtual appliance is running.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if there was an error accessing a file from the source virtual
machine or virtual appliance.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
if the specified virtual machine or virtual appliance is busy.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">null</span></code> or <code class="docutils literal notranslate"><span class="pre">null</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeployableIdentity.id</span></code> requires <code class="docutils literal notranslate"><span class="pre">VApp.Export</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code> referenced by the
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.CreateTarget.library_id</span></code> requires
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.AddLibraryItem</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.CreateTarget.library_item_id</span></code>
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.deploy">
<code class="sig-name descname"><span class="pre">deploy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ovf_library_item_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deployment_spec</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="Permalink to this definition"></a></dt>
<dd><p>Deploys an OVF package stored in content library to a newly created
virtual machine or virtual appliance.</p>
<p>This method deploys an OVF package which is stored in the library item
specified by <code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code>. It uses the deployment
specification in <code class="docutils literal notranslate"><span class="pre">deployment_spec</span></code> to deploy the OVF package to the
location specified by <code class="docutils literal notranslate"><span class="pre">target</span></code>.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>client_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>ovf_library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the content library item containing the OVF package
to be deployed.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
<li><p><strong>target</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget</span></code></a>) Specification of the deployment target.</p></li>
<li><p><strong>deployment_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a>) Specification of how the OVF package should be deployed to the
target.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentResult" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeploymentResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the success or failure of the method, along with
the details of the result or failure.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">target</span></code> contains invalid arguments.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">deployment_spec</span></code> contains invalid arguments or has attributes
that are inconsistent with <code class="docutils literal notranslate"><span class="pre">target</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library item specified by <code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code> does not
exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if any resource specified by a attribute of the
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget</span></code></a> class, specified by
<code class="docutils literal notranslate"><span class="pre">target</span></code>, does not exist.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if there was an error accessing the OVF package stored in the
library item specified by <code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><dl class="simple">
<dt><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a> </dt><dd><p>if you do not have all of the privileges described as follows :</p>
</dd>
</dl>
<ul class="simple">
<li><p>Method execution requires VirtualMachine.Config.AddNewDisk if the
OVF descriptor has a disk drive (type 17) section.</p></li>
<li><p>Method execution requires VirtualMachine.Config.AdvancedConfig if
the OVF descriptor has an ExtraConfig section.</p></li>
<li><p>Method execution requires Extension.Register for specified
resource group if the OVF descriptor has a vServiceDependency
section.</p></li>
<li><p>Method execution requires Network.Assign for target network if
specified.</p></li>
<li><p>Method execution requires Datastore.AllocateSpace for target
datastore if specified.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget.host_id</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Network</span></code> referenced by the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> value of
attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.network_mappings</span></code>
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">StorageProfile</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.storage_profile_id</span></code>
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec.default_datastore_id</span></code>
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget.resource_pool_id</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VApp.Import</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Folder</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget.folder_id</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VApp.Import</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.ovf_client.LibraryItem.filter">
<code class="sig-name descname"><span class="pre">filter</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ovf_library_item_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="Permalink to this definition"></a></dt>
<dd><p>Queries an OVF package stored in content library to retrieve
information to use when deploying the package. See
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a>.</p>
<p>This method retrieves information from the descriptor of the OVF
package stored in the library item specified by
<code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code>. The information returned by the method can be
used to populate the deployment specification (see
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a> when deploying the OVF
package to the deployment target specified by <code class="docutils literal notranslate"><span class="pre">target</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ovf_library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the content library item containing the OVF package
to query.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
<li><p><strong>target</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget</span></code></a>) Specification of the deployment target.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.OvfSummary" title="com.vmware.vcenter.ovf_client.LibraryItem.OvfSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.OvfSummary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information that can be used to populate the deployment
specification (see <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec" title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a>)
when deploying the OVF package to the deployment target specified
by <code class="docutils literal notranslate"><span class="pre">target</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">target</span></code> contains invalid arguments.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library item specified by <code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code> does not
exist.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if any resource specified by a attribute of the
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget" title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget</span></code></a> class, specified by
<code class="docutils literal notranslate"><span class="pre">target</span></code>, does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if there was an error accessing the OVF package at the specified
<code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">ovf_library_item_id</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget.resource_pool_id</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget.host_id</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Folder</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItem.DeploymentTarget.folder_id</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.OvfError">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">OvfError</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">category</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issues</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">OvfError</span></code> class describes an error related to accessing, validating,
deploying, or exporting an OVF package.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category" title="com.vmware.vcenter.ovf_client.OvfMessage.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfMessage.Category</span></code></a>) The message category.</p></li>
<li><p><strong>issues</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue</span></code></a>) <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of parse issues (see <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue</span></code></a>).
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.VALIDATION</span></code></a>.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of input parameter.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The value of input parameter.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) A localizable message.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code>) Represents a server
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>.
When clients pass a value of this class as a parameter, the
attribute must contain all the attributes defined in
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>. When methods
return a value of this class as a return value, the attribute will
contain all the attributes defined in
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.SERVER</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.OvfInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">OvfInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">OvfInfo</span></code> class contains informational messages related to accessing,
validating, deploying, or exporting an OVF package.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) A <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of localizable messages (see
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>).</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.OvfMessage">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">OvfMessage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">category</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issues</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfMessage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">OvfMessage</span></code> class describes a base OVF handling error message
related to accessing, validating, deploying, or exporting an OVF package.</p>
<p>These messages fall into different categories defined in
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category" title="com.vmware.vcenter.ovf_client.OvfMessage.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfMessage.Category</span></code></a>:</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category" title="com.vmware.vcenter.ovf_client.OvfMessage.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfMessage.Category</span></code></a>) The message category.</p></li>
<li><p><strong>issues</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue</span></code></a>) <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of parse issues (see <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue</span></code></a>).
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.VALIDATION</span></code></a>.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of input parameter.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The value of input parameter.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) A localizable message.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code>) Represents a server
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>.
When clients pass a value of this class as a parameter, the
attribute must contain all the attributes defined in
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>. When methods
return a value of this class as a return value, the attribute will
contain all the attributes defined in
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.SERVER</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.OvfMessage.Category">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Category</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">OvfMessage.Category</span></code> class defines the categories of messages (see
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage" title="com.vmware.vcenter.ovf_client.OvfMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfMessage</span></code></a>).</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Category</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT">
<code class="sig-name descname"><span class="pre">INPUT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='INPUT')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="Permalink to this definition"></a></dt>
<dd><p>The user provided input parameters are invalid.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER">
<code class="sig-name descname"><span class="pre">SERVER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='SERVER')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER" title="Permalink to this definition"></a></dt>
<dd><p>Server error.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION">
<code class="sig-name descname"><span class="pre">VALIDATION</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='VALIDATION')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION" title="Permalink to this definition"></a></dt>
<dd><p>The OVF descriptor is invalid, for example, syntax errors or schema errors.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.OvfParams">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">OvfParams</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfParams" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">OvfParams</span></code> class defines the common attributes for all OVF
deployment parameters. OVF parameters serve several purposes:</p>
<ul class="simple">
<li><p>Describe information about a given OVF package.</p></li>
<li><p>Describe default deployment configuration.</p></li>
<li><p>Describe possible deployment values based on the deployment environment.</p></li>
<li><p>Provide deployment-specific configuration.</p></li>
</ul>
<p>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.</p>
<p>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).</p>
<blockquote>
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
</div></blockquote>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.OvfWarning">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">OvfWarning</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">category</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issues</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.OvfWarning" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">OvfWarning</span></code> class describes a warning related to accessing,
validating, deploying, or exporting an OVF package.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category" title="com.vmware.vcenter.ovf_client.OvfMessage.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">OvfMessage.Category</span></code></a>) The message category.</p></li>
<li><p><strong>issues</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue</span></code></a>) <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of parse issues (see <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue</span></code></a>).
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.VALIDATION</span></code></a>.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of input parameter.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The value of input parameter.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) A localizable message.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code>) Represents a server
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>.
When clients pass a value of this class as a parameter, the
attribute must contain all the attributes defined in
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>. When methods
return a value of this class as a return value, the attribute will
contain all the attributes defined in
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER" title="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">OvfMessage.Category.SERVER</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.ParseIssue">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">ParseIssue</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">category</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">line_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">column_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ParseIssue</span></code> class contains the information about the issue found
when parsing an OVF package during deployment or exporting an OVF package
including:</p>
<ul class="simple">
<li><p>Parsing and validation error on OVF descriptor (which is an XML
document), manifest and certificate files.</p></li>
<li><p>OVF descriptor generating and device error.</p></li>
<li><p>Unexpected server error.</p></li>
</ul>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category" title="com.vmware.vcenter.ovf_client.ParseIssue.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue.Category</span></code></a>) The category of the parse issue.</p></li>
<li><p><strong>file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of the file in which the parse issue was found.</p></li>
<li><p><strong>line_number</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The line number of the line in the file (see
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ParseIssue.file</span></code>) where the parse issue was found (or -1 if
not applicable).</p></li>
<li><p><strong>column_number</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The position in the line (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">ParseIssue.line_number</span></code>) (or
-1 if not applicable).</p></li>
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) A localizable message describing the parse issue.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Category</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ParseIssue.Category</span></code> class defines the categories of issues that can
be found when parsing files inside an OVF package (see <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ParseIssue" title="com.vmware.vcenter.ovf_client.ParseIssue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseIssue</span></code></a>)
including OVF descriptor (which is an XML document), manifest and
certificate files, or exporting an OVF package.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Category</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.ATTRIBUTE_ILLEGAL">
<code class="sig-name descname"><span class="pre">ATTRIBUTE_ILLEGAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='ATTRIBUTE_ILLEGAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ATTRIBUTE_ILLEGAL" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.ATTRIBUTE_REQUIRED">
<code class="sig-name descname"><span class="pre">ATTRIBUTE_REQUIRED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='ATTRIBUTE_REQUIRED')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ATTRIBUTE_REQUIRED" title="Permalink to this definition"></a></dt>
<dd><p>Required attribute error. It indicates that a required attribute is missing
from an element in the OVF descriptor.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_ILLEGAL">
<code class="sig-name descname"><span class="pre">ELEMENT_ILLEGAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='ELEMENT_ILLEGAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_ILLEGAL" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_REQUIRED">
<code class="sig-name descname"><span class="pre">ELEMENT_REQUIRED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='ELEMENT_REQUIRED')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_REQUIRED" title="Permalink to this definition"></a></dt>
<dd><p>Required element error. It indicates that a required element is missing
from the OVF descriptor.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_UNKNOWN">
<code class="sig-name descname"><span class="pre">ELEMENT_UNKNOWN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='ELEMENT_UNKNOWN')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_UNKNOWN" title="Permalink to this definition"></a></dt>
<dd><p>Unknown element error. It indicates that an element is unsupported when
parsing an OVF descriptor.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.EXPORT_ERROR">
<code class="sig-name descname"><span class="pre">EXPORT_ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='EXPORT_ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.EXPORT_ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Issue during OVF export, for example, malformed deviceId, controller not
found, or file backing for a device not found.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.GENERATE_ERROR">
<code class="sig-name descname"><span class="pre">GENERATE_ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='GENERATE_ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.GENERATE_ERROR" title="Permalink to this definition"></a></dt>
<dd><p>OVF descriptor (which is an XML document) generating error, for example,
well-formedness errors as well as unexpected processing conditions.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.INTERNAL_ERROR">
<code class="sig-name descname"><span class="pre">INTERNAL_ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='INTERNAL_ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.INTERNAL_ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Server encountered an unexpected error which prevented it from fulfilling
the request.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.PARSE_ERROR">
<code class="sig-name descname"><span class="pre">PARSE_ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='PARSE_ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.PARSE_ERROR" title="Permalink to this definition"></a></dt>
<dd><p>OVF package parsing error, including:</p>
<ul class="simple">
<li><p>OVF descriptor parsing errors, for example, syntax errors or schema
errors.</p></li>
<li><p>Manifest file parsing and verification errors.</p></li>
<li><p>Certificate file parsing and verification errors.</p></li>
</ul>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.SECTION_RESTRICTION">
<code class="sig-name descname"><span class="pre">SECTION_RESTRICTION</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='SECTION_RESTRICTION')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.SECTION_RESTRICTION" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.SECTION_UNKNOWN">
<code class="sig-name descname"><span class="pre">SECTION_UNKNOWN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='SECTION_UNKNOWN')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.SECTION_UNKNOWN" title="Permalink to this definition"></a></dt>
<dd><p>Section unknown error. It indicates that a section is unsupported when
parsing an OVF descriptor.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.VALIDATION_ERROR">
<code class="sig-name descname"><span class="pre">VALIDATION_ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='VALIDATION_ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.VALIDATION_ERROR" title="Permalink to this definition"></a></dt>
<dd><p>An issue with the manifest and signing.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.ParseIssue.Category.VALUE_ILLEGAL">
<code class="sig-name descname"><span class="pre">VALUE_ILLEGAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Category(string='VALUE_ILLEGAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.VALUE_ILLEGAL" title="Permalink to this definition"></a></dt>
<dd><p>Illegal value error. For example, the value is malformed, not a number, or
outside of the given range, and so on.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.Property">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">Property</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">class_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ui_optional</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.Property" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Property</span></code> class contains the information about a property in an OVF
package.</p>
<p>A property is uniquely identified by its [classid.]id[.instanceid]
fully-qualified name (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">Property.class_id</span></code>, <code class="xref py py-attr docutils literal notranslate"><span class="pre">Property.id</span></code>,
and <code class="xref py py-attr docutils literal notranslate"><span class="pre">Property.instance_id</span></code>). 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.</p>
<blockquote>
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
</div></blockquote>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>class_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>category</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>ui_optional</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) <p>Whether a category is UI optional. This is only used if this
property starts a new category (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">Property.category</span></code>).</p>
<p>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.</p>
</p></li>
<li><p><strong>label</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.PropertyParams">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">PropertyParams</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">properties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.PropertyParams" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">PropertyParams</span></code> class contains a <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of OVF properties
that can be configured when the OVF package is deployed.</p>
<blockquote>
<div><p>This is based on the ovf:ProductSection.</p>
<p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
</div></blockquote>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>properties</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.Property" title="com.vmware.vcenter.ovf_client.Property"><code class="xref py py-class docutils literal notranslate"><span class="pre">Property</span></code></a>) <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> 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.</p></li>
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.ScaleOutGroup">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">ScaleOutGroup</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minimum_instance_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maximum_instance_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ScaleOutGroup" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ScaleOutGroup</span></code> class contains information about a scale-out group.</p>
<p>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.</p>
<blockquote>
<div><p>This is based on the ovf2:ScaleOutSection.</p>
<p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
</div></blockquote>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>instance_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) 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.</p></li>
<li><p><strong>minimum_instance_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) 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.</p></li>
<li><p><strong>maximum_instance_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.ScaleOutParams">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">ScaleOutParams</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">groups</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.ScaleOutParams" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ScaleOutParams</span></code> class contains information about the scale-out
groups described in the OVF package.</p>
<p>When deploying an OVF package, a deployment specific instance count can be
specified (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">ScaleOutGroup.instance_count</span></code>.</p>
<blockquote>
<div><p>This is based on the ovf2:ScaleOutSection.</p>
<p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
</div></blockquote>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.ScaleOutGroup" title="com.vmware.vcenter.ovf_client.ScaleOutGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScaleOutGroup</span></code></a>) The <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> 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.</p></li>
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.SizeParams">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">SizeParams</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">approximate_download_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">approximate_flat_deployment_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">approximate_sparse_deployment_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">variable_disk_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.SizeParams" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SizeParams</span></code> class contains estimates of the download and deployment
sizes.</p>
<p>This information is based on the file references and the ovf:DiskSection in
the OVF descriptor.</p>
<blockquote>
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
</div></blockquote>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>approximate_download_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) <p>A best guess as to the total amount of data that must be
transferred to download the OVF package.</p>
<blockquote>
<div><p>This may be inaccurate due to disk compression etc.</p>
</div></blockquote>
<p>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.</p>
</p></li>
<li><p><strong>approximate_flat_deployment_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) 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.</p></li>
<li><p><strong>approximate_sparse_deployment_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) 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.</p></li>
<li><p><strong>variable_disk_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) <p>Whether the OVF uses variable disk sizes.</p>
<p>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.</p>
</p></li>
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.UnknownSection">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">UnknownSection</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.UnknownSection" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">UnknownSection</span></code> class contains information about an unknown section
in an OVF package.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) A namespace-qualified tag in the form <code class="docutils literal notranslate"><span class="pre">{ns}tag</span></code>.</p></li>
<li><p><strong>info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The description of the Info element.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.UnknownSectionParams">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">UnknownSectionParams</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unknown_sections</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.UnknownSectionParams" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">UnknownSectionParams</span></code> class contains a <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of unknown,
non-required sections.</p>
<blockquote>
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
</div></blockquote>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>unknown_sections</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.ovf_client.UnknownSection" title="com.vmware.vcenter.ovf_client.UnknownSection"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnknownSection</span></code></a>) <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> 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.</p></li>
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.VcenterExtensionParams">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">VcenterExtensionParams</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">required</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">registration_accepted</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.VcenterExtensionParams" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VcenterExtensionParams</span></code> 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.</p>
<blockquote>
<div><p>See <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> and <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>.</p>
</div></blockquote>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>required</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) 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.</p></li>
<li><p><strong>registration_accepted</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) <p>Whether registration as a vCenter extension is accepted.</p>
<p>If registration as a vCenter extension is required (see
<code class="xref py py-attr docutils literal notranslate"><span class="pre">VcenterExtensionParams.required</span></code>), 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.</p>
</p></li>
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.WarningInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">WarningInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignored</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.WarningInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">WarningInfo</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.ovf_client.WarningType" title="com.vmware.vcenter.ovf_client.WarningType"><code class="xref py py-class docutils literal notranslate"><span class="pre">WarningType</span></code></a>) The warning type raised during the OVF package deployment. This
attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) The message specifying more details about the warning. This
attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>ignored</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) <p>Indicates if this warning will be ignored when deploying the OVF
package.</p>
<p>The value is set to be <code class="docutils literal notranslate"><span class="pre">false</span></code> when it is returned from
<a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.filter" title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.filter()</span></code></a>, it should be updated to be <code class="docutils literal notranslate"><span class="pre">true</span></code>
when calling <a class="reference internal" href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy" title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><code class="xref py py-func docutils literal notranslate"><span class="pre">LibraryItem.deploy()</span></code></a> if the warning can be
ignored, otherwise the OVF package deployment will fail.. This
attribute was added in vSphere API 7.0.2.0.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.ovf_client.WarningType">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.ovf_client.</span></code><code class="sig-name descname"><span class="pre">WarningType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.ovf_client.WarningType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">WarningType</span></code> class defines the warnings which can be raised during
the OVF package deployment. This enumeration was added in vSphere API
7.0.2.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.ovf_client.WarningType" title="com.vmware.vcenter.ovf_client.WarningType"><code class="xref py py-class docutils literal notranslate"><span class="pre">WarningType</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.WarningType.EXPIRED_CERTIFICATE">
<code class="sig-name descname"><span class="pre">EXPIRED_CERTIFICATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">WarningType(string='EXPIRED_CERTIFICATE')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.WarningType.EXPIRED_CERTIFICATE" title="Permalink to this definition"></a></dt>
<dd><p>The certificate used for signing the OVF package content is expired. This
class attribute was added in vSphere API 7.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.WarningType.NOT_YET_VALID_CERTIFICATE">
<code class="sig-name descname"><span class="pre">NOT_YET_VALID_CERTIFICATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">WarningType(string='NOT_YET_VALID_CERTIFICATE')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.WarningType.NOT_YET_VALID_CERTIFICATE" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.WarningType.SELF_SIGNED_CERTIFICATE">
<code class="sig-name descname"><span class="pre">SELF_SIGNED_CERTIFICATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">WarningType(string='SELF_SIGNED_CERTIFICATE')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.WarningType.SELF_SIGNED_CERTIFICATE" title="Permalink to this definition"></a></dt>
<dd><p>The certificate used for signing the OVF package content is self-signed.
This class attribute was added in vSphere API 7.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.ovf_client.WarningType.UNTRUSTED_CERTIFICATE">
<code class="sig-name descname"><span class="pre">UNTRUSTED_CERTIFICATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">WarningType(string='UNTRUSTED_CERTIFICATE')</span></em><a class="headerlink" href="#com.vmware.vcenter.ovf_client.WarningType.UNTRUSTED_CERTIFICATE" title="Permalink to this definition"></a></dt>
<dd><p>The certificate used for signing the OVF package content is not trusted.
This class attribute was added in vSphere API 7.0.2.0.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.services_client">
<span id="com-vmware-vcenter-services-client-module"></span><h2>com.vmware.vcenter.services_client module<a class="headerlink" href="#module-com.vmware.vcenter.services_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="com.vmware.vcenter.services_client.Service">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.services_client.</span></code><code class="sig-name descname"><span class="pre">Service</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Service</span></code> class provides methods to manage a single/set of vCenter
Server services. This class was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.services_client.Service.Health">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Health</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.Health" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Service.Health</span></code> class defines the possible values for health of a
service. This enumeration was added in vSphere API 6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Health</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.services_client.Service.Health.DEGRADED">
<code class="sig-name descname"><span class="pre">DEGRADED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='DEGRADED')</span></em><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.Health.DEGRADED" title="Permalink to this definition"></a></dt>
<dd><p>Service is in degraded state, it is not functional. This class attribute
was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.services_client.Service.Health.HEALTHY">
<code class="sig-name descname"><span class="pre">HEALTHY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='HEALTHY')</span></em><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.Health.HEALTHY" title="Permalink to this definition"></a></dt>
<dd><p>Service is in a healthy state and is fully functional. This class attribute
was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.services_client.Service.Health.HEALTHY_WITH_WARNINGS">
<code class="sig-name descname"><span class="pre">HEALTHY_WITH_WARNINGS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='HEALTHY_WITH_WARNINGS')</span></em><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.Health.HEALTHY_WITH_WARNINGS" title="Permalink to this definition"></a></dt>
<dd><p>Service is healthy with warnings. This class attribute was added in vSphere
API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.services_client.Service.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">startup_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">health_messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Service.Info</span></code> class contains information about a service. This class
was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Service name key. Can be used to lookup resource bundle. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>description_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Service description key. Can be used to lookup resource bundle.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>startup_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.services_client.Service.StartupType" title="com.vmware.vcenter.services_client.Service.StartupType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.StartupType</span></code></a>) Startup Type. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.services_client.Service.State" title="com.vmware.vcenter.services_client.Service.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.State</span></code></a>) Running State. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>health</strong> (<a class="reference internal" href="#com.vmware.vcenter.services_client.Service.Health" title="com.vmware.vcenter.services_client.Service.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.Health</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">state</span></code> is <a class="reference internal" href="#com.vmware.vcenter.services_client.Service.State.STARTED" title="com.vmware.vcenter.services_client.Service.State.STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.State.STARTED</span></code></a>.</p></li>
<li><p><strong>health_messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">state</span></code> is <a class="reference internal" href="#com.vmware.vcenter.services_client.Service.State.STARTED" title="com.vmware.vcenter.services_client.Service.State.STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.State.STARTED</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.services_client.Service.StartupType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">StartupType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.StartupType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Service.StartupType</span></code> class defines valid Startup Type for vCenter
Server services. This enumeration was added in vSphere API 6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">StartupType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.services_client.Service.StartupType.AUTOMATIC">
<code class="sig-name descname"><span class="pre">AUTOMATIC</span></code><em class="property"> <span class="pre">=</span> <span class="pre">StartupType(string='AUTOMATIC')</span></em><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.StartupType.AUTOMATIC" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.services_client.Service.StartupType.DISABLED">
<code class="sig-name descname"><span class="pre">DISABLED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">StartupType(string='DISABLED')</span></em><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.StartupType.DISABLED" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.services_client.Service.StartupType.MANUAL">
<code class="sig-name descname"><span class="pre">MANUAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">StartupType(string='MANUAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.StartupType.MANUAL" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.services_client.Service.State">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">State</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.State" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Service.State</span></code> class defines valid Run State for services. This
enumeration was added in vSphere API 6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.services_client.Service.State.STARTED">
<code class="sig-name descname"><span class="pre">STARTED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='STARTED')</span></em><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.State.STARTED" title="Permalink to this definition"></a></dt>
<dd><p>Service Run State is Started, it is fully functional. This class attribute
was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.services_client.Service.State.STARTING">
<code class="sig-name descname"><span class="pre">STARTING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='STARTING')</span></em><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.State.STARTING" title="Permalink to this definition"></a></dt>
<dd><p>Service Run State is Starting, it is still not functional. This class
attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.services_client.Service.State.STOPPED">
<code class="sig-name descname"><span class="pre">STOPPED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='STOPPED')</span></em><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.State.STOPPED" title="Permalink to this definition"></a></dt>
<dd><p>Service Run State is Stopped. This class attribute was added in vSphere API
6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.services_client.Service.State.STOPPING">
<code class="sig-name descname"><span class="pre">STOPPING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='STOPPING')</span></em><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.State.STOPPING" title="Permalink to this definition"></a></dt>
<dd><p>Service Run State is Stopping, it is not functional. This class attribute
was added in vSphere API 6.7.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.services_client.Service.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Service.UpdateSpec</span></code> class describes the changes to be made to the
configuration of the service. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>startup_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.services_client.Service.StartupType" title="com.vmware.vcenter.services_client.Service.StartupType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.StartupType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Startup Type. This attribute was added in vSphere API 6.7.
If unspecified, leaves value unchanged.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.services_client.Service.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the state of a service. This method was added in vSphere API
6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) identifier of the service whose state is being queried.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.services.Service</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.services_client.Service.Info" title="com.vmware.vcenter.services_client.Service.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Service Info structure.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if any other error occurs during the execution of the operation.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.services_client.Service.list_details">
<code class="sig-name descname"><span class="pre">list_details</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.list_details" title="Permalink to this definition"></a></dt>
<dd><p>Lists details of vCenter services. This method was added in vSphere API
6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.services_client.Service.Info" title="com.vmware.vcenter.services_client.Service.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Map of service identifiers to service Info structures.
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.services.Service</span></code>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if any error occurs during the execution of the operation.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.services_client.Service.restart">
<code class="sig-name descname"><span class="pre">restart</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.restart" title="Permalink to this definition"></a></dt>
<dd><p>Restarts a service. This method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) identifier of the service to restart
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.services.Service</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.TimedOut" title="com.vmware.vapi.std.errors_client.TimedOut"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code></a>
if any timeout occurs during the execution of the restart
operation.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the 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.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if a restart operation is issued on a service which has startup
type <a class="reference internal" href="#com.vmware.vcenter.services_client.Service.StartupType.DISABLED" title="com.vmware.vcenter.services_client.Service.StartupType.DISABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.StartupType.DISABLED</span></code></a></p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if any other error occurs during the execution of the operation.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.services_client.Service.start">
<code class="sig-name descname"><span class="pre">start</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.start" title="Permalink to this definition"></a></dt>
<dd><p>Starts a service. This method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) identifier of the service to start
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.services.Service</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the 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.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if start operation is issued on a service which has startup type
<a class="reference internal" href="#com.vmware.vcenter.services_client.Service.StartupType.DISABLED" title="com.vmware.vcenter.services_client.Service.StartupType.DISABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.StartupType.DISABLED</span></code></a>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.TimedOut" title="com.vmware.vapi.std.errors_client.TimedOut"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code></a>
if any timeout occurs during the execution of the start operation.
Timeout occurs when the service takes longer than StartTimeout to
start.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if any other error occurs during the execution of the operation.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.services_client.Service.stop">
<code class="sig-name descname"><span class="pre">stop</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.stop" title="Permalink to this definition"></a></dt>
<dd><p>Stops a service. This method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) identifier of the service to stop
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.services.Service</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if any other error occurs during the execution of the operation.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the 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.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.services_client.Service.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.Service.update" title="Permalink to this definition"></a></dt>
<dd><p>Updates the properties of a service. This method was added in vSphere
API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) identifier of the service whose properties are being updated.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.services.Service</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.services_client.Service.UpdateSpec" title="com.vmware.vcenter.services_client.Service.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service.UpdateSpec</span></code></a>) Service Update specification.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the service associated with <code class="docutils literal notranslate"><span class="pre">service</span></code> does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if any other error occurs during the execution of the operation.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the 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.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if a request to set the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.UpdateSpec.startup_type</span></code>
attribute of <code class="docutils literal notranslate"><span class="pre">spec</span></code> to <a class="reference internal" href="#com.vmware.vcenter.services_client.Service.StartupType.DISABLED" title="com.vmware.vcenter.services_client.Service.StartupType.DISABLED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.StartupType.DISABLED</span></code></a> comes
in for a service that is not in <a class="reference internal" href="#com.vmware.vcenter.services_client.Service.State.STOPPED" title="com.vmware.vcenter.services_client.Service.State.STOPPED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Service.State.STOPPED</span></code></a>
state.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.services_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.services_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.services_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.storage_client">
<span id="com-vmware-vcenter-storage-client-module"></span><h2>com.vmware.vcenter.storage_client module<a class="headerlink" href="#module-com.vmware.vcenter.storage_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="com.vmware.vcenter.storage_client.Policies">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.storage_client.</span></code><code class="sig-name descname"><span class="pre">Policies</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage_client.Policies" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Policies</span></code> class provides methods for managing the storage policies.
This class was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.storage_client.Policies.CompatibilityInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CompatibilityInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compatible_datastores</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage_client.Policies.CompatibilityInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Policies.CompatibilityInfo</span></code> class contains info about a list of
datastores compatible with a specific storage policy. This class was added
in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>compatible_datastores</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.CompatibleDatastoreInfo" title="com.vmware.vcenter.storage_client.Policies.CompatibleDatastoreInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policies.CompatibleDatastoreInfo</span></code></a>) Info about a list of datastores compatible with a specific storage
policy. This attribute was added in vSphere API 6.7.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.storage_client.Policies.CompatibleDatastoreInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CompatibleDatastoreInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datastore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage_client.Policies.CompatibleDatastoreInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Policies.CompatibleDatastoreInfo</span></code> class contains compatible
datastores information. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.storage_client.Policies.FilterSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policies</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage_client.Policies.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Policies.FilterSpec</span></code> class contains attributes used to filter the
results when listing the storage policies (see <a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.list" title="com.vmware.vcenter.storage_client.Policies.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Policies.list()</span></code></a>). This
class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>policies</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Identifiers 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
of this class as a return value, the attribute will contain
identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.
If None or empty, storage policies with any identifiers match the
filter.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.storage_client.Policies.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.StoragePolicy'</span></em><a class="headerlink" href="#com.vmware.vcenter.storage_client.Policies.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for vAPI metadata policy. This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.storage_client.Policies.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage_client.Policies.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Policies.Summary</span></code> class contains commonly used information about a
storage policy. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
of this class as a return value, the attribute will be an
identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the storage policy. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Description of the storage policy. This attribute was added in
vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.storage_client.Policies.check_compatibility">
<code class="sig-name descname"><span class="pre">check_compatibility</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">policy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datastores</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage_client.Policies.check_compatibility" title="Permalink to this definition"></a></dt>
<dd><p>Returns datastore compatibility summary about a specific storage
policy. This method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The storage policy identifier
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.StoragePolicy</span></code>.</p></li>
<li><p><strong>datastores</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.CompatibilityInfo" title="com.vmware.vcenter.storage_client.Policies.CompatibilityInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policies.CompatibilityInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>datastore compatibility summary about a specific storage policy.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the storage policy specified does not exist.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
if input more than 1024 datastores.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.storage_client.Policies.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage_client.Policies.list" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.FilterSpec" title="com.vmware.vcenter.storage_client.Policies.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policies.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specification of matching storage policies for which information
should be returned.
If None, the behavior is equivalent to a
<a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.FilterSpec" title="com.vmware.vcenter.storage_client.Policies.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policies.FilterSpec</span></code></a> with all attributes None which means
all storage policies match the filter</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.list" title="com.vmware.vcenter.storage_client.Policies.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.Summary" title="com.vmware.vcenter.storage_client.Policies.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policies.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Commonly used Information about the storage policies.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the <a class="reference internal" href="#com.vmware.vcenter.storage_client.Policies.FilterSpec" title="com.vmware.vcenter.storage_client.Policies.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Policies.FilterSpec</span></code></a> contains a value that is not
supported by the server.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
if more than 1024 storage policies exist.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.storage_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.storage_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.storage_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.system_config_client">
<span id="com-vmware-vcenter-system-config-client-module"></span><h2>com.vmware.vcenter.system_config_client module<a class="headerlink" href="#module-com.vmware.vcenter.system_config_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="com.vmware.vcenter.system_config_client.DeploymentType">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.system_config_client.</span></code><code class="sig-name descname"><span class="pre">DeploymentType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.DeploymentType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DeploymentType</span></code> class provides methods to get/set the type of the
appliance. This class was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.system_config_client.DeploymentType.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.DeploymentType.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DeploymentType.Info</span></code> class contains the fields used to get the
appliance type. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.ApplianceType" title="com.vmware.vcenter.deployment_client.ApplianceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.ApplianceType</span></code></a>) The type of the appliance. This attribute was added in vSphere API
6.7.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.system_config_client.DeploymentType.ReconfigureSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ReconfigureSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remote_psc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.DeploymentType.ReconfigureSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DeploymentType.ReconfigureSpec</span></code> class contains the fields used to
get and set the appliance type. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.ApplianceType" title="com.vmware.vcenter.deployment_client.ApplianceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.ApplianceType</span></code></a>) The type of the appliance. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>remote_psc</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.RemotePscSpec" title="com.vmware.vcenter.deployment_client.RemotePscSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.RemotePscSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) External PSC to register with when reconfiguring a VCSA_EMBEDDED
appliance to a VCSA_EXTERNAL appliance. This attribute was added in
vSphere API 6.7.
Only required when reconfiguring an VCSA_EMBEDDED node to a
VCSA_EXTERNAL.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.system_config_client.DeploymentType.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.DeploymentType.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the type of the vCenter appliance. This method was added in vSphere
API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.system_config_client.DeploymentType.Info" title="com.vmware.vcenter.system_config_client.DeploymentType.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeploymentType.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The type of the vCenter appliance.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if appliance is not in CONFIGURED state.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.system_config_client.DeploymentType.reconfigure">
<code class="sig-name descname"><span class="pre">reconfigure</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.DeploymentType.reconfigure" title="Permalink to this definition"></a></dt>
<dd><p>Reconfigure the type of the vCenter appliance. This method was added in
vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.system_config_client.DeploymentType.ReconfigureSpec" title="com.vmware.vcenter.system_config_client.DeploymentType.ReconfigureSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeploymentType.ReconfigureSpec</span></code></a>) ReconfigureSpec to set the appliance type.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the appliance is in CONFIGURED state and if not changing the
type from VCSA_EMBEDDED to VCSA_EXTERNAL.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if passed arguments are invalid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if external PSC credentials are not valid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the appliance is not in INITIALIZED or CONFIGURED state.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.system_config_client.PscRegistration">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.system_config_client.</span></code><code class="sig-name descname"><span class="pre">PscRegistration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.PscRegistration" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">PscRegistration</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.system_config_client.PscRegistration.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">https_port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sso_domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.PscRegistration.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">PscRegistration.Info</span></code> class has fields to specify information about
the PSC node. This class was added in vSphere API 6.7.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The IP address or DNS resolvable name of the PSC this appliance is
registered with. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The HTTPs port used by the external PSC. This attribute was added
in vSphere API 6.7.</p></li>
<li><p><strong>sso_domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The Single Sign-On domain name of the external PSC. This attribute
was added in vSphere API 6.7.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.system_config_client.PscRegistration.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.PscRegistration.get" title="Permalink to this definition"></a></dt>
<dd><p>Get information of the PSC that this appliance is registered with. This
method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.system_config_client.PscRegistration.Info" title="com.vmware.vcenter.system_config_client.PscRegistration.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">PscRegistration.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Info structure containing information about the external PSC node
this appliance is registered with.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the appliance is in NOT_INITIALIZED state.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.system_config_client.PscRegistration.repoint">
<code class="sig-name descname"><span class="pre">repoint</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.PscRegistration.repoint" title="Permalink to this definition"></a></dt>
<dd><p>Repoint this vCenter Server appliance to a different external PSC. This
method was added in vSphere API 6.7.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.deployment_client.RemotePscSpec" title="com.vmware.vcenter.deployment_client.RemotePscSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.deployment_client.RemotePscSpec</span></code></a>) RemotePscSpec structure containing information about the external
PSC node to repoint this vCenter Server appliance to.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the passed external PSC credentials is invalid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the passed external PSC is not a replicating with the current
PSC this appliance is registered with.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if passed arguments are invalid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the current appliance is not of the type VCSA_EXTERNAL.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the appliance is NOT in CONFIGURED state.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.system_config_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.system_config_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.system_config_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.tagging_client">
<span id="com-vmware-vcenter-tagging-client-module"></span><h2>com.vmware.vcenter.tagging_client module<a class="headerlink" href="#module-com.vmware.vcenter.tagging_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.tagging_client</span></code> module provides classes for managing
tags.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.tagging_client.Associations">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.tagging_client.</span></code><code class="sig-name descname"><span class="pre">Associations</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tagging_client.Associations" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Associations</span></code> class provides methods to list tag associations. This
class was added in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.tagging_client.Associations.IterationSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">IterationSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">marker</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tagging_client.Associations.IterationSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Associations.IterationSpec</span></code> class contains attributes used to break
results into pages when listing tags associated to objects see
<a class="reference internal" href="#com.vmware.vcenter.tagging_client.Associations.list" title="com.vmware.vcenter.tagging_client.Associations.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Associations.list()</span></code></a>). This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>marker</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.tagging.associations.Marker</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.tagging.associations.Marker</span></code>.
If None or empty, first page of tag associations will be returned.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.tagging_client.Associations.LastIterationStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">LastIterationStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tagging_client.Associations.LastIterationStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The 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.</p>
<p>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.</p>
<p>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.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">LastIterationStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.tagging_client.Associations.LastIterationStatus.END_OF_DATA">
<code class="sig-name descname"><span class="pre">END_OF_DATA</span></code><em class="property"> <span class="pre">=</span> <span class="pre">LastIterationStatus(string='END_OF_DATA')</span></em><a class="headerlink" href="#com.vmware.vcenter.tagging_client.Associations.LastIterationStatus.END_OF_DATA" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.tagging_client.Associations.LastIterationStatus.READY">
<code class="sig-name descname"><span class="pre">READY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">LastIterationStatus(string='READY')</span></em><a class="headerlink" href="#com.vmware.vcenter.tagging_client.Associations.LastIterationStatus.READY" title="Permalink to this definition"></a></dt>
<dd><p>Iterator has more data pending and is ready to provide it. The caller can
request the next page of data at any time.</p>
<p>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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.tagging_client.Associations.ListResult">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ListResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">associations</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">marker</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tagging_client.Associations.ListResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Associations.ListResult</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>associations</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.tagging_client.Associations.Summary" title="com.vmware.vcenter.tagging_client.Associations.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Associations.Summary</span></code></a>) List of tag associations. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>marker</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.tagging.associations.Marker</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.tagging.associations.Marker</span></code>.
If None or empty, there are no more tag associations to request.</p></li>
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.tagging_client.Associations.LastIterationStatus" title="com.vmware.vcenter.tagging_client.Associations.LastIterationStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Associations.LastIterationStatus</span></code></a>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.tagging_client.Associations.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">object</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tagging_client.Associations.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Associations.Summary</span></code> describes a tag association. This class was
added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
<li><p><strong>object</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a>) The identifier of an associated object. This attribute was added in
vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.tagging_client.Associations.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iterate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tagging_client.Associations.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns tag associations that match the specified iteration spec. This
method was added in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>iterate</strong> (<a class="reference internal" href="#com.vmware.vcenter.tagging_client.Associations.IterationSpec" title="com.vmware.vcenter.tagging_client.Associations.IterationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Associations.IterationSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The specification of a page to be retrieved.
If None, the first page will be retrieved.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.tagging_client.Associations.ListResult" title="com.vmware.vcenter.tagging_client.Associations.ListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Associations.ListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A page of the tag associations matching the iteration spec.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="xref py py-attr docutils literal notranslate"><span class="pre">Associations.IterationSpec.marker</span></code> is not a marker
returned from an earlier invocation of this {\&#64;term operation).</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.tagging_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.tagging_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tagging_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.tokenservice_client">
<span id="com-vmware-vcenter-tokenservice-client-module"></span><h2>com.vmware.vcenter.tokenservice_client module<a class="headerlink" href="#module-com.vmware.vcenter.tokenservice_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.tokenservice_client</span></code> module provides Token classes.</p>
<dl class="py exception">
<dt id="com.vmware.vcenter.tokenservice_client.Error">
<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.tokenservice_client.</span></code><code class="sig-name descname"><span class="pre">Error</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.Error" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.error.VapiError</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Error</span></code> exception describes theattributes common to all standard
exceptions.</p>
<blockquote>
<div><p>This exception serves two purposes:</p>
</div></blockquote>
<ol class="arabic simple">
<li><p>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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">Error.messages</span></code> to a human.</p></li>
<li><p>It is the exception that methods can report when they need to report
some exception, but the exception doesnt 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.</p></li>
</ol>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) <p>Stack of one or more localizable messages for human exception
consumers.</p>
<p>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.</p>
</p></li>
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Data to facilitate clients responding to the method reporting a
standard exception to indicating that it was unable to complete
successfully.</p>
<p>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.
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> 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.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt id="com.vmware.vcenter.tokenservice_client.InvalidGrant">
<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.tokenservice_client.</span></code><code class="sig-name descname"><span class="pre">InvalidGrant</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.InvalidGrant" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.Error" title="com.vmware.vcenter.tokenservice_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.tokenservice_client.Error</span></code></a></p>
<p>The <code class="docutils literal notranslate"><span class="pre">InvalidGrant</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) <p>Stack of one or more localizable messages for human exception
consumers.</p>
<p>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.</p>
</p></li>
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Data to facilitate clients responding to the method reporting a
standard exception to indicating that it was unable to complete
successfully.</p>
<p>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.
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> 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.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt id="com.vmware.vcenter.tokenservice_client.InvalidRequest">
<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.tokenservice_client.</span></code><code class="sig-name descname"><span class="pre">InvalidRequest</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.InvalidRequest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.Error" title="com.vmware.vcenter.tokenservice_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.tokenservice_client.Error</span></code></a></p>
<p>The <code class="docutils literal notranslate"><span class="pre">InvalidRequest</span></code> exception indicates that
<a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec" title="com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec</span></code></a> is missing a required parameter,
includes an unsupported parameter value (other than
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.grant_type</span></code>)</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) <p>Stack of one or more localizable messages for human exception
consumers.</p>
<p>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.</p>
</p></li>
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Data to facilitate clients responding to the method reporting a
standard exception to indicating that it was unable to complete
successfully.</p>
<p>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.
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> 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.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt id="com.vmware.vcenter.tokenservice_client.InvalidScope">
<em class="property"><span class="pre">exception</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.tokenservice_client.</span></code><code class="sig-name descname"><span class="pre">InvalidScope</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.InvalidScope" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.Error" title="com.vmware.vcenter.tokenservice_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.tokenservice_client.Error</span></code></a></p>
<p>The <code class="docutils literal notranslate"><span class="pre">InvalidScope</span></code> exception indicates requested scope is invalid,
unknown, malformed, or exceeds the scope granted by the resource owner.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) <p>Stack of one or more localizable messages for human exception
consumers.</p>
<p>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.</p>
</p></li>
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Data to facilitate clients responding to the method reporting a
standard exception to indicating that it was unable to complete
successfully.</p>
<p>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.
<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> 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.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.tokenservice_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.tokenservice_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.tokenservice_client.</span></code><code class="sig-name descname"><span class="pre">TokenExchange</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TokenExchange</span></code> interface provides possibility to exchange between
different tokens types. Implementation of “OAuth 2.0 Token Exchange”
standard (<a class="reference external" href="https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-12">https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-12</a>).</p>
<p>This interface has been deprecated in the vSphere 7.0 U2 release. Use
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.authentication.Token</span></code> instead.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.ACCESS_TOKEN_TYPE">
<code class="sig-name descname"><span class="pre">ACCESS_TOKEN_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'urn:ietf:params:oauth:token-type:access_token'</span></em><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.ACCESS_TOKEN_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Class attribute indicates OAuth 2.0 access token type.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.BEARER_TOKEN_METHOD_TYPE">
<code class="sig-name descname"><span class="pre">BEARER_TOKEN_METHOD_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Bearer'</span></em><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.BEARER_TOKEN_METHOD_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Class attribute indicates that the security token is a bearer token.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ExchangeSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">grant_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">audience</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">requested_token_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject_token_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actor_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actor_token_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec</span></code> class contains arguments required for
token exchange.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>grant_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The value of <a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.TOKEN_EXCHANGE_GRANT" title="com.vmware.vcenter.tokenservice_client.TokenExchange.TOKEN_EXCHANGE_GRANT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.TOKEN_EXCHANGE_GRANT</span></code></a> indicates
that a token exchange is being performed.</p></li>
<li><p><strong>resource</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>audience</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The logical name of the target service where the client intends to
use the requested security token. This serves a purpose similar to
the <code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.resource</span></code> 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.</p></li>
<li><p><strong>scope</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>requested_token_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.resource</span></code> or
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.audience</span></code> parameter.
if can be inferred from other arguments or not needed for specific
case of exchange.</p></li>
<li><p><strong>subject_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>subject_token_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) An identifier, that indicates the type of the security token in the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.subject_token</span></code> parameter.</p></li>
<li><p><strong>actor_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>actor_token_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) An identifier, that indicates the type of the security token in the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.actor_token</span></code> parameter.
if <code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.actor_token</span></code> parameter is not
present.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.ID_TOKEN_TYPE">
<code class="sig-name descname"><span class="pre">ID_TOKEN_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'urn:ietf:params:oauth:token-type:id_token'</span></em><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.ID_TOKEN_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Class attribute indicates OIDC ID token type.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">access_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issued_token_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expires_in</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">refresh_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TokenExchange.Info</span></code> class contains data that represents successful
token exchange response.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>access_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The security token issued by the server in response to the token
exchange request. Token is base64-encoded.</p></li>
<li><p><strong>issued_token_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) An identifier, that indicates the type of the security token in the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.Info.access_token</span></code> parameter.</p></li>
<li><p><strong>token_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) A case-insensitive value specifying the method of using the access
token issued.</p></li>
<li><p><strong>expires_in</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The validity lifetime, in seconds, of the token issued by the
server.
if not applicable for issued token.</p></li>
<li><p><strong>scope</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Scope of the issued security token.
if the scope of the issued security token is identical to the scope
requested by the client.</p></li>
<li><p><strong>refresh_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.N_A_TOKEN_METHOD_TYPE">
<code class="sig-name descname"><span class="pre">N_A_TOKEN_METHOD_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'N_A'</span></em><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.N_A_TOKEN_METHOD_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Class attribute indicates <code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.Info.token_type</span></code> identifier is
not applicable in that context.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.REFRESH_TOKEN_TYPE">
<code class="sig-name descname"><span class="pre">REFRESH_TOKEN_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'urn:ietf:params:oauth:token-type:refresh_token'</span></em><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.REFRESH_TOKEN_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Class attribute indicates OAuth 2.0 refresh token type.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.SAML1_TOKEN_TYPE">
<code class="sig-name descname"><span class="pre">SAML1_TOKEN_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'urn:ietf:params:oauth:token-type:saml1'</span></em><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.SAML1_TOKEN_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Class attribute indicates base64-encoded SAML 1.1 token type.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.SAML2_TOKEN_TYPE">
<code class="sig-name descname"><span class="pre">SAML2_TOKEN_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'urn:ietf:params:oauth:token-type:saml2'</span></em><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.SAML2_TOKEN_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Class attribute indicates base64-encoded SAML 2.0 token type.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.TOKEN_EXCHANGE_GRANT">
<code class="sig-name descname"><span class="pre">TOKEN_EXCHANGE_GRANT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'urn:ietf:params:oauth:grant-type:token-exchange'</span></em><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.TOKEN_EXCHANGE_GRANT" title="Permalink to this definition"></a></dt>
<dd><p>Class attribute indicates that token exchange grant type.</p>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.tokenservice_client.TokenExchange.exchange">
<code class="sig-name descname"><span class="pre">exchange</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.exchange" title="Permalink to this definition"></a></dt>
<dd><p>Exchanges incoming token based on the spec and current client
authorization data.</p>
<p>This method has been deprecated in the vSphere 7.0 U2 release. Use
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.authentication.Token#issue</span></code> instead.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec" title="com.vmware.vcenter.tokenservice_client.TokenExchange.ExchangeSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec</span></code></a>) <code class="docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec</span></code> class contains arguments that define
exchange process.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.Info" title="com.vmware.vcenter.tokenservice_client.TokenExchange.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">TokenExchange.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.TokenExchange.Info" title="com.vmware.vcenter.tokenservice_client.TokenExchange.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">TokenExchange.Info</span></code></a> class that contains new token.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.InvalidGrant" title="com.vmware.vcenter.tokenservice_client.InvalidGrant"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidGrant</span></code></a>
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.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.tokenservice_client.InvalidScope" title="com.vmware.vcenter.tokenservice_client.InvalidScope"><code class="xref py py-class docutils literal notranslate"><span class="pre">InvalidScope</span></code></a>
If the server is unwilling or unable to issue a token for all the
target services indicated by the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.resource</span></code> or
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TokenExchange.ExchangeSpec.audience</span></code> parameters.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if authorization is not given to a caller.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.topology_client">
<span id="com-vmware-vcenter-topology-client-module"></span><h2>com.vmware.vcenter.topology_client module<a class="headerlink" href="#module-com.vmware.vcenter.topology_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.topology_client</span></code> module provides classes to retrieve
all vCenter and Platform Services Controller nodes and replication status in
the topology.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.topology_client.Nodes">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.topology_client.</span></code><code class="sig-name descname"><span class="pre">Nodes</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.Nodes" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Nodes</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.topology_client.Nodes.ApplianceType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ApplianceType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Nodes.ApplianceType</span></code> class defines values for valid appliance types
for the vCenter and Platform Services Controller node. See
<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.Info" title="com.vmware.vcenter.topology_client.Nodes.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.Info</span></code></a>. This enumeration was added in vSphere API 6.7.2.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ApplianceType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.topology_client.Nodes.ApplianceType.PSC_EXTERNAL">
<code class="sig-name descname"><span class="pre">PSC_EXTERNAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceType(string='PSC_EXTERNAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.PSC_EXTERNAL" title="Permalink to this definition"></a></dt>
<dd><p>An external Platform Services Controller. This class attribute was added in
vSphere API 6.7.2.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED">
<code class="sig-name descname"><span class="pre">VCSA_EMBEDDED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceType(string='VCSA_EMBEDDED')</span></em><a class="headerlink" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED" title="Permalink to this definition"></a></dt>
<dd><p>vCenter Server Appliance with an embedded Platform Services Controller.
This class attribute was added in vSphere API 6.7.2.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EXTERNAL">
<code class="sig-name descname"><span class="pre">VCSA_EXTERNAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ApplianceType(string='VCSA_EXTERNAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EXTERNAL" title="Permalink to this definition"></a></dt>
<dd><p>vCenter Server Appliance with an external Platform Services Controller.
This class attribute was added in vSphere API 6.7.2.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.topology_client.Nodes.FilterSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">types</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Nodes.FilterSpec</span></code> class contains attribute used to filter the
results when listing vCenter and Platform Services Controller nodes (see
<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.list" title="com.vmware.vcenter.topology_client.Nodes.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Nodes.list()</span></code></a>). This class was added in vSphere API 6.7.2.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>types</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.ApplianceType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Types of the appliance that a vCenter and Platform Services
Controller node must be to match the filter (see
<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.ApplianceType</span></code></a>. This attribute was added in vSphere
API 6.7.2.
If None or empty, node of any ApplianceType match the filter.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.topology_client.Nodes.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replication_partners</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_affinity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.Nodes.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Nodes.Info</span></code> class contains vCenter or Platform Services Controller
node details. This class was added in vSphere API 6.7.2.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Domain name of the node. This attribute was added in vSphere API
6.7.2.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.ApplianceType</span></code></a>) Appliance type of the node. This attribute was added in vSphere API
6.7.2.</p></li>
<li><p><strong>replication_partners</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) List of 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will contain
identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.ApplianceType.VCSA_EMBEDDED</span></code></a> or
<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.PSC_EXTERNAL" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.PSC_EXTERNAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.ApplianceType.PSC_EXTERNAL</span></code></a>.</p></li>
<li><p><strong>client_affinity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EXTERNAL" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EXTERNAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.ApplianceType.VCSA_EXTERNAL</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.topology_client.Nodes.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replication_partners</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_affinity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.Nodes.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Nodes.Summary</span></code> class contains commonly used information of vCenter
or Platform Services Controller node. This class was added in vSphere API
6.7.2.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>node</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.ApplianceType</span></code></a>) Appliance type of the node. This attribute was added in vSphere API
6.7.2.</p></li>
<li><p><strong>replication_partners</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) List of 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will contain
identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.ApplianceType.VCSA_EMBEDDED</span></code></a> or
<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.PSC_EXTERNAL" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.PSC_EXTERNAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.ApplianceType.PSC_EXTERNAL</span></code></a>.</p></li>
<li><p><strong>client_affinity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EXTERNAL" title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EXTERNAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.ApplianceType.VCSA_EXTERNAL</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.topology_client.Nodes.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.Nodes.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve details for a given identifier of the vCenter or Platform
Services Controller node. This method was added in vSphere API 6.7.2.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>node</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.Info" title="com.vmware.vcenter.topology_client.Nodes.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>vCenter or Platform Services Controller node details with
replication partners and client affinity information as applicable.
See <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.Info" title="com.vmware.vcenter.topology_client.Nodes.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.Info</span></code></a>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if a node doesnt exist for given node identifier.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.topology_client.Nodes.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.Nodes.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about all vCenter and Platform Services Controller
nodes matching the <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec" title="com.vmware.vcenter.topology_client.Nodes.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.FilterSpec</span></code></a>. This method was added in
vSphere API 6.7.2.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec" title="com.vmware.vcenter.topology_client.Nodes.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specification of matching vCenter and Platform Services Controller
nodes for which information should be returned.
If None, the behavior is equivalent to a <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec" title="com.vmware.vcenter.topology_client.Nodes.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.FilterSpec</span></code></a>
with all attributes None which means all nodes match the filter.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.list" title="com.vmware.vcenter.topology_client.Nodes.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.Summary" title="com.vmware.vcenter.topology_client.Nodes.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>commonly used information for all vCenter and Platform Services
Controller nodes matching the <a class="reference internal" href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec" title="com.vmware.vcenter.topology_client.Nodes.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nodes.FilterSpec</span></code></a>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.FilterSpec.types</span></code> attribute contains a value
that is not supported.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.topology_client.ReplicationStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.topology_client.</span></code><code class="sig-name descname"><span class="pre">ReplicationStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.ReplicationStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ReplicationStatus</span></code> interface provides methods to retrieve
replication status information of vCenter and Platform Services Controller
nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.Info.type</span></code>).
This class was added in vSphere API 6.7.2.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ReplicationStatus.FilterSpec</span></code> class contains attribute used to
filter the results when listing replication status for the vCenter and
Platform Services Controller nodes (see <a class="reference internal" href="#com.vmware.vcenter.topology_client.ReplicationStatus.list" title="com.vmware.vcenter.topology_client.ReplicationStatus.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">ReplicationStatus.list()</span></code></a>) of
type VCSA_EMBEDDED/PSC_EXTERNAL (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.Info.type</span></code>). This class
was added in vSphere API 6.7.2.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>nodes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Identifier that a vCenter and Platform Services Controller node
must have to match the filter. (see
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ReplicationStatus.Summary.node</span></code>). 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will contain
identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.
If None or empty, all vCenter and Platform Services Controller
nodes of type VCSA_EMBEDDED/PSC_EXTERNAL match the filter.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.topology_client.ReplicationStatus.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replication_partner</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partner_available</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status_available</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replicating</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">change_lag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.ReplicationStatus.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ReplicationStatus.Summary</span></code> class contains replication information of
partner vCenter or Platform Services Controller node of type
VCSA_EMBEDDED/PSC_EXTERNAL (see <code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.Info.type</span></code>). This class was
added in vSphere API 6.7.2.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>node</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.</p></li>
<li><p><strong>replication_partner</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.VCenter.name</span></code>.</p></li>
<li><p><strong>partner_available</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Indicates if the VMware Directory Service on partner is reachable
or not. This attribute was added in vSphere API 6.7.2.</p></li>
<li><p><strong>status_available</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) 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.</p></li>
<li><p><strong>replicating</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ReplicationStatus.Summary.partner_available</span></code> or
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ReplicationStatus.Summary.status_available</span></code> is false.</p></li>
<li><p><strong>change_lag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Number of 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
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ReplicationStatus.Summary.partner_available</span></code> or
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ReplicationStatus.Summary.status_available</span></code> is false.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.topology_client.ReplicationStatus.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.ReplicationStatus.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns the replication information of vCenter and Platform Services
Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Nodes.Info.type</span></code>) matching the
<a class="reference internal" href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec" title="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReplicationStatus.FilterSpec</span></code></a>. This method was added in vSphere
API 6.7.2.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec" title="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReplicationStatus.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Specification of matching vCenter and Platform Services Controller
nodes for which information should be returned.
If None, the behavior is equivalent to a
<a class="reference internal" href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec" title="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReplicationStatus.FilterSpec</span></code></a> with all attributes None
which means all vCenter and Platform Services Controller nodes of
type VCSA_EMBEDDED/PSC_EXTERNAL match the filter.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.topology_client.ReplicationStatus.list" title="com.vmware.vcenter.topology_client.ReplicationStatus.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.topology_client.ReplicationStatus.Summary" title="com.vmware.vcenter.topology_client.ReplicationStatus.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReplicationStatus.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Commonly used replication information about vCenter and Platform
Services Controller nodes matching the
<a class="reference internal" href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec" title="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReplicationStatus.FilterSpec</span></code></a>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">ReplicationStatus.FilterSpec.nodes</span></code> attribute
contains a invalid value.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.topology_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.topology_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.topology_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.trusted_infrastructure_client">
<span id="com-vmware-vcenter-trusted-infrastructure-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure_client module<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client</span></code> 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.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.</span></code><code class="sig-name descname"><span class="pre">NetworkAddress</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NetworkAddress</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The IP address or DNS resolvable name of the service. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The port of the service. This attribute was added in vSphere API
7.0.0.0.
If None, port 443 will be used.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.Principal">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.</span></code><code class="sig-name descname"><span class="pre">Principal</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.Principal" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Principal</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.Principal.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">certificates</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issuer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">principal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.Principal.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Principal.Info</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>certificates</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain" title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">X509CertChain</span></code></a>) The certificates used by the STS to sign tokens for this vCenter.
This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>issuer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The service which created and signed the security token. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>principal</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal" title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal"><code class="xref py py-class docutils literal notranslate"><span class="pre">StsPrincipal</span></code></a>) 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.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The user-friednly name of the vCenter. This attribute was added in
vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.Principal.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.Principal.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about the STS used by this vCenter instance. This
method was added in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.Principal.Info" title="com.vmware.vcenter.trusted_infrastructure_client.Principal.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Principal.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>\&#64;{link Info} a summary containing the certificates used to sign
tokens and the solution user used to retrieve them.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ReadStsInfo</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.</span></code><code class="sig-name descname"><span class="pre">StsPrincipal</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">StsPrincipal</span></code> class contains a IDM principal. This class was added
in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalId" title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalId"><code class="xref py py-class docutils literal notranslate"><span class="pre">StsPrincipalId</span></code></a>) The principals ID. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType" title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType"><code class="xref py py-class docutils literal notranslate"><span class="pre">StsPrincipalType</span></code></a>) The type of the principal (user or group). This attribute was added
in vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalId">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.</span></code><code class="sig-name descname"><span class="pre">StsPrincipalId</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalId" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">StsPrincipalId</span></code> class contains an IDM principal ID. This class was
added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The principals username. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The principals domain. This attribute was added in vSphere API
7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.</span></code><code class="sig-name descname"><span class="pre">StsPrincipalType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">StsPrincipalType</span></code> enum can be either users or groups. This
enumeration was added in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType" title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType"><code class="xref py py-class docutils literal notranslate"><span class="pre">StsPrincipalType</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType.STS_GROUP">
<code class="sig-name descname"><span class="pre">STS_GROUP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">StsPrincipalType(string='STS_GROUP')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType.STS_GROUP" title="Permalink to this definition"></a></dt>
<dd><p>The principal is a group. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType.STS_USER">
<code class="sig-name descname"><span class="pre">STS_USER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">StsPrincipalType(string='STS_USER')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType.STS_USER" title="Permalink to this definition"></a></dt>
<dd><p>The principal is a user. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.</span></code><code class="sig-name descname"><span class="pre">TrustAuthorityClusters</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TrustAuthorityClusters</span></code> class manages all the Trust Authority
Components on each Trust Authority Host in the cluster. The
<code class="docutils literal notranslate"><span class="pre">TrustAuthorityClusters</span></code> class transforms a ClusterComputeResource into
Trust Authority Cluster and vice versa. This class was added in vSphere API
7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.FilterSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TrustAuthorityClusters.FilterSpec</span></code> class contains the data necessary
for identifying a <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters</span></code></a>. This class was added in
vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
cluster If {\&#64;term.unset} return all Trust Authority Clusters.</p></li>
<li><p><strong>state</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters.State</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The state of the <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters</span></code></a>. This attribute
was added in vSphere API 7.0.0.0.
state If {\&#64;term.unset} return all Trust Authority Clusters.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TrustAuthorityClusters.Info</span></code> class contains the data necessary for
retrieving the <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters</span></code></a> info. This class was added
in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters.State</span></code></a>) The state of the cluster. This attribute was added in vSphere API
7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">State</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TrustAuthorityClusters.State</span></code> class defines the states of the
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters</span></code></a>. This enumeration was added in vSphere API
7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State.DISABLE">
<code class="sig-name descname"><span class="pre">DISABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='DISABLE')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State.DISABLE" title="Permalink to this definition"></a></dt>
<dd><p>The <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters</span></code></a> is disabled. This class attribute was
added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State.ENABLE">
<code class="sig-name descname"><span class="pre">ENABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='ENABLE')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State.ENABLE" title="Permalink to this definition"></a></dt>
<dd><p>The <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters</span></code></a> is enabled. This class attribute was
added in vSphere API 7.0.0.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TrustAuthorityClusters.Summary</span></code> class contains information about
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters</span></code></a> id and state. This class was added in
vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters.State</span></code></a>) The state of the <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters</span></code></a>. This attribute
was added in vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TrustAuthorityClusters.UpdateSpec</span></code> class contains the data necessary
for update of a <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters</span></code></a>. This class was added in
vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters.State</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The state of the <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters</span></code></a>. This attribute
was added in vSphere API 7.0.0.0.
state If {\&#64;term.unset} no operation is performed.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the result of the last Update operation which matches the cluster
id. This method was added in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Cluster id.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.Info" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.Info" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters.Info</span></code></a> instance which contains
information about the state of the cluster.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">cluster</span></code> doesnt match to any ClusterComputeResource.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ReadTrustedHosts</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.View</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of clusters for this vCenter instance which matches the
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters.FilterSpec</span></code></a>. This method was added in
vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Return only clusters matching the specified filters.
If {\&#64;term.unset} return all clusters.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.list" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.Summary" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.Summary" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters.Summary</span></code></a> for a
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters</span></code></a>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ReadTrustedHosts</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">TrustAuthorityClusters.FilterSpec.cluster</span></code>
requires <code class="docutils literal notranslate"><span class="pre">System.View</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.update_task">
<code class="sig-name descname"><span class="pre">update_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.update_task" title="Permalink to this definition"></a></dt>
<dd><p>Updates the state of a cluster. This method was added in vSphere API
7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Cluster id.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.UpdateSpec" title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustAuthorityClusters.UpdateSpec</span></code></a>) The specification for update of a cluster.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> doesnt match to any cluster compute resource.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.</span></code><code class="sig-name descname"><span class="pre">X509CertChain</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cert_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">X509CertChain</span></code> class contains x509 certificate chain. This class was
added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cert_chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Certificate chain in base64 format. This attribute was added in
vSphere API 7.0.0.0.</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.vcha_client">
<span id="com-vmware-vcenter-vcha-client-module"></span><h2>com.vmware.vcenter.vcha_client module<a class="headerlink" href="#module-com.vmware.vcenter.vcha_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client</span></code> module provides classes for deploying
and monitoring a vCenter High Availability (VCHA) Cluster.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.CertificateInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vcha_client.</span></code><code class="sig-name descname"><span class="pre">CertificateInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ssl_thumbprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.CertificateInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CertificateInfo</span></code> Class contains information about the SSL
certificate for a management vCenter server. This class was added in
vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>ssl_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The SHA-256 thumbprint of the SSL certificate for a management
vCenter server. This attribute was added in vSphere API 6.7.1.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vcha_client.</span></code><code class="sig-name descname"><span class="pre">Cluster</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.ActiveSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ActiveSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ha_network_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_ip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ActiveSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.ActiveSpec</span></code> class contains the deploy specification for the
Active Node of the VCHA cluster. This class was added in vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ha_network_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.NetworkType" title="com.vmware.vcenter.vcha_client.NetworkType"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The type of the Network object used by the HA network.
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is set, then
the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network_type</span></code> field must be set.
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is None,
then the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network_type</span></code> attribute is
ignored. This attribute was added in vSphere API 6.7.1.
If None and the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is
unset, then the second NIC is assumed to be already configured.
If None and the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is
set, then an error is reported.</p></li>
<li><p><strong>ha_network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The identifier of the Network object used for the HA network.
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is set, then
the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network_type</span></code> attribute must be
set.
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is None,
then the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network_type</span></code> 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:
<code class="docutils literal notranslate"><span class="pre">Network:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">Network:VCenter</span></code>.
If None and the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network_type</span></code>
attribute is unset, then the second NIC is assumed to be already
configured.
If None and the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is
set, then an error is reported.</p></li>
<li><p><strong>ha_ip</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpSpec" title="com.vmware.vcenter.vcha_client.IpSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpSpec</span></code></a>) IP specification for the HA network. This attribute was added in
vSphere API 6.7.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterMode">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ClusterMode</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ClusterMode" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.ClusterMode</span></code> class defines the possible modes for a VCHA
Cluster. This enumeration was added in vSphere API 6.7.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterMode</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterMode.DISABLED">
<code class="sig-name descname"><span class="pre">DISABLED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ClusterMode(string='DISABLED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ClusterMode.DISABLED" title="Permalink to this definition"></a></dt>
<dd><p>VCHA Cluster is disabled. State replication between the Active and Passive
node is disabled and automatic failover is not allowed. This class
attribute was added in vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterMode.ENABLED">
<code class="sig-name descname"><span class="pre">ENABLED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ClusterMode(string='ENABLED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ClusterMode.ENABLED" title="Permalink to this definition"></a></dt>
<dd><p>VCHA Cluster is enabled. State replication between the Active and Passive
node is enabled and automatic failover is allowed. This class attribute was
added in vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterMode.MAINTENANCE">
<code class="sig-name descname"><span class="pre">MAINTENANCE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ClusterMode(string='MAINTENANCE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ClusterMode.MAINTENANCE" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterState">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ClusterState</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.ClusterState</span></code> class defines the possible for a VCHA Cluster.
This enumeration was added in vSphere API 6.7.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterState</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterState.DEGRADED">
<code class="sig-name descname"><span class="pre">DEGRADED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ClusterState(string='DEGRADED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState.DEGRADED" title="Permalink to this definition"></a></dt>
<dd><p>A VCHA Cluster is said to be in a degraded state for either or all of the
following reasons:</p>
<ul class="simple">
<li><p>There is a node loss.</p></li>
<li><p>State replication between the Active and Passive node fails.</p></li>
</ul>
<p>. This class attribute was added in vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterState.HEALTHY">
<code class="sig-name descname"><span class="pre">HEALTHY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ClusterState(string='HEALTHY')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState.HEALTHY" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.ClusterState.ISOLATED">
<code class="sig-name descname"><span class="pre">ISOLATED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ClusterState(string='ISOLATED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState.ISOLATED" title="Permalink to this definition"></a></dt>
<dd><p>All three nodes are isolated from each other. This class attribute was
added in vSphere API 6.7.1.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.ConfigState">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ConfigState</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.ConfigState</span></code> class defines the VCHA configuration state.
This enumeration was added in vSphere API 6.7.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigState</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.ConfigState.CONFIGURED">
<code class="sig-name descname"><span class="pre">CONFIGURED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigState(string='CONFIGURED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState.CONFIGURED" title="Permalink to this definition"></a></dt>
<dd><p>VCHA cluster is configured. This class attribute was added in vSphere API
6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.ConfigState.INVALID">
<code class="sig-name descname"><span class="pre">INVALID</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigState(string='INVALID')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState.INVALID" title="Permalink to this definition"></a></dt>
<dd><p>VCHA cluster is in an invalid/dirty state. This class attribute was added
in vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.ConfigState.NOTCONFIGURED">
<code class="sig-name descname"><span class="pre">NOTCONFIGURED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigState(string='NOTCONFIGURED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState.NOTCONFIGURED" title="Permalink to this definition"></a></dt>
<dd><p>VCHA cluster is not configured. This class attribute was added in vSphere
API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.ConfigState.PREPARED">
<code class="sig-name descname"><span class="pre">PREPARED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigState(string='PREPARED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState.PREPARED" title="Permalink to this definition"></a></dt>
<dd><p>vCenter server appliance has been prepared for VCHA cluster configuration.
This class attribute was added in vSphere API 6.7.1.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.DeploySpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DeploySpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vc_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deployment</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">passive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">witness</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.DeploySpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.DeploySpec</span></code> class contains the deploy specification for the
three nodes of a VCHA cluster. This class was added in vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vc_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.CredentialsSpec" title="com.vmware.vcenter.vcha_client.CredentialsSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CredentialsSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Contains the active nodes 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.</p></li>
<li><p><strong>deployment</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.Type" title="com.vmware.vcenter.vcha_client.Cluster.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.Type</span></code></a>) Contains the deployment type. This attribute was added in vSphere
API 6.7.1.</p></li>
<li><p><strong>active</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.ActiveSpec" title="com.vmware.vcenter.vcha_client.Cluster.ActiveSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.ActiveSpec</span></code></a>) Contains the active nodes network configuration. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>passive</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.PassiveSpec" title="com.vmware.vcenter.vcha_client.Cluster.PassiveSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.PassiveSpec</span></code></a>) Contains the passive nodes placement configuration. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>witness</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.WitnessSpec" title="com.vmware.vcenter.vcha_client.Cluster.WitnessSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.WitnessSpec</span></code></a>) Contains the witness nodes placement configuration. This attribute
was added in vSphere API 6.7.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.ErrorCondition">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ErrorCondition</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recommendation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.ErrorCondition" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.ErrorCondition</span></code> class contains an error condition and a
recommendation to handle the error condition. This class was added in
vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>error</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) Contains an error condition. This attribute was added in vSphere
API 6.7.1.</p></li>
<li><p><strong>recommendation</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Contains a recommendation on handling the error condition. This
attribute was added in vSphere API 6.7.1.
If None, there is no tip for the error condition.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config_state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">node1</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">node2</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">witness</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">health_state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">health_exception</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">health_warnings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">manual_failover_allowed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_failover_allowed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.Info</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>config_state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState" title="com.vmware.vcenter.vcha_client.Cluster.ConfigState"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.ConfigState</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Configuration state of the VCHA cluster.
The active nodes 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.</p></li>
<li><p><strong>node1</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeInfo" title="com.vmware.vcenter.vcha_client.Cluster.NodeInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.NodeInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Node configuration information for the VCHA cluster. This attribute
was added in vSphere API 6.7.1.
If None, then the information is unavailable.</p></li>
<li><p><strong>node2</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeInfo" title="com.vmware.vcenter.vcha_client.Cluster.NodeInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.NodeInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>witness</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.WitnessInfo" title="com.vmware.vcenter.vcha_client.Cluster.WitnessInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.WitnessInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>mode</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.ClusterMode" title="com.vmware.vcenter.vcha_client.Cluster.ClusterMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.ClusterMode</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>health_state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState" title="com.vmware.vcenter.vcha_client.Cluster.ClusterState"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.ClusterState</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>health_exception</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>health_warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.ErrorCondition" title="com.vmware.vcenter.vcha_client.Cluster.ErrorCondition"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.ErrorCondition</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>manual_failover_allowed</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>auto_failover_allowed</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.IpFamily">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">IpFamily</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.IpFamily</span></code> class defines the IP address family. This
enumeration was added in vSphere API 6.7.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpFamily" title="com.vmware.vcenter.vcha_client.IpFamily"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpFamily</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV4">
<code class="sig-name descname"><span class="pre">IPV4</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpFamily(string='IPV4')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV4" title="Permalink to this definition"></a></dt>
<dd><p>IPV4 address family. This class attribute was added in vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV6">
<code class="sig-name descname"><span class="pre">IPV6</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpFamily(string='IPV6')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV6" title="Permalink to this definition"></a></dt>
<dd><p>IPV6 address family. This class attribute was added in vSphere API 6.7.1.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.IpInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">IpInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ip_family</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ipv4</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ipv6</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gateway_ip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.IpInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.IpInfo</span></code> class contains attributes related to an ip. This
class was added in vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ip_family</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily" title="com.vmware.vcenter.vcha_client.Cluster.IpFamily"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.IpFamily</span></code></a>) Family of the ip. This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>ipv4</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.Ipv4Info" title="com.vmware.vcenter.vcha_client.Cluster.Ipv4Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.Ipv4Info</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">ipFamily</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV4" title="com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV4"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.IpFamily.IPV4</span></code></a>.</p></li>
<li><p><strong>ipv6</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.Ipv6Info" title="com.vmware.vcenter.vcha_client.Cluster.Ipv6Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.Ipv6Info</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">ipFamily</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV6" title="com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV6"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.IpFamily.IPV6</span></code></a>.</p></li>
<li><p><strong>gateway_ip</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Gateway IP address. This attribute was added in vSphere API 6.7.1.
If None, no gateway is specified.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.Ipv4Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Ipv4Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subnet_mask</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.Ipv4Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.Ipv4Info</span></code> class contains attributes to describe IPV4
information of the configured network interface. This class was added in
vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) IP address of the configured network interface. This attribute was
added in vSphere API 6.7.1.</p></li>
<li><p><strong>subnet_mask</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The subnet mask of the interface. This attribute was added in
vSphere API 6.7.1.</p></li>
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The CIDR prefix of the interface. This attribute was added in
vSphere API 6.7.1.
If None , then the subnet mask is invalid.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.Ipv6Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Ipv6Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.Ipv6Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.Ipv6Info</span></code> class contains attributes to describe IPV6
information of the configured network interface. This class was added in
vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) IP address of the configured network interface. This attribute was
added in vSphere API 6.7.1.</p></li>
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The CIDR prefix of the interface. This attribute was added in
vSphere API 6.7.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NodeInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">failover_ip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_ip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">runtime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.NodeInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.NodeInfo</span></code> class defines the configuration information for
the active and passive nodes in the cluster. This class was added in
vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>failover_ip</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.IpInfo" title="com.vmware.vcenter.vcha_client.Cluster.IpInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.IpInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 nodes management vCenter server credentials are not
required to populate <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.NodeInfo.failover_ip</span></code>. 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.</p></li>
<li><p><strong>ha_ip</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.IpInfo" title="com.vmware.vcenter.vcha_client.Cluster.IpInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.IpInfo</span></code></a>) VCHA Cluster network configuration of the node. All cluster
communication (state replication, heartbeat, cluster messages)
happens over this network.
The active nodes management vCenter server credentials are not
required to populate this <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.NodeInfo.ha_ip</span></code>. This
attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>runtime</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo" title="com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.NodeRuntimeInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Runtime information for the node in the VCHA Cluster.
The active nodes management vCenter server credentials are
required to populate some attributes of
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.NodeInfo.runtime</span></code>. 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeRole">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NodeRole</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.NodeRole</span></code> class defines the role node can be in a VCHA
Cluster. This enumeration was added in vSphere API 6.7.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">NodeRole</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeRole.ACTIVE">
<code class="sig-name descname"><span class="pre">ACTIVE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NodeRole(string='ACTIVE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole.ACTIVE" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeRole.PASSIVE">
<code class="sig-name descname"><span class="pre">PASSIVE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NodeRole(string='PASSIVE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole.PASSIVE" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeRole.WITNESS">
<code class="sig-name descname"><span class="pre">WITNESS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NodeRole(string='WITNESS')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole.WITNESS" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NodeRuntimeInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">placement</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.NodeRuntimeInfo</span></code> class describes a nodes runtime
information in a VCHA Cluster. This class was added in vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeState" title="com.vmware.vcenter.vcha_client.Cluster.NodeState"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.NodeState</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Last known state of the node.
The active nodes management vCenter server credentials are not
required to populate <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.NodeRuntimeInfo.state</span></code>. 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.</p></li>
<li><p><strong>role</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole" title="com.vmware.vcenter.vcha_client.Cluster.NodeRole"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.NodeRole</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Last known role of the node.
The active nodes management vCenter server credentials are not
required to populate <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.NodeRuntimeInfo.role</span></code>. 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.</p></li>
<li><p><strong>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.PlacementInfo" title="com.vmware.vcenter.vcha_client.PlacementInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlacementInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Placement information of the node.
The active nodes management vCenter server credentials are
required to populate most attributes of
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.NodeRuntimeInfo.placement</span></code>. 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeState">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NodeState</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.NodeState" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.NodeState</span></code> class defines possible state a node can be in a
VCHA Cluster. This enumeration was added in vSphere API 6.7.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">NodeState</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeState.DOWN">
<code class="sig-name descname"><span class="pre">DOWN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NodeState(string='DOWN')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.NodeState.DOWN" title="Permalink to this definition"></a></dt>
<dd><p>Node is down and has left the VCHA Cluster. This class attribute was added
in vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeState.UP">
<code class="sig-name descname"><span class="pre">UP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NodeState(string='UP')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.NodeState.UP" title="Permalink to this definition"></a></dt>
<dd><p>Node is up and has joined the VCHA Cluster. This class attribute was added
in vSphere API 6.7.1.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NodeVmInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bios_uuid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.NodeVmInfo</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine:VCenter</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine:VCenter</span></code>.</p></li>
<li><p><strong>bios_uuid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) BIOS UUID for the node. This attribute was added in vSphere API
6.7.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.PassiveSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">PassiveSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">placement</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_ip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">failover_ip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.PassiveSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.PassiveSpec</span></code> class contains the deploy specification for the
Passive Node of the VCHA cluster. This class was added in vSphere API
6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.PlacementSpec" title="com.vmware.vcenter.vcha_client.PlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlacementSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>ha_ip</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpSpec" title="com.vmware.vcenter.vcha_client.IpSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpSpec</span></code></a>) IP specification for the HA network. This attribute was added in
vSphere API 6.7.1.</p></li>
<li><p><strong>failover_ip</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpSpec" title="com.vmware.vcenter.vcha_client.IpSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.Type</span></code> class defines the possible deployment types for a VCHA
Cluster. This enumeration was added in vSphere API 6.7.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.Type.AUTO">
<code class="sig-name descname"><span class="pre">AUTO</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='AUTO')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.Type.AUTO" title="Permalink to this definition"></a></dt>
<dd><p>Passive and witness nodes are cloned automatically. This class attribute
was added in vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Cluster.Type.MANUAL">
<code class="sig-name descname"><span class="pre">MANUAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='MANUAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.Type.MANUAL" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.UndeploySpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UndeploySpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vc_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force_delete</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.UndeploySpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.UndeploySpec</span></code> class contains the undeploy specification for
a VCHA cluster. This class was added in vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vc_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.CredentialsSpec" title="com.vmware.vcenter.vcha_client.CredentialsSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CredentialsSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Contains the active nodes 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.</p></li>
<li><p><strong>force_delete</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>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.</p>
<ul>
<li><p>If true, the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.vms</span></code> attribute will be
ignored, the VCHA cluster specific information is removed, and the
passive and witness virtual machines will be deleted.</p></li>
<li><p>If false, the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.vms</span></code> attribute contains
the information identifying the passive and witness virtual
machines.</p></li>
<li><p>If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.vms</span></code> attribute is set, then it
will be validated prior to deleting the passive and witness virtual
machines and VCHA cluster specific information is removed.</p></li>
<li><p>If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.vms</span></code> 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.</p></li>
</ul>
<p>. This attribute was added in vSphere API 6.7.1.
If None, the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.vms</span></code> attribute contains
the information identifying the passive and witness virtual
machines.</p>
<ul>
<li><p>If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.vms</span></code> attribute is set, then it
will be validated prior to deleting the passive and witness virtual
machines. VCHA cluster specific information is removed.</p></li>
<li><p>If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.vms</span></code> 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.</p></li>
</ul>
</p></li>
<li><p><strong>vms</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.VmInfo" title="com.vmware.vcenter.vcha_client.Cluster.VmInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.VmInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>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.</p>
<p>If set, the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.force_delete</span></code> attribute
controls whether this information is validated.</p>
<ul>
<li><p>If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.force_delete</span></code> attribute is
true, then this information is ignored, VCHA cluster specific
information is removed and the passive and witness virtual machines
will be deleted.</p></li>
<li><p>If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.force_delete</span></code> 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.</p></li>
</ul>
<p>. This attribute was added in vSphere API 6.7.1.
If None, the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.force_delete</span></code> attribute
controls the deletion of the passive and witness virtual machines.</p>
<ul>
<li><p>If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.force_delete</span></code> attribute is
true, then the passive and witness virtual machines will be
deleted. VCHA cluster specific information is removed.</p></li>
<li><p>If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.UndeploySpec.force_delete</span></code> 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.</p></li>
</ul>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.VmInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VmInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">passive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">witness</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.VmInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.VmInfo</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>passive</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo" title="com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.NodeVmInfo</span></code></a>) The virtual machine information of the passive node. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>witness</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo" title="com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.NodeVmInfo</span></code></a>) The virtual machine information of the witness node. This attribute
was added in vSphere API 6.7.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.WitnessInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">WitnessInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ha_ip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">runtime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.WitnessInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.WitnessInfo</span></code> class defines the configuration and runtime
information for the witness node in the cluster. This class was added in
vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ha_ip</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.IpInfo" title="com.vmware.vcenter.vcha_client.Cluster.IpInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.IpInfo</span></code></a>) VCHA Cluster network configuration of the node. All cluster
communication (state replication, heartbeat, cluster messages)
happens over this network.
The active nodes management vCenter server credentials are not
required to populate <code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.WitnessInfo.ha_ip</span></code>. This
attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>runtime</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo" title="com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.NodeRuntimeInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Runtime information for the node in the VCHA Cluster.
The active nodes management vCenter server credentials are
required to populate some attributes of
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Cluster.WitnessInfo.runtime</span></code>. This attribute was added in
vSphere API 6.7.1.
If None, then the information is unavailable or the node is not
cloned yet.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Cluster.WitnessSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">WitnessSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">placement</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_ip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.WitnessSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Cluster.WitnessSpec</span></code> class contains the deploy specification for the
Witness Node of the VCHA cluster. This class was added in vSphere API
6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.PlacementSpec" title="com.vmware.vcenter.vcha_client.PlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">PlacementSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>ha_ip</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpSpec" title="com.vmware.vcenter.vcha_client.IpSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpSpec</span></code></a>) IP specification for the HA network. This attribute was added in
vSphere API 6.7.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vcha_client.Cluster.deploy_task">
<code class="sig-name descname"><span class="pre">deploy_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.deploy_task" title="Permalink to this definition"></a></dt>
<dd><p>Prepares, clones, and configures a VCHA cluster. This method was added
in vSphere API 6.7.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.DeploySpec" title="com.vmware.vcenter.vcha_client.Cluster.DeploySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.DeploySpec</span></code></a>) Contains the deploy specification for all three nodes of a VCHA
cluster.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the credentials provided for authenticating with the active
nodes management vCenter server are invalid.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
If the user has insufficient privilege to perform the operation.
Operation execution requires the Global.VCServer privilege.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnverifiedPeer" title="com.vmware.vapi.std.errors_client.UnverifiedPeer"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnverifiedPeer</span></code></a>
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be a class
that contains all the attributes defined in
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.CertificateInfo" title="com.vmware.vcenter.vcha_client.CertificateInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateInfo</span></code></a>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If any other error occurs.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vcha_client.Cluster.failover_task">
<code class="sig-name descname"><span class="pre">failover_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">planned</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.failover_task" title="Permalink to this definition"></a></dt>
<dd><p>Initiates failover from the active vCenter node to the passive node.</p>
<p>For forced failover, Active node immediately initiates a failover. This
may result into a data loss after failover.</p>
<p>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.</p>
<blockquote>
<div><p>A failover is allowed only in the following cases:</p>
</div></blockquote>
<ol class="arabic simple">
<li><p>Clusters mode is enabled and all cluster members are present.</p></li>
<li><p>Clusters mode is maintenance and all cluster members are present.</p></li>
</ol>
<p>. This method was added in vSphere API 6.7.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>planned</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) 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.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
If the user has insufficient privilege to perform the operation.
Operation execution requires the Global.VCServer privilege.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If any other error occurs.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vcha_client.Cluster.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vc_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partial</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieves the status of a VCHA cluster. This method was added in
vSphere API 6.7.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vc_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.CredentialsSpec" title="com.vmware.vcenter.vcha_client.CredentialsSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CredentialsSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Contains active nodes 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.</p></li>
<li><p><strong>partial</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>If true, then return only the information that does not require
connecting to the Active vCenter Server.</p>
<blockquote>
<div><p>If false or unset, then return all the information.</p>
</div></blockquote>
<p>If None, then return all the information.</p>
</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.Info" title="com.vmware.vcenter.vcha_client.Cluster.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Info structure containing the VCHA configuration and health
information.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the credentials provided for authenticating with the active
nodes management vCenter server are invalid.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
If the user has insufficient privilege to perform the operation.</p>
<ul class="simple">
<li><p>If <code class="docutils literal notranslate"><span class="pre">partial</span></code> is false or unset, then the operation execution
requires the Global.VCServer privilege.</p></li>
<li><p>If <code class="docutils literal notranslate"><span class="pre">partial</span></code> is true, then the operation execution requires the
System.Read privilege.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnverifiedPeer" title="com.vmware.vapi.std.errors_client.UnverifiedPeer"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnverifiedPeer</span></code></a>
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be a class
that contains all the attributes defined in
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.CertificateInfo" title="com.vmware.vcenter.vcha_client.CertificateInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateInfo</span></code></a>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If any other error occurs.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vcha_client.Cluster.undeploy_task">
<code class="sig-name descname"><span class="pre">undeploy_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Cluster.undeploy_task" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
<p>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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Cluster.UndeploySpec" title="com.vmware.vcenter.vcha_client.Cluster.UndeploySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cluster.UndeploySpec</span></code></a>) Contains the undeploy specification for a VCHA cluster.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the credentials provided for authenticating with the active
nodes management vCenter server are invalid.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If the passive virtual machine is not managed by the specified
vCenter server.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If the witness virtual machine is not managed by the specified
vCenter server.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
If the user has insufficient privilege to perform the operation.
Operation execution requires the Global.VCServer privilege.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnverifiedPeer" title="com.vmware.vapi.std.errors_client.UnverifiedPeer"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnverifiedPeer</span></code></a>
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be a class
that contains all the attributes defined in
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.CertificateInfo" title="com.vmware.vcenter.vcha_client.CertificateInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateInfo</span></code></a>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If any other error occurs.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.ConnectionSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vcha_client.</span></code><code class="sig-name descname"><span class="pre">ConnectionSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hostname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssl_thumbprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.ConnectionSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ConnectionSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) IP Address or DNS of the vCenter. This attribute was added in
vSphere API 6.7.1.</p></li>
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Port number. This attribute was added in vSphere API 6.7.1.
If None, port 443 will be used.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) SHA1 hash of the server SSL certificate. This attribute was added
in vSphere API 6.7.1.
If None, empty ssl thumbprint is assumed.</p></li>
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.CredentialsSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vcha_client.</span></code><code class="sig-name descname"><span class="pre">CredentialsSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">active_location</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.CredentialsSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CredentialsSpec</span></code> class contains information to connect to the
vCenter server managing the VCHA nodes. This class was added in vSphere API
6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>active_location</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.ConnectionSpec" title="com.vmware.vcenter.vcha_client.ConnectionSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConnectionSpec</span></code></a>) 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.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.DiskInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vcha_client.</span></code><code class="sig-name descname"><span class="pre">DiskInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datastore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datastore_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.DiskInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DiskInfo</span></code> class contains information to describe the storage
configuration of a vCenter virtual machine. This class was added in vSphere
API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">Datastore:VCenter</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">Datastore:VCenter</span></code>.</p></li>
<li><p><strong>datastore_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of the datastore. This attribute was added in vSphere API
6.7.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.DiskSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vcha_client.</span></code><code class="sig-name descname"><span class="pre">DiskSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datastore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.DiskSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DiskSpec</span></code> class contains information to describe the storage
configuration of a vCenter virtual machine. This class was added in vSphere
API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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:
<code class="docutils literal notranslate"><span class="pre">Datastore:VCenter</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">Datastore:VCenter</span></code>.
This field needs to be set. If None, then see
vim.vm.RelocateSpec.datastore.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.IpFamily">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vcha_client.</span></code><code class="sig-name descname"><span class="pre">IpFamily</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.IpFamily" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">IpFamily</span></code> class defines the Ip address family. This enumeration was
added in vSphere API 6.7.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpFamily" title="com.vmware.vcenter.vcha_client.IpFamily"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpFamily</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.IpFamily.IPV4">
<code class="sig-name descname"><span class="pre">IPV4</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpFamily(string='IPV4')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.IpFamily.IPV4" title="Permalink to this definition"></a></dt>
<dd><p>IPV4 address family. This class attribute was added in vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.IpFamily.IPV6">
<code class="sig-name descname"><span class="pre">IPV6</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IpFamily(string='IPV6')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.IpFamily.IPV6" title="Permalink to this definition"></a></dt>
<dd><p>IPv6 address family. This class attribute was added in vSphere API 6.7.1.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.IpSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vcha_client.</span></code><code class="sig-name descname"><span class="pre">IpSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ip_family</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ipv4</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ipv6</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_gateway</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dns_servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.IpSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">IpSpec</span></code> class contains IP information used to configure a network
interface. This class was added in vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ip_family</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpFamily" title="com.vmware.vcenter.vcha_client.IpFamily"><code class="xref py py-class docutils literal notranslate"><span class="pre">IpFamily</span></code></a>) Family of the IP address to configure the interface. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>ipv4</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Ipv4Spec" title="com.vmware.vcenter.vcha_client.Ipv4Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv4Spec</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">ipFamily</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpFamily.IPV4" title="com.vmware.vcenter.vcha_client.IpFamily.IPV4"><code class="xref py py-attr docutils literal notranslate"><span class="pre">IpFamily.IPV4</span></code></a>.</p></li>
<li><p><strong>ipv6</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Ipv6Spec" title="com.vmware.vcenter.vcha_client.Ipv6Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ipv6Spec</span></code></a>) 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 <code class="docutils literal notranslate"><span class="pre">ipFamily</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vcha_client.IpFamily.IPV6" title="com.vmware.vcenter.vcha_client.IpFamily.IPV6"><code class="xref py py-attr docutils literal notranslate"><span class="pre">IpFamily.IPV6</span></code></a>.</p></li>
<li><p><strong>default_gateway</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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.</p></li>
<li><p><strong>dns_servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Ipv4Spec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vcha_client.</span></code><code class="sig-name descname"><span class="pre">Ipv4Spec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subnet_mask</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Ipv4Spec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv4Spec</span></code> class contains IPV4 information used to configure a
network interface. This class was added in vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) IPV4 address to be used to configure the interface. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>subnet_mask</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The subnet mask for the interface. This attribute was added in
vSphere API 6.7.1.
If None and the <code class="docutils literal notranslate"><span class="pre">prefix</span></code> attribute is None, then an error will be
reported.
If None and the <code class="docutils literal notranslate"><span class="pre">prefix</span></code> attribute is set, then the <code class="docutils literal notranslate"><span class="pre">prefix</span></code>
attribute will be used to create a subnet mask whose first prefix
bits are 1 and the remaining bits 0.
If both the <code class="docutils literal notranslate"><span class="pre">subnetMask</span></code> attribute and the <code class="docutils literal notranslate"><span class="pre">prefix</span></code> attribute
are set and they do not represent the same value, then an error
will be reported.</p></li>
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The CIDR prefix for the interface. This attribute was added in
vSphere API 6.7.1.
If None and the <code class="docutils literal notranslate"><span class="pre">subnetMask</span></code> attribute is None, this an error
will be reported.
If None and the <code class="docutils literal notranslate"><span class="pre">subnetMask</span></code> attribute is set, then the
<code class="docutils literal notranslate"><span class="pre">subnetMask</span></code> attribute will be used.
If both the <code class="docutils literal notranslate"><span class="pre">subnetMask</span></code> attribute and the <code class="docutils literal notranslate"><span class="pre">prefix</span></code> attribute
are set and they do not represent the same value, then an error
will be reported.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Ipv6Spec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vcha_client.</span></code><code class="sig-name descname"><span class="pre">Ipv6Spec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Ipv6Spec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Ipv6Spec</span></code> class contains IPV6 information used to configure a
network interface. This class was added in vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) IPv6 address to be used to configure the interface. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>prefix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) The CIDR prefix for the interface. This attribute was added in
vSphere API 6.7.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.NetworkType">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vcha_client.</span></code><code class="sig-name descname"><span class="pre">NetworkType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.NetworkType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NetworkType</span></code> class defines the type of a vCenter Server network.
This enumeration was added in vSphere API 6.7.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.vcha_client.NetworkType" title="com.vmware.vcenter.vcha_client.NetworkType"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkType</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.NetworkType.DISTRIBUTED_PORTGROUP">
<code class="sig-name descname"><span class="pre">DISTRIBUTED_PORTGROUP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetworkType(string='DISTRIBUTED_PORTGROUP')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.NetworkType.DISTRIBUTED_PORTGROUP" title="Permalink to this definition"></a></dt>
<dd><p>Distributed virtual switch. This class attribute was added in vSphere API
6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.NetworkType.STANDARD_PORTGROUP">
<code class="sig-name descname"><span class="pre">STANDARD_PORTGROUP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetworkType(string='STANDARD_PORTGROUP')</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.NetworkType.STANDARD_PORTGROUP" title="Permalink to this definition"></a></dt>
<dd><p>vSphere standard portgroup network. This class attribute was added in
vSphere API 6.7.1.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Operations">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vcha_client.</span></code><code class="sig-name descname"><span class="pre">Operations</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Operations" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Operations</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP">
<code class="sig-name descname"><span class="pre">CLUSTER_DEPLOY_OP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.vcha.cluster.deploy'</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP" title="Permalink to this definition"></a></dt>
<dd><p>Identifier of the cluster deploy operation. This class attribute was added in
vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Operations.CLUSTER_FAILOVER_OP">
<code class="sig-name descname"><span class="pre">CLUSTER_FAILOVER_OP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.vcha.cluster.failover'</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_FAILOVER_OP" title="Permalink to this definition"></a></dt>
<dd><p>Identifier of the cluster failover operation. This class attribute was added in
vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Operations.CLUSTER_GET_OP">
<code class="sig-name descname"><span class="pre">CLUSTER_GET_OP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.vcha.cluster.get'</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_GET_OP" title="Permalink to this definition"></a></dt>
<dd><p>Identifier of the cluster get operation. This class attribute was added in
vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP">
<code class="sig-name descname"><span class="pre">CLUSTER_UNDEPLOY_OP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.vcha.cluster.undeploy'</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP" title="Permalink to this definition"></a></dt>
<dd><p>Identifier of the cluster undeploy operation. This class attribute was added in
vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.Operations.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">disabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Operations.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Operations.Info</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>disabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifiers of the operations that are current disabled. These
operation strings are one of <a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.CLUSTER_DEPLOY_OP</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_FAILOVER_OP" title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_FAILOVER_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.CLUSTER_FAILOVER_OP</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.PASSIVE_REDEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.PASSIVE_REDEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.PASSIVE_REDEPLOY_OP</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.WITNESS_REDEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.WITNESS_REDEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.WITNESS_REDEPLOY_OP</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP" title="com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.MODE_SET_OP</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.CLUSTER_UNDEPLOY_OP</span></code></a> and
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_GET_OP" title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_GET_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.CLUSTER_GET_OP</span></code></a>. 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>active</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifiers of the operations that are currently running. These
operation strings are one of <a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.CLUSTER_DEPLOY_OP</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_FAILOVER_OP" title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_FAILOVER_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.CLUSTER_FAILOVER_OP</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.PASSIVE_REDEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.PASSIVE_REDEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.PASSIVE_REDEPLOY_OP</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.WITNESS_REDEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.WITNESS_REDEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.WITNESS_REDEPLOY_OP</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP" title="com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.MODE_SET_OP</span></code></a>, and
<a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP" title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Operations.CLUSTER_UNDEPLOY_OP</span></code></a>. 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Operations.MODE_GET_OP">
<code class="sig-name descname"><span class="pre">MODE_GET_OP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.vcha.cluster.mode.get'</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Operations.MODE_GET_OP" title="Permalink to this definition"></a></dt>
<dd><p>Identifier of the get mode operation. This class attribute was added in vSphere
API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP">
<code class="sig-name descname"><span class="pre">MODE_SET_OP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.vcha.cluster.mode.set'</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP" title="Permalink to this definition"></a></dt>
<dd><p>Identifier of the set mode operation. This class attribute was added in vSphere
API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Operations.PASSIVE_REDEPLOY_OP">
<code class="sig-name descname"><span class="pre">PASSIVE_REDEPLOY_OP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.vcha.cluster.passive.redeploy'</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Operations.PASSIVE_REDEPLOY_OP" title="Permalink to this definition"></a></dt>
<dd><p>Identifier of the passive redeploy operation. This class attribute was added in
vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vcha_client.Operations.WITNESS_REDEPLOY_OP">
<code class="sig-name descname"><span class="pre">WITNESS_REDEPLOY_OP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.vcha.cluster.witness.redeploy'</span></em><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Operations.WITNESS_REDEPLOY_OP" title="Permalink to this definition"></a></dt>
<dd><p>Identifier of the witness redeploy operation. This class attribute was added in
vSphere API 6.7.1.</p>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vcha_client.Operations.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.Operations.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieves the current active and disabled operations of a VCHA cluster.
This method was added in vSphere API 6.7.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.vcha_client.Operations.Info" title="com.vmware.vcenter.vcha_client.Operations.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Operations.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Info structure containing the current running and disabled
operations of a VCHA cluster.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
If the user has insufficient privilege to perform the operation.
Operation execution requires the System.Read privilege.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If any other error occurs.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.PlacementInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vcha_client.</span></code><code class="sig-name descname"><span class="pre">PlacementInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">management_vcenter_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">management_vcenter_server_guid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datacenter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datacenter_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_network_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_network_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">management_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">management_network_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">management_network_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bios_uuid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.PlacementInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">PlacementInfo</span></code> class contains information to describe the inventory
placement of a single node of a VCHA cluster.
The active nodes management vCenter server credentials are required to
populate all attributes except biosUuid. This class was added in vSphere
API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>management_vcenter_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The hostname of the vCenter server that is managing the VCHA node.
This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>management_vcenter_server_guid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>vm_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The virtual machine name of the VCHA node. This attribute was added
in vSphere API 6.7.1.</p></li>
<li><p><strong>datacenter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">Datacenter:VCenter</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">Datacenter:VCenter</span></code>.</p></li>
<li><p><strong>datacenter_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of the datacenter of the VCHA node. This attribute was
added in vSphere API 6.7.1.</p></li>
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">HostSystem:VCenter</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem:VCenter</span></code>.</p></li>
<li><p><strong>host_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of the host of the VCHA node. This attribute was added in
vSphere API 6.7.1.</p></li>
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The identifier of the cluster of which <code class="docutils literal notranslate"><span class="pre">host</span></code> 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource:VCenter</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource:VCenter</span></code>.
If None, <code class="docutils literal notranslate"><span class="pre">host</span></code> is a standalone host.</p></li>
<li><p><strong>cluster_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The name of the cluster of which <code class="docutils literal notranslate"><span class="pre">host</span></code> is member. This attribute
was added in vSphere API 6.7.1.
If None, <code class="docutils literal notranslate"><span class="pre">host</span></code> is a standalone host.</p></li>
<li><p><strong>ha_network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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:
<code class="docutils literal notranslate"><span class="pre">Network:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">Network:VCenter</span></code>.
If None, the information is currently unavailable or the haNetwork
is not configured.</p></li>
<li><p><strong>ha_network_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>ha_network_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.NetworkType" title="com.vmware.vcenter.vcha_client.NetworkType"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>management_network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">Network:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">Network:VCenter</span></code>.</p></li>
<li><p><strong>management_network_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of the Network object used for the Management network.
This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>management_network_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.NetworkType" title="com.vmware.vcenter.vcha_client.NetworkType"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkType</span></code></a>) The type of the Network object used for the Management network.
This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.DiskInfo" title="com.vmware.vcenter.vcha_client.DiskInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiskInfo</span></code></a>) The storage information of the VCHA node. This attribute was added
in vSphere API 6.7.1.</p></li>
<li><p><strong>bios_uuid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) BIOS UUID for the node. This attribute was added in vSphere API
6.7.1.
If None, the information is currently unavailable.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.PlacementSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vcha_client.</span></code><code class="sig-name descname"><span class="pre">PlacementSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_pool</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_network_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ha_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">management_network_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">management_network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.PlacementSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">PlacementSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of the VCHA node to be used for the virtual machine name.
This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">Folder:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">Folder:VCenter</span></code>.</p></li>
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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:
<code class="docutils literal notranslate"><span class="pre">HostSystem:VCenter</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem:VCenter</span></code>.
If None, see vim.vm.RelocateSpec.host.</p></li>
<li><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The 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:
<code class="docutils literal notranslate"><span class="pre">ResourcePool:VCenter</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">ResourcePool:VCenter</span></code>.
If None, then the active nodes resource pool will be used.</p></li>
<li><p><strong>ha_network_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.NetworkType" title="com.vmware.vcenter.vcha_client.NetworkType"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The type of the Network object used by the HA network.
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network</span></code> attribute is set, then the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network_type</span></code> field must be set.
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network</span></code> attribute is None, then the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network_type</span></code> attribute is ignored. This
attribute was added in vSphere API 6.7.1.
If None and the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network</span></code> 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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network</span></code> attribute is set,
then an error is reported.</p></li>
<li><p><strong>ha_network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The identifier of the Network object used for the HA network.
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network</span></code> attribute is set, then the
{#link #haNetworkType} attribute must be set.
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network</span></code> attribute is None, then the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network_type</span></code> 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:
<code class="docutils literal notranslate"><span class="pre">Network:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">Network:VCenter</span></code>.
If None and the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.ha_network_type</span></code> 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.</p></li>
<li><p><strong>management_network_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.NetworkType" title="com.vmware.vcenter.vcha_client.NetworkType"><code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The type of the Network object used by the Management network.
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network</span></code> attribute is set,
then the {#link #managementNetworkType} field must be set.
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network</span></code> attribute is None,
then the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network_type</span></code> attribute is
ignored. This attribute was added in vSphere API 6.7.1.
If None and the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network</span></code> 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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network</span></code> attribute
is set, then an error is reported.</p></li>
<li><p><strong>management_network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The identifier of the Network object used for the Management
network. If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network</span></code> attribute
is set, then the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network_type</span></code>
attribute must be set.
If the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network</span></code> attribute is None,
then the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network_type</span></code> 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:
<code class="docutils literal notranslate"><span class="pre">Network:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">Network:VCenter</span></code>.
If None and the <code class="xref py py-attr docutils literal notranslate"><span class="pre">PlacementSpec.management_network_type</span></code>
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.</p></li>
<li><p><strong>storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha_client.DiskSpec" title="com.vmware.vcenter.vcha_client.DiskSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiskSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vcha_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vcha_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.vm_client">
<span id="com-vmware-vcenter-vm-client-module"></span><h2>com.vmware.vcenter.vm_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client</span></code> module provides classes for managing
virtual machines.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.DataSets">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm_client.</span></code><code class="sig-name descname"><span class="pre">DataSets</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.DataSets" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DataSets</span></code> class provides methods for sharing information between a
virtual machine and its guest operating system.</p>
<p>See the VMware Guest SDK Programming Guide for details on using DataSets
from within a virtual machine.</p>
<p>Information is grouped into data sets, each of which contains key-value
entries comprising the data. Its 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.</p>
<p>Its 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.</p>
<p>Data set support requires the virtual machine be at virtual hardware
version VMX_20 or later.</p>
<p>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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.DataSets.Access">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Access</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.DataSets.Access" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>Possible Entry access modes. This enumeration was added in vSphere API
8.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Access</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.DataSets.Access.NONE">
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Access(string='NONE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.DataSets.Access.NONE" title="Permalink to this definition"></a></dt>
<dd><p>No access is allowed for data set Entries. This class attribute was added
in vSphere API 8.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.DataSets.Access.READ_ONLY">
<code class="sig-name descname"><span class="pre">READ_ONLY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Access(string='READ_ONLY')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.DataSets.Access.READ_ONLY" title="Permalink to this definition"></a></dt>
<dd><p>Only read access is allowed for data set Entries. This class attribute was
added in vSphere API 8.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.DataSets.Access.READ_WRITE">
<code class="sig-name descname"><span class="pre">READ_WRITE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Access(string='READ_WRITE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.DataSets.Access.READ_WRITE" title="Permalink to this definition"></a></dt>
<dd><p>Full read, write and delete access is allowed on data set Entries. This
class attribute was added in vSphere API 8.0.0.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.DataSets.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guest</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">omit_from_snapshot_and_clone</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.DataSets.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DataSets.CreateSpec</span></code> class describes a data set to be created. This
class was added in vSphere API 8.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of the data set. <strong>It is recommended that this value take
the form “com.company.project” to avoid conflict with other
uses.</strong>. This attribute was added in vSphere API 8.0.0.0.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>host</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.DataSets.Access" title="com.vmware.vcenter.vm_client.DataSets.Access"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataSets.Access</span></code></a>) <p>Host access control.</p>
<p>Controls access to the data set by the
<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.data_sets_client.Entries" title="com.vmware.vcenter.vm.data_sets_client.Entries"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.data_sets_client.Entries</span></code></a> methods..
This attribute was added in vSphere API 8.0.0.0.</p>
</p></li>
<li><p><strong>guest</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.DataSets.Access" title="com.vmware.vcenter.vm_client.DataSets.Access"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataSets.Access</span></code></a>) <p>Guest access control.</p>
<p>Controls access to the data set from the in-guest APIs.. This
attribute was added in vSphere API 8.0.0.0.</p>
</p></li>
<li><p><strong>omit_from_snapshot_and_clone</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, 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 {\&#64;link
#omitFromSnapshotAndClone) <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> will be destroyed. Any data
set with <code class="xref py py-attr docutils literal notranslate"><span class="pre">DataSets.CreateSpec.omit_from_snapshot_and_clone</span></code>
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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.DataSets.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guest</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">used</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">omit_from_snapshot_and_clone</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.DataSets.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DataSets.Info</span></code> class describes a data set. This class was added in
vSphere API 8.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of the data set. This attribute was added in vSphere API
8.0.0.0.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) A description of how the data set is used by its creator. This
attribute was added in vSphere API 8.0.0.0.</p></li>
<li><p><strong>host</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.DataSets.Access" title="com.vmware.vcenter.vm_client.DataSets.Access"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataSets.Access</span></code></a>) <p>Host access control.</p>
<p>Controls access to the data set by the
<a class="reference internal" href="com.vmware.vcenter.vm.html#com.vmware.vcenter.vm.data_sets_client.Entries" title="com.vmware.vcenter.vm.data_sets_client.Entries"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.data_sets_client.Entries</span></code></a> methods..
This attribute was added in vSphere API 8.0.0.0.</p>
</p></li>
<li><p><strong>guest</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.DataSets.Access" title="com.vmware.vcenter.vm_client.DataSets.Access"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataSets.Access</span></code></a>) <p>Guest access control.</p>
<p>Controls access to the data set from in-guest APIs.. This attribute
was added in vSphere API 8.0.0.0.</p>
</p></li>
<li><p><strong>used</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) 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.</p></li>
<li><p><strong>omit_from_snapshot_and_clone</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, 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 {\&#64;link
#omitFromSnapshotAndClone) <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> will be destroyed. Any data
set with <code class="xref py py-attr docutils literal notranslate"><span class="pre">DataSets.Info.omit_from_snapshot_and_clone</span></code> None
will be restored to the state when the snapshot was created. This
attribute was added in vSphere API 8.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.DataSets.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.DataSets.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Basic data set information. This class was added in vSphere API 8.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data_set</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.DataSet</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.DataSet</span></code>.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The name of the data set. This attribute was added in vSphere API
8.0.0.0.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) The description of the data set. This attribute was added in
vSphere API 8.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.DataSets.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guest</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">omit_from_snapshot_and_clone</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.DataSets.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DataSets.UpdateSpec</span></code> class describes attibutes of a data set that
can be modified. This class was added in vSphere API 8.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>host</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.DataSets.Access" title="com.vmware.vcenter.vm_client.DataSets.Access"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataSets.Access</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The access control from the host. This attribute was added in
vSphere API 8.0.0.0.
If set, the value is changed.</p></li>
<li><p><strong>guest</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.DataSets.Access" title="com.vmware.vcenter.vm_client.DataSets.Access"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataSets.Access</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The access control from the guest. This attribute was added in
vSphere API 8.0.0.0.
If set, the value is changed.</p></li>
<li><p><strong>omit_from_snapshot_and_clone</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, 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 {\&#64;link
#omitFromSnapshotAndClone) <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> will be destroyed. Any data
set with <code class="xref py py-attr docutils literal notranslate"><span class="pre">DataSets.UpdateSpec.omit_from_snapshot_and_clone</span></code>
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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.DataSets.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.DataSets.create" title="Permalink to this definition"></a></dt>
<dd><p>Creates a new data set. This method was added in vSphere API 8.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.DataSets.CreateSpec" title="com.vmware.vcenter.vm_client.DataSets.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataSets.CreateSpec</span></code></a>) Specification of the data set to be created.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The identifier of the new data set.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.DataSet</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if the data set with the same name already exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the specification is incorrect.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the virtual machine is in a state that doesnt allow
modifications, for example suspended.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
if the new data set requires more resources than are available.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the virtual hardware version of the virtual machine does not
support DataSets</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the ESXi host version does not support DataSets</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.DataSets.DataSetCreate</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.DataSets.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_set</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.DataSets.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete a data set. This method was added in vSphere API 8.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
<li><p><strong>data_set</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the data set to be deleted.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.DataSet</span></code>.</p></li>
<li><p><strong>force</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) If true, delete the data set even if it is not empty.
If None a <a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
exception will be reported if the data set is not empty. This is
the equivalent of passing the value false.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the virtual machine is in a state that doesnt allow
modifications, for example suspended.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the data set is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
if the data set is not empty and <code class="docutils literal notranslate"><span class="pre">force</span></code> is not <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the virtual hardware version of the virtual machine does not
support DataSets</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the ESXi host version does not support DataSets</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.DataSets.DataSetDelete</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.DataSets.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_set</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.DataSets.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information describing a data set. This method was added in
vSphere API 8.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
<li><p><strong>data_set</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the data set to be queried.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.DataSet</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm_client.DataSets.Info" title="com.vmware.vcenter.vm_client.DataSets.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataSets.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Details about the data set.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the data set is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the virtual hardware version of the virtual machine does not
support DataSets</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the ESXi host version does not support DataSets</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.DataSets.DataSetGet</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.DataSets.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.DataSets.list" title="Permalink to this definition"></a></dt>
<dd><p>Lists the data sets of a virtual machine. This method was added in
vSphere API 8.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm_client.DataSets.list" title="com.vmware.vcenter.vm_client.DataSets.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.vm_client.DataSets.Summary" title="com.vmware.vcenter.vm_client.DataSets.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataSets.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The list of data sets.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the virtual hardware version of the virtual machine does not
support DataSets</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the ESXi host version does not support DataSets</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.DataSets.DataSetList</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.DataSets.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_set</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.DataSets.update" title="Permalink to this definition"></a></dt>
<dd><p>Modifies the attributes of a data set. This method was added in vSphere
API 8.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
<li><p><strong>data_set</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the data set to be queried.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.DataSet</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.DataSets.UpdateSpec" title="com.vmware.vcenter.vm_client.DataSets.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataSets.UpdateSpec</span></code></a>) new attributes of the data set. Data sets should only be modified
by the application that creates them. Otherwise the application may
stop working.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if any of the new attributes are invalid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the virtual machine is in a state that doesnt allow
modification, for example suspendeds.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the data set is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
if the new data set attributes requires more resources than are
available.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the virtual hardware version of the virtual machine does not
support DataSets</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the ESXi host version does not support DataSets</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.DataSets.DataSetUpdate</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.GuestOS">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm_client.</span></code><code class="sig-name descname"><span class="pre">GuestOS</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">GuestOS</span></code> class defines the valid guest operating system types used
for configuring a virtual machine.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.vm_client.GuestOS" title="com.vmware.vcenter.vm_client.GuestOS"><code class="xref py py-class docutils literal notranslate"><span class="pre">GuestOS</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.AMAZONLINUX2_64">
<code class="sig-name descname"><span class="pre">AMAZONLINUX2_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='AMAZONLINUX2_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.AMAZONLINUX2_64" title="Permalink to this definition"></a></dt>
<dd><p>Amazon Linux 2 (64 bit). This class attribute was added in vSphere API
6.7.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.AMAZONLINUX3_64">
<code class="sig-name descname"><span class="pre">AMAZONLINUX3_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='AMAZONLINUX3_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.AMAZONLINUX3_64" title="Permalink to this definition"></a></dt>
<dd><p>Amazon Linux 3 (64 bit). This class attribute was added in vSphere API
7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ASIANUX_3">
<code class="sig-name descname"><span class="pre">ASIANUX_3</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ASIANUX_3')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_3" title="Permalink to this definition"></a></dt>
<dd><p>Asianux Server 3</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ASIANUX_3_64">
<code class="sig-name descname"><span class="pre">ASIANUX_3_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ASIANUX_3_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_3_64" title="Permalink to this definition"></a></dt>
<dd><p>Asianux Server 3 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ASIANUX_4">
<code class="sig-name descname"><span class="pre">ASIANUX_4</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ASIANUX_4')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_4" title="Permalink to this definition"></a></dt>
<dd><p>Asianux Server 4</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ASIANUX_4_64">
<code class="sig-name descname"><span class="pre">ASIANUX_4_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ASIANUX_4_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_4_64" title="Permalink to this definition"></a></dt>
<dd><p>Asianux Server 4 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ASIANUX_5_64">
<code class="sig-name descname"><span class="pre">ASIANUX_5_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ASIANUX_5_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_5_64" title="Permalink to this definition"></a></dt>
<dd><p>Asianux Server 5 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ASIANUX_7_64">
<code class="sig-name descname"><span class="pre">ASIANUX_7_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ASIANUX_7_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_7_64" title="Permalink to this definition"></a></dt>
<dd><p>Asianux Server 7 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ASIANUX_8_64">
<code class="sig-name descname"><span class="pre">ASIANUX_8_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ASIANUX_8_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_8_64" title="Permalink to this definition"></a></dt>
<dd><p>Asianux Server 8 (64 bit). This class attribute was added in vSphere API
6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ASIANUX_9_64">
<code class="sig-name descname"><span class="pre">ASIANUX_9_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ASIANUX_9_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_9_64" title="Permalink to this definition"></a></dt>
<dd><p>Asianux Server 9 (64 bit). This class attribute was added in vSphere API
7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.CENTOS">
<code class="sig-name descname"><span class="pre">CENTOS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='CENTOS')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS" title="Permalink to this definition"></a></dt>
<dd><p>CentOS 4/5</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.CENTOS_6">
<code class="sig-name descname"><span class="pre">CENTOS_6</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='CENTOS_6')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_6" title="Permalink to this definition"></a></dt>
<dd><p>CentOS 6</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.CENTOS_64">
<code class="sig-name descname"><span class="pre">CENTOS_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='CENTOS_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_64" title="Permalink to this definition"></a></dt>
<dd><p>CentOS 4/5 (64-bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.CENTOS_6_64">
<code class="sig-name descname"><span class="pre">CENTOS_6_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='CENTOS_6_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_6_64" title="Permalink to this definition"></a></dt>
<dd><p>CentOS 6 (64-bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.CENTOS_7">
<code class="sig-name descname"><span class="pre">CENTOS_7</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='CENTOS_7')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_7" title="Permalink to this definition"></a></dt>
<dd><p>CentOS 7</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.CENTOS_7_64">
<code class="sig-name descname"><span class="pre">CENTOS_7_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='CENTOS_7_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_7_64" title="Permalink to this definition"></a></dt>
<dd><p>CentOS 7 (64-bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.CENTOS_8_64">
<code class="sig-name descname"><span class="pre">CENTOS_8_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='CENTOS_8_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_8_64" title="Permalink to this definition"></a></dt>
<dd><p>CentOS 8 (64-bit). This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.CENTOS_9_64">
<code class="sig-name descname"><span class="pre">CENTOS_9_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='CENTOS_9_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_9_64" title="Permalink to this definition"></a></dt>
<dd><p>CentOS 9 (64-bit). This class attribute was added in vSphere API 7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.COREOS_64">
<code class="sig-name descname"><span class="pre">COREOS_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='COREOS_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.COREOS_64" title="Permalink to this definition"></a></dt>
<dd><p>CoreOS Linux (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.CRXPOD_1">
<code class="sig-name descname"><span class="pre">CRXPOD_1</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='CRXPOD_1')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.CRXPOD_1" title="Permalink to this definition"></a></dt>
<dd><p>CRX Pod 1. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN">
<code class="sig-name descname"><span class="pre">DARWIN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 10.5</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_10">
<code class="sig-name descname"><span class="pre">DARWIN_10</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN_10')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_10" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 10.6</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_10_64">
<code class="sig-name descname"><span class="pre">DARWIN_10_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN_10_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_10_64" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 10.6 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_11">
<code class="sig-name descname"><span class="pre">DARWIN_11</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN_11')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_11" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 10.7</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_11_64">
<code class="sig-name descname"><span class="pre">DARWIN_11_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN_11_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_11_64" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 10.7 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_12_64">
<code class="sig-name descname"><span class="pre">DARWIN_12_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN_12_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_12_64" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 10.8 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_13_64">
<code class="sig-name descname"><span class="pre">DARWIN_13_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN_13_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_13_64" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 10.9 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_14_64">
<code class="sig-name descname"><span class="pre">DARWIN_14_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN_14_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_14_64" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 10.10 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_15_64">
<code class="sig-name descname"><span class="pre">DARWIN_15_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN_15_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_15_64" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 10.11 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_16_64">
<code class="sig-name descname"><span class="pre">DARWIN_16_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN_16_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_16_64" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 10.12 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_17_64">
<code class="sig-name descname"><span class="pre">DARWIN_17_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN_17_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_17_64" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 10.13 (64 bit). This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_18_64">
<code class="sig-name descname"><span class="pre">DARWIN_18_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN_18_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_18_64" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 10.14 (64 bit). This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_19_64">
<code class="sig-name descname"><span class="pre">DARWIN_19_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN_19_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_19_64" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 10.15 (64 bit). This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_20_64">
<code class="sig-name descname"><span class="pre">DARWIN_20_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN_20_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_20_64" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 11 (64 bit). This class attribute was added in vSphere API 7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_21_64">
<code class="sig-name descname"><span class="pre">DARWIN_21_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN_21_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_21_64" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 12 (64 bit). This class attribute was added in vSphere API 7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DARWIN_64">
<code class="sig-name descname"><span class="pre">DARWIN_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DARWIN_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_64" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS 10.5 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_10">
<code class="sig-name descname"><span class="pre">DEBIAN_10</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_10')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_10" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 10</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_10_64">
<code class="sig-name descname"><span class="pre">DEBIAN_10_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_10_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_10_64" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 10 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_11">
<code class="sig-name descname"><span class="pre">DEBIAN_11</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_11')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_11" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 11. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_11_64">
<code class="sig-name descname"><span class="pre">DEBIAN_11_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_11_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_11_64" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 11 (64 bit). This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_4">
<code class="sig-name descname"><span class="pre">DEBIAN_4</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_4')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_4" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 4</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_4_64">
<code class="sig-name descname"><span class="pre">DEBIAN_4_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_4_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_4_64" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 4 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_5">
<code class="sig-name descname"><span class="pre">DEBIAN_5</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_5')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_5" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 5</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_5_64">
<code class="sig-name descname"><span class="pre">DEBIAN_5_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_5_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_5_64" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 5 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_6">
<code class="sig-name descname"><span class="pre">DEBIAN_6</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_6')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_6" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 6</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_6_64">
<code class="sig-name descname"><span class="pre">DEBIAN_6_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_6_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_6_64" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 6 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_7">
<code class="sig-name descname"><span class="pre">DEBIAN_7</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_7')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_7" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 7</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_7_64">
<code class="sig-name descname"><span class="pre">DEBIAN_7_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_7_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_7_64" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 7 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_8">
<code class="sig-name descname"><span class="pre">DEBIAN_8</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_8')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_8" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 8</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_8_64">
<code class="sig-name descname"><span class="pre">DEBIAN_8_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_8_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_8_64" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 8 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_9">
<code class="sig-name descname"><span class="pre">DEBIAN_9</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_9')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_9" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 9</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DEBIAN_9_64">
<code class="sig-name descname"><span class="pre">DEBIAN_9_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DEBIAN_9_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_9_64" title="Permalink to this definition"></a></dt>
<dd><p>Debian GNU/Linux 9 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.DOS">
<code class="sig-name descname"><span class="pre">DOS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='DOS')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.DOS" title="Permalink to this definition"></a></dt>
<dd><p>MS-DOS.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ECOMSTATION">
<code class="sig-name descname"><span class="pre">ECOMSTATION</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ECOMSTATION')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ECOMSTATION" title="Permalink to this definition"></a></dt>
<dd><p>eComStation 1.x</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ECOMSTATION_2">
<code class="sig-name descname"><span class="pre">ECOMSTATION_2</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ECOMSTATION_2')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ECOMSTATION_2" title="Permalink to this definition"></a></dt>
<dd><p>eComStation 2.0</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.FEDORA">
<code class="sig-name descname"><span class="pre">FEDORA</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='FEDORA')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FEDORA" title="Permalink to this definition"></a></dt>
<dd><p>Fedora Linux</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.FEDORA_64">
<code class="sig-name descname"><span class="pre">FEDORA_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='FEDORA_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FEDORA_64" title="Permalink to this definition"></a></dt>
<dd><p>Fedora Linux (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.FREEBSD">
<code class="sig-name descname"><span class="pre">FREEBSD</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='FREEBSD')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD" title="Permalink to this definition"></a></dt>
<dd><p>FreeBSD 10 or earlier</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.FREEBSD_11">
<code class="sig-name descname"><span class="pre">FREEBSD_11</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='FREEBSD_11')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_11" title="Permalink to this definition"></a></dt>
<dd><p>FreeBSD 11. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.FREEBSD_11_64">
<code class="sig-name descname"><span class="pre">FREEBSD_11_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='FREEBSD_11_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_11_64" title="Permalink to this definition"></a></dt>
<dd><p>FreeBSD 11 x64. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.FREEBSD_12">
<code class="sig-name descname"><span class="pre">FREEBSD_12</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='FREEBSD_12')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_12" title="Permalink to this definition"></a></dt>
<dd><p>FreeBSD 12. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.FREEBSD_12_64">
<code class="sig-name descname"><span class="pre">FREEBSD_12_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='FREEBSD_12_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_12_64" title="Permalink to this definition"></a></dt>
<dd><p>FreeBSD 12 x64. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.FREEBSD_13">
<code class="sig-name descname"><span class="pre">FREEBSD_13</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='FREEBSD_13')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_13" title="Permalink to this definition"></a></dt>
<dd><p>FreeBSD 13. This class attribute was added in vSphere API 7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.FREEBSD_13_64">
<code class="sig-name descname"><span class="pre">FREEBSD_13_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='FREEBSD_13_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_13_64" title="Permalink to this definition"></a></dt>
<dd><p>FreeBSD 13 x64. This class attribute was added in vSphere API 7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.FREEBSD_64">
<code class="sig-name descname"><span class="pre">FREEBSD_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='FREEBSD_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_64" title="Permalink to this definition"></a></dt>
<dd><p>FreeBSD 10 x64 or earlier</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.GENERIC_LINUX">
<code class="sig-name descname"><span class="pre">GENERIC_LINUX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='GENERIC_LINUX')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.GENERIC_LINUX" title="Permalink to this definition"></a></dt>
<dd><p>Other Linux</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.MANDRAKE">
<code class="sig-name descname"><span class="pre">MANDRAKE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='MANDRAKE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.MANDRAKE" title="Permalink to this definition"></a></dt>
<dd><p>Mandrake Linux</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.MANDRIVA">
<code class="sig-name descname"><span class="pre">MANDRIVA</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='MANDRIVA')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.MANDRIVA" title="Permalink to this definition"></a></dt>
<dd><p>Mandriva Linux</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.MANDRIVA_64">
<code class="sig-name descname"><span class="pre">MANDRIVA_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='MANDRIVA_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.MANDRIVA_64" title="Permalink to this definition"></a></dt>
<dd><p>Mandriva Linux (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.NETWARE_4">
<code class="sig-name descname"><span class="pre">NETWARE_4</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='NETWARE_4')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.NETWARE_4" title="Permalink to this definition"></a></dt>
<dd><p>Novell NetWare 4</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.NETWARE_5">
<code class="sig-name descname"><span class="pre">NETWARE_5</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='NETWARE_5')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.NETWARE_5" title="Permalink to this definition"></a></dt>
<dd><p>Novell NetWare 5.1</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.NETWARE_6">
<code class="sig-name descname"><span class="pre">NETWARE_6</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='NETWARE_6')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.NETWARE_6" title="Permalink to this definition"></a></dt>
<dd><p>Novell NetWare 6.x</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.NLD_9">
<code class="sig-name descname"><span class="pre">NLD_9</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='NLD_9')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.NLD_9" title="Permalink to this definition"></a></dt>
<dd><p>Novell Linux Desktop 9</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OES">
<code class="sig-name descname"><span class="pre">OES</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OES')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OES" title="Permalink to this definition"></a></dt>
<dd><p>Open Enterprise Server</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OPENSERVER_5">
<code class="sig-name descname"><span class="pre">OPENSERVER_5</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OPENSERVER_5')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OPENSERVER_5" title="Permalink to this definition"></a></dt>
<dd><p>SCO OpenServer 5</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OPENSERVER_6">
<code class="sig-name descname"><span class="pre">OPENSERVER_6</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OPENSERVER_6')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OPENSERVER_6" title="Permalink to this definition"></a></dt>
<dd><p>SCO OpenServer 6</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OPENSUSE">
<code class="sig-name descname"><span class="pre">OPENSUSE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OPENSUSE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OPENSUSE" title="Permalink to this definition"></a></dt>
<dd><p>OpenSUSE Linux</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OPENSUSE_64">
<code class="sig-name descname"><span class="pre">OPENSUSE_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OPENSUSE_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OPENSUSE_64" title="Permalink to this definition"></a></dt>
<dd><p>OpenSUSE Linux (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX">
<code class="sig-name descname"><span class="pre">ORACLE_LINUX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ORACLE_LINUX')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX" title="Permalink to this definition"></a></dt>
<dd><p>Oracle Linux 4/5</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_6">
<code class="sig-name descname"><span class="pre">ORACLE_LINUX_6</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ORACLE_LINUX_6')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_6" title="Permalink to this definition"></a></dt>
<dd><p>Oracle Linux 6</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_64">
<code class="sig-name descname"><span class="pre">ORACLE_LINUX_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ORACLE_LINUX_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_64" title="Permalink to this definition"></a></dt>
<dd><p>Oracle Linux 4/5 (64-bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_6_64">
<code class="sig-name descname"><span class="pre">ORACLE_LINUX_6_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ORACLE_LINUX_6_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_6_64" title="Permalink to this definition"></a></dt>
<dd><p>Oracle Linux 6 (64-bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_7">
<code class="sig-name descname"><span class="pre">ORACLE_LINUX_7</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ORACLE_LINUX_7')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_7" title="Permalink to this definition"></a></dt>
<dd><p>Oracle Linux 7</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_7_64">
<code class="sig-name descname"><span class="pre">ORACLE_LINUX_7_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ORACLE_LINUX_7_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_7_64" title="Permalink to this definition"></a></dt>
<dd><p>Oracle Linux 7 (64-bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_8_64">
<code class="sig-name descname"><span class="pre">ORACLE_LINUX_8_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ORACLE_LINUX_8_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_8_64" title="Permalink to this definition"></a></dt>
<dd><p>Oracle Linux 8 (64-bit). This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_9_64">
<code class="sig-name descname"><span class="pre">ORACLE_LINUX_9_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='ORACLE_LINUX_9_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_9_64" title="Permalink to this definition"></a></dt>
<dd><p>Oracle Linux 9 (64-bit). This class attribute was added in vSphere API
7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OS2">
<code class="sig-name descname"><span class="pre">OS2</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OS2')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OS2" title="Permalink to this definition"></a></dt>
<dd><p>OS/2</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER">
<code class="sig-name descname"><span class="pre">OTHER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OTHER')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER" title="Permalink to this definition"></a></dt>
<dd><p>Other Operating System</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_24X_LINUX">
<code class="sig-name descname"><span class="pre">OTHER_24X_LINUX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OTHER_24X_LINUX')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_24X_LINUX" title="Permalink to this definition"></a></dt>
<dd><p>Linux 2.4x Kernel</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_24X_LINUX_64">
<code class="sig-name descname"><span class="pre">OTHER_24X_LINUX_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OTHER_24X_LINUX_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_24X_LINUX_64" title="Permalink to this definition"></a></dt>
<dd><p>Linux 2.4x Kernel (64 bit) (experimental)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_26X_LINUX">
<code class="sig-name descname"><span class="pre">OTHER_26X_LINUX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OTHER_26X_LINUX')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_26X_LINUX" title="Permalink to this definition"></a></dt>
<dd><p>Linux 2.6x Kernel</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_26X_LINUX_64">
<code class="sig-name descname"><span class="pre">OTHER_26X_LINUX_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OTHER_26X_LINUX_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_26X_LINUX_64" title="Permalink to this definition"></a></dt>
<dd><p>Linux 2.6x Kernel (64 bit) (experimental)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_3X_LINUX">
<code class="sig-name descname"><span class="pre">OTHER_3X_LINUX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OTHER_3X_LINUX')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_3X_LINUX" title="Permalink to this definition"></a></dt>
<dd><p>Linux 3.x Kernel</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_3X_LINUX_64">
<code class="sig-name descname"><span class="pre">OTHER_3X_LINUX_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OTHER_3X_LINUX_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_3X_LINUX_64" title="Permalink to this definition"></a></dt>
<dd><p>Linux 3.x Kernel (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_4X_LINUX">
<code class="sig-name descname"><span class="pre">OTHER_4X_LINUX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OTHER_4X_LINUX')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_4X_LINUX" title="Permalink to this definition"></a></dt>
<dd><p>Linux 4.x Kernel. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_4X_LINUX_64">
<code class="sig-name descname"><span class="pre">OTHER_4X_LINUX_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OTHER_4X_LINUX_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_4X_LINUX_64" title="Permalink to this definition"></a></dt>
<dd><p>Linux 4.x Kernel (64 bit). This class attribute was added in vSphere API
6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_5X_LINUX">
<code class="sig-name descname"><span class="pre">OTHER_5X_LINUX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OTHER_5X_LINUX')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_5X_LINUX" title="Permalink to this definition"></a></dt>
<dd><p>Linux 5.x Kernel. This class attribute was added in vSphere API 7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_5X_LINUX_64">
<code class="sig-name descname"><span class="pre">OTHER_5X_LINUX_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OTHER_5X_LINUX_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_5X_LINUX_64" title="Permalink to this definition"></a></dt>
<dd><p>Linux 5.x Kernel (64 bit). This class attribute was added in vSphere API
7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_64">
<code class="sig-name descname"><span class="pre">OTHER_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OTHER_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_64" title="Permalink to this definition"></a></dt>
<dd><p>Other Operating System (64 bit) (experimental)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_LINUX">
<code class="sig-name descname"><span class="pre">OTHER_LINUX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OTHER_LINUX')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_LINUX" title="Permalink to this definition"></a></dt>
<dd><p>Linux 2.2x Kernel</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.OTHER_LINUX_64">
<code class="sig-name descname"><span class="pre">OTHER_LINUX_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='OTHER_LINUX_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_LINUX_64" title="Permalink to this definition"></a></dt>
<dd><p>Linux (64 bit) (experimental)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.REDHAT">
<code class="sig-name descname"><span class="pre">REDHAT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='REDHAT')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.REDHAT" title="Permalink to this definition"></a></dt>
<dd><p>Red Hat Linux 2.1</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_2">
<code class="sig-name descname"><span class="pre">RHEL_2</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='RHEL_2')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_2" title="Permalink to this definition"></a></dt>
<dd><p>Red Hat Enterprise Linux 2</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_3">
<code class="sig-name descname"><span class="pre">RHEL_3</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='RHEL_3')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_3" title="Permalink to this definition"></a></dt>
<dd><p>Red Hat Enterprise Linux 3</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_3_64">
<code class="sig-name descname"><span class="pre">RHEL_3_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='RHEL_3_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_3_64" title="Permalink to this definition"></a></dt>
<dd><p>Red Hat Enterprise Linux 3 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_4">
<code class="sig-name descname"><span class="pre">RHEL_4</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='RHEL_4')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_4" title="Permalink to this definition"></a></dt>
<dd><p>Red Hat Enterprise Linux 4</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_4_64">
<code class="sig-name descname"><span class="pre">RHEL_4_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='RHEL_4_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_4_64" title="Permalink to this definition"></a></dt>
<dd><p>Red Hat Enterprise Linux 4 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_5">
<code class="sig-name descname"><span class="pre">RHEL_5</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='RHEL_5')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_5" title="Permalink to this definition"></a></dt>
<dd><p>Red Hat Enterprise Linux 5</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_5_64">
<code class="sig-name descname"><span class="pre">RHEL_5_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='RHEL_5_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_5_64" title="Permalink to this definition"></a></dt>
<dd><p>Red Hat Enterprise Linux 5 (64 bit) (experimental)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_6">
<code class="sig-name descname"><span class="pre">RHEL_6</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='RHEL_6')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_6" title="Permalink to this definition"></a></dt>
<dd><p>Red Hat Enterprise Linux 6</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_6_64">
<code class="sig-name descname"><span class="pre">RHEL_6_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='RHEL_6_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_6_64" title="Permalink to this definition"></a></dt>
<dd><p>Red Hat Enterprise Linux 6 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_7">
<code class="sig-name descname"><span class="pre">RHEL_7</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='RHEL_7')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_7" title="Permalink to this definition"></a></dt>
<dd><p>Red Hat Enterprise Linux 7</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_7_64">
<code class="sig-name descname"><span class="pre">RHEL_7_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='RHEL_7_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_7_64" title="Permalink to this definition"></a></dt>
<dd><p>Red Hat Enterprise Linux 7 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_8_64">
<code class="sig-name descname"><span class="pre">RHEL_8_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='RHEL_8_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_8_64" title="Permalink to this definition"></a></dt>
<dd><p>Red Hat Enterprise Linux 8 (64 bit). This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.RHEL_9_64">
<code class="sig-name descname"><span class="pre">RHEL_9_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='RHEL_9_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_9_64" title="Permalink to this definition"></a></dt>
<dd><p>Red Hat Enterprise Linux 9 (64 bit). This class attribute was added in
vSphere API 7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SJDS">
<code class="sig-name descname"><span class="pre">SJDS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SJDS')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SJDS" title="Permalink to this definition"></a></dt>
<dd><p>Sun Java Desktop System</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES">
<code class="sig-name descname"><span class="pre">SLES</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SLES')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SLES" title="Permalink to this definition"></a></dt>
<dd><p>Suse Linux Enterprise Server 9</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_10">
<code class="sig-name descname"><span class="pre">SLES_10</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SLES_10')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SLES_10" title="Permalink to this definition"></a></dt>
<dd><p>Suse linux Enterprise Server 10</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_10_64">
<code class="sig-name descname"><span class="pre">SLES_10_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SLES_10_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SLES_10_64" title="Permalink to this definition"></a></dt>
<dd><p>Suse Linux Enterprise Server 10 (64 bit) (experimental)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_11">
<code class="sig-name descname"><span class="pre">SLES_11</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SLES_11')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SLES_11" title="Permalink to this definition"></a></dt>
<dd><p>Suse linux Enterprise Server 11</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_11_64">
<code class="sig-name descname"><span class="pre">SLES_11_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SLES_11_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SLES_11_64" title="Permalink to this definition"></a></dt>
<dd><p>Suse Linux Enterprise Server 11 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_12">
<code class="sig-name descname"><span class="pre">SLES_12</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SLES_12')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SLES_12" title="Permalink to this definition"></a></dt>
<dd><p>Suse linux Enterprise Server 12</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_12_64">
<code class="sig-name descname"><span class="pre">SLES_12_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SLES_12_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SLES_12_64" title="Permalink to this definition"></a></dt>
<dd><p>Suse Linux Enterprise Server 12 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_15_64">
<code class="sig-name descname"><span class="pre">SLES_15_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SLES_15_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SLES_15_64" title="Permalink to this definition"></a></dt>
<dd><p>Suse Linux Enterprise Server 15 (64 bit). This class attribute was added in
vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_16_64">
<code class="sig-name descname"><span class="pre">SLES_16_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SLES_16_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SLES_16_64" title="Permalink to this definition"></a></dt>
<dd><p>Suse Linux Enterprise Server 16 (64 bit). This class attribute was added in
vSphere API 7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SLES_64">
<code class="sig-name descname"><span class="pre">SLES_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SLES_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SLES_64" title="Permalink to this definition"></a></dt>
<dd><p>Suse Linux Enterprise Server 9 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SOLARIS_10">
<code class="sig-name descname"><span class="pre">SOLARIS_10</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SOLARIS_10')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_10" title="Permalink to this definition"></a></dt>
<dd><p>Solaris 10 (32 bit) (experimental)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SOLARIS_10_64">
<code class="sig-name descname"><span class="pre">SOLARIS_10_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SOLARIS_10_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_10_64" title="Permalink to this definition"></a></dt>
<dd><p>Solaris 10 (64 bit) (experimental)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SOLARIS_11_64">
<code class="sig-name descname"><span class="pre">SOLARIS_11_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SOLARIS_11_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_11_64" title="Permalink to this definition"></a></dt>
<dd><p>Solaris 11 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SOLARIS_6">
<code class="sig-name descname"><span class="pre">SOLARIS_6</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SOLARIS_6')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_6" title="Permalink to this definition"></a></dt>
<dd><p>Solaris 6</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SOLARIS_7">
<code class="sig-name descname"><span class="pre">SOLARIS_7</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SOLARIS_7')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_7" title="Permalink to this definition"></a></dt>
<dd><p>Solaris 7</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SOLARIS_8">
<code class="sig-name descname"><span class="pre">SOLARIS_8</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SOLARIS_8')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_8" title="Permalink to this definition"></a></dt>
<dd><p>Solaris 8</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SOLARIS_9">
<code class="sig-name descname"><span class="pre">SOLARIS_9</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SOLARIS_9')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_9" title="Permalink to this definition"></a></dt>
<dd><p>Solaris 9</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SUSE">
<code class="sig-name descname"><span class="pre">SUSE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SUSE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SUSE" title="Permalink to this definition"></a></dt>
<dd><p>Suse Linux</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.SUSE_64">
<code class="sig-name descname"><span class="pre">SUSE_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='SUSE_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.SUSE_64" title="Permalink to this definition"></a></dt>
<dd><p>Suse Linux (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.TURBO_LINUX">
<code class="sig-name descname"><span class="pre">TURBO_LINUX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='TURBO_LINUX')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.TURBO_LINUX" title="Permalink to this definition"></a></dt>
<dd><p>Turbolinux</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.TURBO_LINUX_64">
<code class="sig-name descname"><span class="pre">TURBO_LINUX_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='TURBO_LINUX_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.TURBO_LINUX_64" title="Permalink to this definition"></a></dt>
<dd><p>Turbolinux (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.UBUNTU">
<code class="sig-name descname"><span class="pre">UBUNTU</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='UBUNTU')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.UBUNTU" title="Permalink to this definition"></a></dt>
<dd><p>Ubuntu Linux</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.UBUNTU_64">
<code class="sig-name descname"><span class="pre">UBUNTU_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='UBUNTU_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.UBUNTU_64" title="Permalink to this definition"></a></dt>
<dd><p>Ubuntu Linux (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.UNIXWARE_7">
<code class="sig-name descname"><span class="pre">UNIXWARE_7</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='UNIXWARE_7')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.UNIXWARE_7" title="Permalink to this definition"></a></dt>
<dd><p>SCO UnixWare 7</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.VMKERNEL">
<code class="sig-name descname"><span class="pre">VMKERNEL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='VMKERNEL')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL" title="Permalink to this definition"></a></dt>
<dd><p>VMware ESX 4</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_5">
<code class="sig-name descname"><span class="pre">VMKERNEL_5</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='VMKERNEL_5')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_5" title="Permalink to this definition"></a></dt>
<dd><p>VMware ESX 5</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_6">
<code class="sig-name descname"><span class="pre">VMKERNEL_6</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='VMKERNEL_6')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_6" title="Permalink to this definition"></a></dt>
<dd><p>VMware ESX 6</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_65">
<code class="sig-name descname"><span class="pre">VMKERNEL_65</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='VMKERNEL_65')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_65" title="Permalink to this definition"></a></dt>
<dd><p>VMware ESXi 6.5 AND ESXi 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_7">
<code class="sig-name descname"><span class="pre">VMKERNEL_7</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='VMKERNEL_7')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_7" title="Permalink to this definition"></a></dt>
<dd><p>VMware ESX 7. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.VMWARE_PHOTON_64">
<code class="sig-name descname"><span class="pre">VMWARE_PHOTON_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='VMWARE_PHOTON_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.VMWARE_PHOTON_64" title="Permalink to this definition"></a></dt>
<dd><p>VMware Photon (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7">
<code class="sig-name descname"><span class="pre">WINDOWS_7</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WINDOWS_7')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7" title="Permalink to this definition"></a></dt>
<dd><p>Windows 7</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7_64">
<code class="sig-name descname"><span class="pre">WINDOWS_7_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WINDOWS_7_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7_64" title="Permalink to this definition"></a></dt>
<dd><p>Windows 7 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7_SERVER_64">
<code class="sig-name descname"><span class="pre">WINDOWS_7_SERVER_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WINDOWS_7_SERVER_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7_SERVER_64" title="Permalink to this definition"></a></dt>
<dd><p>Windows Server 2008 R2 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8">
<code class="sig-name descname"><span class="pre">WINDOWS_8</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WINDOWS_8')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8" title="Permalink to this definition"></a></dt>
<dd><p>Windows 8</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8_64">
<code class="sig-name descname"><span class="pre">WINDOWS_8_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WINDOWS_8_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8_64" title="Permalink to this definition"></a></dt>
<dd><p>Windows 8 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8_SERVER_64">
<code class="sig-name descname"><span class="pre">WINDOWS_8_SERVER_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WINDOWS_8_SERVER_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8_SERVER_64" title="Permalink to this definition"></a></dt>
<dd><p>Windows 8 Server (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9">
<code class="sig-name descname"><span class="pre">WINDOWS_9</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WINDOWS_9')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9" title="Permalink to this definition"></a></dt>
<dd><p>Windows 10</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9_64">
<code class="sig-name descname"><span class="pre">WINDOWS_9_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WINDOWS_9_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9_64" title="Permalink to this definition"></a></dt>
<dd><p>Windows 10 (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9_SERVER_64">
<code class="sig-name descname"><span class="pre">WINDOWS_9_SERVER_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WINDOWS_9_SERVER_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9_SERVER_64" title="Permalink to this definition"></a></dt>
<dd><p>Windows 10 Server (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_HYPERV">
<code class="sig-name descname"><span class="pre">WINDOWS_HYPERV</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WINDOWS_HYPERV')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_HYPERV" title="Permalink to this definition"></a></dt>
<dd><p>Windows Hyper-V</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_SERVER_2019">
<code class="sig-name descname"><span class="pre">WINDOWS_SERVER_2019</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WINDOWS_SERVER_2019')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_SERVER_2019" title="Permalink to this definition"></a></dt>
<dd><p>Windows Server 2019. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WINDOWS_SERVER_2021">
<code class="sig-name descname"><span class="pre">WINDOWS_SERVER_2021</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WINDOWS_SERVER_2021')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_SERVER_2021" title="Permalink to this definition"></a></dt>
<dd><p>Windows Server 2022. This class attribute was added in vSphere API 7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_2000_ADV_SERV">
<code class="sig-name descname"><span class="pre">WIN_2000_ADV_SERV</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_2000_ADV_SERV')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_2000_ADV_SERV" title="Permalink to this definition"></a></dt>
<dd><p>Windows 2000 Advanced Server</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_2000_PRO">
<code class="sig-name descname"><span class="pre">WIN_2000_PRO</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_2000_PRO')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_2000_PRO" title="Permalink to this definition"></a></dt>
<dd><p>Windows 2000 Professional</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_2000_SERV">
<code class="sig-name descname"><span class="pre">WIN_2000_SERV</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_2000_SERV')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_2000_SERV" title="Permalink to this definition"></a></dt>
<dd><p>Windows 2000 Server</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_31">
<code class="sig-name descname"><span class="pre">WIN_31</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_31')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_31" title="Permalink to this definition"></a></dt>
<dd><p>Windows 3.1</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_95">
<code class="sig-name descname"><span class="pre">WIN_95</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_95')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_95" title="Permalink to this definition"></a></dt>
<dd><p>Windows 95</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_98">
<code class="sig-name descname"><span class="pre">WIN_98</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_98')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_98" title="Permalink to this definition"></a></dt>
<dd><p>Windows 98</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_LONGHORN">
<code class="sig-name descname"><span class="pre">WIN_LONGHORN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_LONGHORN')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_LONGHORN" title="Permalink to this definition"></a></dt>
<dd><p>Windows Longhorn (experimental)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_LONGHORN_64">
<code class="sig-name descname"><span class="pre">WIN_LONGHORN_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_LONGHORN_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_LONGHORN_64" title="Permalink to this definition"></a></dt>
<dd><p>Windows Longhorn (64 bit) (experimental)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_ME">
<code class="sig-name descname"><span class="pre">WIN_ME</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_ME')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_ME" title="Permalink to this definition"></a></dt>
<dd><p>Windows Millennium Edition</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_BUSINESS">
<code class="sig-name descname"><span class="pre">WIN_NET_BUSINESS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_NET_BUSINESS')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_BUSINESS" title="Permalink to this definition"></a></dt>
<dd><p>Windows Small Business Server 2003</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_DATACENTER">
<code class="sig-name descname"><span class="pre">WIN_NET_DATACENTER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_NET_DATACENTER')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_DATACENTER" title="Permalink to this definition"></a></dt>
<dd><p>Windows Server 2003, Datacenter Edition</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_DATACENTER_64">
<code class="sig-name descname"><span class="pre">WIN_NET_DATACENTER_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_NET_DATACENTER_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_DATACENTER_64" title="Permalink to this definition"></a></dt>
<dd><p>Windows Server 2003, Datacenter Edition (64 bit) (experimental)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_ENTERPRISE">
<code class="sig-name descname"><span class="pre">WIN_NET_ENTERPRISE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_NET_ENTERPRISE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_ENTERPRISE" title="Permalink to this definition"></a></dt>
<dd><p>Windows Server 2003, Enterprise Edition</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_ENTERPRISE_64">
<code class="sig-name descname"><span class="pre">WIN_NET_ENTERPRISE_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_NET_ENTERPRISE_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_ENTERPRISE_64" title="Permalink to this definition"></a></dt>
<dd><p>Windows Server 2003, Enterprise Edition (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_STANDARD">
<code class="sig-name descname"><span class="pre">WIN_NET_STANDARD</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_NET_STANDARD')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_STANDARD" title="Permalink to this definition"></a></dt>
<dd><p>Windows Server 2003, Standard Edition</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_STANDARD_64">
<code class="sig-name descname"><span class="pre">WIN_NET_STANDARD_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_NET_STANDARD_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_STANDARD_64" title="Permalink to this definition"></a></dt>
<dd><p>Windows Server 2003, Standard Edition (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NET_WEB">
<code class="sig-name descname"><span class="pre">WIN_NET_WEB</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_NET_WEB')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_WEB" title="Permalink to this definition"></a></dt>
<dd><p>Windows Server 2003, Web Edition</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_NT">
<code class="sig-name descname"><span class="pre">WIN_NT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_NT')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NT" title="Permalink to this definition"></a></dt>
<dd><p>Windows NT 4</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_VISTA">
<code class="sig-name descname"><span class="pre">WIN_VISTA</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_VISTA')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_VISTA" title="Permalink to this definition"></a></dt>
<dd><p>Windows Vista</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_VISTA_64">
<code class="sig-name descname"><span class="pre">WIN_VISTA_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_VISTA_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_VISTA_64" title="Permalink to this definition"></a></dt>
<dd><p>Windows Vista (64 bit)</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_XP_HOME">
<code class="sig-name descname"><span class="pre">WIN_XP_HOME</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_XP_HOME')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_XP_HOME" title="Permalink to this definition"></a></dt>
<dd><p>Windows XP Home Edition</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_XP_PRO">
<code class="sig-name descname"><span class="pre">WIN_XP_PRO</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_XP_PRO')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_XP_PRO" title="Permalink to this definition"></a></dt>
<dd><p>Windows XP Professional</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOS.WIN_XP_PRO_64">
<code class="sig-name descname"><span class="pre">WIN_XP_PRO_64</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOS(string='WIN_XP_PRO_64')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOS.WIN_XP_PRO_64" title="Permalink to this definition"></a></dt>
<dd><p>Windows XP Professional Edition (64 bit)</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.GuestOSFamily">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm_client.</span></code><code class="sig-name descname"><span class="pre">GuestOSFamily</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOSFamily" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">GuestOSFamily</span></code> class defines the valid guest operating system family
types reported by a virtual machine. This enumeration was added in vSphere
API 6.7.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <a class="reference internal" href="#com.vmware.vcenter.vm_client.GuestOSFamily" title="com.vmware.vcenter.vm_client.GuestOSFamily"><code class="xref py py-class docutils literal notranslate"><span class="pre">GuestOSFamily</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOSFamily.DARWIN">
<code class="sig-name descname"><span class="pre">DARWIN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOSFamily(string='DARWIN')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOSFamily.DARWIN" title="Permalink to this definition"></a></dt>
<dd><p>Mac OS operating system. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOSFamily.LINUX">
<code class="sig-name descname"><span class="pre">LINUX</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOSFamily(string='LINUX')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOSFamily.LINUX" title="Permalink to this definition"></a></dt>
<dd><p>Linux operating system. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOSFamily.NETWARE">
<code class="sig-name descname"><span class="pre">NETWARE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOSFamily(string='NETWARE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOSFamily.NETWARE" title="Permalink to this definition"></a></dt>
<dd><p>Novell Netware. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOSFamily.OTHER">
<code class="sig-name descname"><span class="pre">OTHER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOSFamily(string='OTHER')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOSFamily.OTHER" title="Permalink to this definition"></a></dt>
<dd><p>Other operating systems. This class attribute was added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOSFamily.SOLARIS">
<code class="sig-name descname"><span class="pre">SOLARIS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOSFamily(string='SOLARIS')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOSFamily.SOLARIS" title="Permalink to this definition"></a></dt>
<dd><p>Solaris operating system. This class attribute was added in vSphere API
6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.GuestOSFamily.WINDOWS">
<code class="sig-name descname"><span class="pre">WINDOWS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">GuestOSFamily(string='WINDOWS')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.GuestOSFamily.WINDOWS" title="Permalink to this definition"></a></dt>
<dd><p>Windows operating system. This class attribute was added in vSphere API
6.7.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Hardware">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm_client.</span></code><code class="sig-name descname"><span class="pre">Hardware</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Hardware</span></code> class provides methods for configuring the virtual
hardware of a virtual machine.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Hardware.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upgrade_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upgrade_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upgrade_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upgrade_error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Hardware.Info</span></code> class contains information related to the virtual
hardware of a virtual machine.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.Version" title="com.vmware.vcenter.vm_client.Hardware.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.Version</span></code></a>) Virtual hardware version.</p></li>
<li><p><strong>upgrade_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy" title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.UpgradePolicy</span></code></a>) Scheduled upgrade policy.</p></li>
<li><p><strong>upgrade_version</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.Version" title="com.vmware.vcenter.vm_client.Hardware.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.Version</span></code></a>) Target hardware version to be used on the next scheduled virtual
hardware upgrade.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">upgradePolicy</span></code> is one of
<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN" title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN</span></code></a> or
<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.ALWAYS" title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.ALWAYS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Hardware.UpgradePolicy.ALWAYS</span></code></a>.</p></li>
<li><p><strong>upgrade_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus" title="com.vmware.vcenter.vm_client.Hardware.UpgradeStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.UpgradeStatus</span></code></a>) Scheduled upgrade status.</p></li>
<li><p><strong>upgrade_error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code>) Reason for the scheduled upgrade failure.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">upgradeStatus</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.FAILED" title="com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Hardware.UpgradeStatus.FAILED</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Hardware.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">upgrade_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upgrade_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Hardware.UpdateSpec</span></code> class describes the updates to virtual hardware
settings of a virtual machine.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>upgrade_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy" title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.UpgradePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Scheduled upgrade policy.</p>
<p>If set to <a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER" title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Hardware.UpgradePolicy.NEVER</span></code></a>, the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Hardware.Info.upgrade_version</span></code> attribute will be reset to
None.
If None, the value is unchanged.</p>
</p></li>
<li><p><strong>upgrade_version</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.Version" title="com.vmware.vcenter.vm_client.Hardware.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.Version</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Target hardware version to be used on the next scheduled virtual
hardware upgrade.</p>
<p>If specified, this attribute must represent a newer virtual
hardware version than the current virtual hardware version reported
in <code class="xref py py-attr docutils literal notranslate"><span class="pre">Hardware.Info.version</span></code>.
If <code class="xref py py-attr docutils literal notranslate"><span class="pre">Hardware.UpdateSpec.upgrade_policy</span></code> is set to
<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER" title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Hardware.UpgradePolicy.NEVER</span></code></a>, this attribute must be None.
Otherwise, if this attribute is None, default to the most recent
virtual hardware version supported by the server.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpgradePolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Hardware.UpgradePolicy</span></code> class defines the valid virtual hardware
upgrade policies for a virtual machine.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">UpgradePolicy</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN">
<code class="sig-name descname"><span class="pre">AFTER_CLEAN_SHUTDOWN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpgradePolicy(string='AFTER_CLEAN_SHUTDOWN')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN" title="Permalink to this definition"></a></dt>
<dd><p>Run scheduled upgrade when the virtual machine is powered on after a clean
shutdown of the guest operating system.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.ALWAYS">
<code class="sig-name descname"><span class="pre">ALWAYS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpgradePolicy(string='ALWAYS')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.ALWAYS" title="Permalink to this definition"></a></dt>
<dd><p>Run scheduled upgrade when the virtual machine is powered on.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER">
<code class="sig-name descname"><span class="pre">NEVER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpgradePolicy(string='NEVER')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER" title="Permalink to this definition"></a></dt>
<dd><p>Do not upgrade the virtual machine when it is powered on.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradeStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpgradeStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Hardware.UpgradeStatus</span></code> class defines the valid virtual hardware
upgrade statuses for a virtual machine.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">UpgradeStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.FAILED">
<code class="sig-name descname"><span class="pre">FAILED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpgradeStatus(string='FAILED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.FAILED" title="Permalink to this definition"></a></dt>
<dd><p>The most recent scheduled upgrade was not successful.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.NONE">
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpgradeStatus(string='NONE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.NONE" title="Permalink to this definition"></a></dt>
<dd><p>No scheduled upgrade has been attempted.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.PENDING">
<code class="sig-name descname"><span class="pre">PENDING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpgradeStatus(string='PENDING')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.PENDING" title="Permalink to this definition"></a></dt>
<dd><p>Upgrade is scheduled but has not yet been run.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.SUCCESS">
<code class="sig-name descname"><span class="pre">SUCCESS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpgradeStatus(string='SUCCESS')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.SUCCESS" title="Permalink to this definition"></a></dt>
<dd><p>The most recent scheduled upgrade was successful.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Version</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Hardware.Version</span></code> class defines the valid virtual hardware versions
for a virtual machine. See <a class="reference external" href="https://kb.vmware.com/s/article/1003746">https://kb.vmware.com/s/article/1003746</a> (Virtual
machine hardware versions (1003746)).</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Version</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_03">
<code class="sig-name descname"><span class="pre">VMX_03</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_03')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_03" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 3, first supported in ESXi 2.5.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_04">
<code class="sig-name descname"><span class="pre">VMX_04</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_04')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_04" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 4, first supported in ESXi 3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_06">
<code class="sig-name descname"><span class="pre">VMX_06</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_06')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_06" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 6, first supported in WS 6.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_07">
<code class="sig-name descname"><span class="pre">VMX_07</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_07')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_07" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 7, first supported in ESXi 4.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_08">
<code class="sig-name descname"><span class="pre">VMX_08</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_08')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_08" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 8, first supported in ESXi 5.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_09">
<code class="sig-name descname"><span class="pre">VMX_09</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_09')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_09" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 9, first supported in ESXi 5.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_10">
<code class="sig-name descname"><span class="pre">VMX_10</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_10')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_10" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 10, first supported in ESXi 5.5.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_11">
<code class="sig-name descname"><span class="pre">VMX_11</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_11')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_11" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 11, first supported in ESXi 6.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_12">
<code class="sig-name descname"><span class="pre">VMX_12</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_12')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_12" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 12, first supported in Workstation 12.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_13">
<code class="sig-name descname"><span class="pre">VMX_13</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_13')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_13" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 13, first supported in ESXi 6.5.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_14">
<code class="sig-name descname"><span class="pre">VMX_14</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_14')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_14" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 14, first supported in ESXi 6.7. This class attribute was
added in vSphere API 6.7.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_15">
<code class="sig-name descname"><span class="pre">VMX_15</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_15')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_15" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 15, first supported in ESXi 6.7 Update 2. This class
attribute was added in vSphere API 6.7.2.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_16">
<code class="sig-name descname"><span class="pre">VMX_16</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_16')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_16" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 16, first supported in Workstation 15.0. This class
attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_17">
<code class="sig-name descname"><span class="pre">VMX_17</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_17')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_17" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 17, first supported in ESXi 7.0.0-0. This class attribute
was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_18">
<code class="sig-name descname"><span class="pre">VMX_18</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_18')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_18" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 18, first supported in ESXi 7.0 U1. This class attribute
was added in vSphere API 7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Hardware.Version.VMX_19">
<code class="sig-name descname"><span class="pre">VMX_19</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Version(string='VMX_19')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_19" title="Permalink to this definition"></a></dt>
<dd><p>Hardware version 19, first supported in ESXi 7.0 U2. This class attribute
was added in vSphere API 7.0.2.0.</p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.Hardware.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the virtual hardware settings of a virtual machine.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Virtual machine identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.Info" title="com.vmware.vcenter.vm_client.Hardware.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Virtual hardware settings of the virtual machine.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if the virtual machines configuration state cannot be accessed.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.Hardware.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.update" title="Permalink to this definition"></a></dt>
<dd><p>Updates the virtual hardware settings of a virtual machine.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Virtual machine identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.UpdateSpec" title="com.vmware.vcenter.vm_client.Hardware.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.UpdateSpec</span></code></a>) Specification for updating the virtual hardware settings of the
virtual machine.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
if the virtual machine is already configured for the desired
hardware version.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the requested virtual hardware version is not newer than the
current version.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the requested virtual hardware version is not supported by the
server.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
if the virtual machine is busy performing another operation.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if the virtual machines configuration state cannot be accessed.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.Hardware.upgrade">
<code class="sig-name descname"><span class="pre">upgrade</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Hardware.upgrade" title="Permalink to this definition"></a></dt>
<dd><p>Upgrades the virtual machine to a newer virtual hardware version.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Virtual machine identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
<li><p><strong>version</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Hardware.Version" title="com.vmware.vcenter.vm_client.Hardware.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hardware.Version</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) New virtual machine version.
If None, defaults to the most recent virtual hardware version
supported by the server.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the virtual machine is not powered off.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
if the virtual machine is already configured for the desired
hardware version.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">version</span></code> is older than the current virtual hardware version.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">version</span></code> is not supported by the server.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
if the virtual machine is busy performing another operation.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if the virtual machines configuration state cannot be accessed.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Identity">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm_client.</span></code><code class="sig-name descname"><span class="pre">Identity</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Identity" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Identity</span></code> class provides methods for managing the identity of a
virtual machine. This class was added in vSphere API 6.7.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Identity.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bios_uuid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance_uuid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Identity.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Identity.Info</span></code> class contains information about the identity of a
virtual machine. This class was added in vSphere API 6.7.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Virtual machine name. This attribute was added in vSphere API
6.7.1.</p></li>
<li><p><strong>bios_uuid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
<li><p><strong>instance_uuid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.LibraryItem">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm_client.</span></code><code class="sig-name descname"><span class="pre">LibraryItem</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.LibraryItem" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem</span></code> class provides methods to identify virtual machines
managed by Content Library. This class was added in vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.LibraryItem.CheckOutInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CheckOutInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">library_item</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.LibraryItem.CheckOutInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.CheckOutInfo</span></code> class contains information about a virtual
machine checked out of a content library item. This class was added in
vSphere API 6.9.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.LibraryItem.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">check_out</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.LibraryItem.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItem.Info</span></code> class contains information about the library item
associated with a virtual machine. This class was added in vSphere API
6.9.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>check_out</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.LibraryItem.CheckOutInfo" title="com.vmware.vcenter.vm_client.LibraryItem.CheckOutInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.CheckOutInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.LibraryItem.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.LibraryItem.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the information about the library item associated with the
virtual machine. This method was added in vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm_client.LibraryItem.Info" title="com.vmware.vcenter.vm_client.LibraryItem.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItem.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the library item associated with the virtual
machine.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user that requested the method cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Power">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm_client.</span></code><code class="sig-name descname"><span class="pre">Power</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Power</span></code> class provides methods for managing the power state of a
virtual machine.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Power.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clean_power_off</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Power.Info</span></code> class contains information about the power state of a
virtual machine.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Power.State" title="com.vmware.vcenter.vm_client.Power.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Power.State</span></code></a>) Power state of the virtual machine.</p></li>
<li><p><strong>clean_power_off</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) 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 <code class="docutils literal notranslate"><span class="pre">state</span></code> is <a class="reference internal" href="#com.vmware.vcenter.vm_client.Power.State.POWERED_OFF" title="com.vmware.vcenter.vm_client.Power.State.POWERED_OFF"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Power.State.POWERED_OFF</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Power.State">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">State</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.State" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Power.State</span></code> class defines the valid power states for a virtual
machine.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Power.State.POWERED_OFF">
<code class="sig-name descname"><span class="pre">POWERED_OFF</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='POWERED_OFF')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.State.POWERED_OFF" title="Permalink to this definition"></a></dt>
<dd><p>The virtual machine is powered off.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Power.State.POWERED_ON">
<code class="sig-name descname"><span class="pre">POWERED_ON</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='POWERED_ON')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.State.POWERED_ON" title="Permalink to this definition"></a></dt>
<dd><p>The virtual machine is powered on.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Power.State.SUSPENDED">
<code class="sig-name descname"><span class="pre">SUSPENDED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='SUSPENDED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.State.SUSPENDED" title="Permalink to this definition"></a></dt>
<dd><p>The virtual machine is suspended.</p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.Power.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the power state information of a virtual machine.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Virtual machine identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm_client.Power.Info" title="com.vmware.vcenter.vm_client.Power.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Power.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Power state information for the specified virtual machine.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if the virtual machines configuration or execution state cannot be
accessed.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.Power.reset">
<code class="sig-name descname"><span class="pre">reset</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.reset" title="Permalink to this definition"></a></dt>
<dd><p>Resets a powered-on virtual machine.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Virtual machine identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the virtual machine is powered off or suspended.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
if the virtual machine is performing another operation</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.Interact.Reset</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.Power.start">
<code class="sig-name descname"><span class="pre">start</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.start" title="Permalink to this definition"></a></dt>
<dd><p>Powers on a powered-off or suspended virtual machine.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Virtual machine identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
if the virtual machine is already powered on.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the virtual machine does not support being powered on (e.g.
marked as a template, serving as a fault-tolerance secondary
virtual machine).</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
if 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).</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
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).</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
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).</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
if the virtual machine is performing another operation.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.Interact.PowerOn</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.Power.stop">
<code class="sig-name descname"><span class="pre">stop</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.stop" title="Permalink to this definition"></a></dt>
<dd><p>Powers off a powered-on or suspended virtual machine.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Virtual machine identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
if the virtual machine is already powered off.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
if the virtual machine is performing another operation.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.Interact.PowerOff</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.Power.suspend">
<code class="sig-name descname"><span class="pre">suspend</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Power.suspend" title="Permalink to this definition"></a></dt>
<dd><p>Suspends a powered-on virtual machine.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Virtual machine identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
if the virtual machine is already suspended.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the virtual machine is powered off.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
if the virtual machine is performing another operation.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesnt have the required privileges.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the parameter
<code class="docutils literal notranslate"><span class="pre">vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">VirtualMachine.Interact.Suspend</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Tools">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm_client.</span></code><code class="sig-name descname"><span class="pre">Tools</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Tools</span></code> class provides methods for managing VMware Tools in the guest
operating system. This class was added in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Tools.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auto_update_supported</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">install_attempt_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upgrade_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">install_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">run_state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Tools.Info</span></code> class describes the VMWare Tools properties of a virtual
machine. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>auto_update_supported</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Set if the virtual machine supports auto-upgrading Tools via
<a class="reference internal" href="#com.vmware.vcenter.vm_client.Tools.UpgradePolicy" title="com.vmware.vcenter.vm_client.Tools.UpgradePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tools.UpgradePolicy</span></code></a>. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>install_attempt_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Number of 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.</p></li>
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>version_number</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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) &lt;&lt; 10) + ((MNR) &lt;&lt; 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</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>upgrade_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Tools.UpgradePolicy" title="com.vmware.vcenter.vm_client.Tools.UpgradePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tools.UpgradePolicy</span></code></a>) Tools upgrade policy setting for the virtual machine.
<a class="reference internal" href="#com.vmware.vcenter.vm_client.Tools.UpgradePolicy" title="com.vmware.vcenter.vm_client.Tools.UpgradePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tools.UpgradePolicy</span></code></a>. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>version_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Tools.VersionStatus" title="com.vmware.vcenter.vm_client.Tools.VersionStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tools.VersionStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>install_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Tools.ToolsInstallType" title="com.vmware.vcenter.vm_client.Tools.ToolsInstallType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tools.ToolsInstallType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>run_state</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Tools.RunState" title="com.vmware.vcenter.vm_client.Tools.RunState"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tools.RunState</span></code></a>) Current run state of VMware Tools in the guest operating system.
This attribute was added in vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Tools.RunState">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">RunState</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.RunState" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>Current run state of VMware Tools in the guest operating system. This
enumeration was added in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">RunState</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.RunState.EXECUTING_SCRIPTS">
<code class="sig-name descname"><span class="pre">EXECUTING_SCRIPTS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">RunState(string='EXECUTING_SCRIPTS')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.RunState.EXECUTING_SCRIPTS" title="Permalink to this definition"></a></dt>
<dd><p>VMware Tools is running scripts as part of a state transition. This class
attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.RunState.NOT_RUNNING">
<code class="sig-name descname"><span class="pre">NOT_RUNNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">RunState(string='NOT_RUNNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.RunState.NOT_RUNNING" title="Permalink to this definition"></a></dt>
<dd><p>VMware Tools is not running. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.RunState.RUNNING">
<code class="sig-name descname"><span class="pre">RUNNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">RunState(string='RUNNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.RunState.RUNNING" title="Permalink to this definition"></a></dt>
<dd><p>VMware Tools is running. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Tools.ToolsInstallType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ToolsInstallType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.ToolsInstallType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Tools.ToolsInstallType</span></code> class defines the installation type of the
Tools in the guest operating system. This enumeration was added in vSphere
API 7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ToolsInstallType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.ToolsInstallType.MSI">
<code class="sig-name descname"><span class="pre">MSI</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ToolsInstallType(string='MSI')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.ToolsInstallType.MSI" title="Permalink to this definition"></a></dt>
<dd><p>MSI is the installation type used for VMware Tools on Windows. This class
attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.ToolsInstallType.OPEN_VM_TOOLS">
<code class="sig-name descname"><span class="pre">OPEN_VM_TOOLS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ToolsInstallType(string='OPEN_VM_TOOLS')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.ToolsInstallType.OPEN_VM_TOOLS" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.ToolsInstallType.OSP">
<code class="sig-name descname"><span class="pre">OSP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ToolsInstallType(string='OSP')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.ToolsInstallType.OSP" title="Permalink to this definition"></a></dt>
<dd><p>OSPs are RPM or Debian packages tailored for the OS in the VM. See
<a class="reference external" href="http://packages.vmware.com">http://packages.vmware.com</a>. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.ToolsInstallType.TAR">
<code class="sig-name descname"><span class="pre">TAR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ToolsInstallType(string='TAR')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.ToolsInstallType.TAR" title="Permalink to this definition"></a></dt>
<dd><p>Tools have been installed by the tar installer. This class attribute was
added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.ToolsInstallType.UNKNOWN">
<code class="sig-name descname"><span class="pre">UNKNOWN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ToolsInstallType(string='UNKNOWN')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.ToolsInstallType.UNKNOWN" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Tools.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">upgrade_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The (\&#64;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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>upgrade_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Tools.UpgradePolicy" title="com.vmware.vcenter.vm_client.Tools.UpgradePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tools.UpgradePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Tools upgrade policy setting for the virtual machine.
<a class="reference internal" href="#com.vmware.vcenter.vm_client.Tools.UpgradePolicy" title="com.vmware.vcenter.vm_client.Tools.UpgradePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tools.UpgradePolicy</span></code></a>. This attribute was added in vSphere
API 7.0.0.0.
If None the upgrade policy will not be modified.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Tools.UpgradePolicy">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpgradePolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.UpgradePolicy" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Tools.UpgradePolicy</span></code> class defines when Tools are auto-upgraded for
a virtual machine. This enumeration was added in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">UpgradePolicy</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.UpgradePolicy.MANUAL">
<code class="sig-name descname"><span class="pre">MANUAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpgradePolicy(string='MANUAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.UpgradePolicy.MANUAL" title="Permalink to this definition"></a></dt>
<dd><p>No auto-upgrades for Tools will be performed for this virtual machine.
Users must manually invoke the <a class="reference internal" href="#com.vmware.vcenter.vm_client.Tools.upgrade" title="com.vmware.vcenter.vm_client.Tools.upgrade"><code class="xref py py-func docutils literal notranslate"><span class="pre">Tools.upgrade()</span></code></a> method to update
Tools. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.UpgradePolicy.UPGRADE_AT_POWER_CYCLE">
<code class="sig-name descname"><span class="pre">UPGRADE_AT_POWER_CYCLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">UpgradePolicy(string='UPGRADE_AT_POWER_CYCLE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.UpgradePolicy.UPGRADE_AT_POWER_CYCLE" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_client.Tools.VersionStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VersionStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.VersionStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Tools.VersionStatus</span></code> 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.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">VersionStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.VersionStatus.BLACKLISTED">
<code class="sig-name descname"><span class="pre">BLACKLISTED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VersionStatus(string='BLACKLISTED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.BLACKLISTED" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.VersionStatus.CURRENT">
<code class="sig-name descname"><span class="pre">CURRENT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VersionStatus(string='CURRENT')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.CURRENT" title="Permalink to this definition"></a></dt>
<dd><p>VMware Tools is installed, and the version is current. This class attribute
was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.VersionStatus.NOT_INSTALLED">
<code class="sig-name descname"><span class="pre">NOT_INSTALLED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VersionStatus(string='NOT_INSTALLED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.NOT_INSTALLED" title="Permalink to this definition"></a></dt>
<dd><p>VMware Tools has never been installed. This class attribute was added in
vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.VersionStatus.SUPPORTED_NEW">
<code class="sig-name descname"><span class="pre">SUPPORTED_NEW</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VersionStatus(string='SUPPORTED_NEW')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.SUPPORTED_NEW" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.VersionStatus.SUPPORTED_OLD">
<code class="sig-name descname"><span class="pre">SUPPORTED_OLD</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VersionStatus(string='SUPPORTED_OLD')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.SUPPORTED_OLD" title="Permalink to this definition"></a></dt>
<dd><p>VMware Tools is installed, supported, but a newer version is available.
This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.VersionStatus.TOO_NEW">
<code class="sig-name descname"><span class="pre">TOO_NEW</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VersionStatus(string='TOO_NEW')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.TOO_NEW" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.VersionStatus.TOO_OLD_UNSUPPORTED">
<code class="sig-name descname"><span class="pre">TOO_OLD_UNSUPPORTED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VersionStatus(string='TOO_OLD_UNSUPPORTED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.TOO_OLD_UNSUPPORTED" title="Permalink to this definition"></a></dt>
<dd><p>VMware Tools is installed, but the version is too old. This class attribute
was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_client.Tools.VersionStatus.UNMANAGED">
<code class="sig-name descname"><span class="pre">UNMANAGED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VersionStatus(string='UNMANAGED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.UNMANAGED" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.Tools.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the properties of VMware Tools. This method was added in vSphere
API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm_client.Tools.Info" title="com.vmware.vcenter.vm_client.Tools.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tools.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>VMware Tools properties.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.Tools.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.update" title="Permalink to this definition"></a></dt>
<dd><p>Update the properties of VMware Tools. This method was added in vSphere
API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.Tools.UpdateSpec" title="com.vmware.vcenter.vm_client.Tools.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tools.UpdateSpec</span></code></a>) The new values.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Tools.UpdateSpec.upgrade_policy</span></code> attribute contains a
value that is not supported by the server.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_client.Tools.upgrade">
<code class="sig-name descname"><span class="pre">upgrade</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">command_line_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_client.Tools.upgrade" title="Permalink to this definition"></a></dt>
<dd><p>Begins the Tools upgrade process. To monitor the status of the Tools
upgrade, clients should check the Tools status by calling
<a class="reference internal" href="#com.vmware.vcenter.vm_client.Tools.get" title="com.vmware.vcenter.vm_client.Tools.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Tools.get()</span></code></a> and examining <code class="docutils literal notranslate"><span class="pre">versionStatus</span></code> and <code class="docutils literal notranslate"><span class="pre">runState</span></code>.
This method was added in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
<li><p><strong>command_line_options</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Command line options passed to the installer to modify the
installation procedure for Tools.
Set if any additional options are desired.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the virtual machine is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the VMware Tools are not running.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the virtual machine is not powered on.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyInDesiredState" title="com.vmware.vapi.std.errors_client.AlreadyInDesiredState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyInDesiredState</span></code></a>
is an upgrade is already in progress.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the upgrade process fails inside the guest operating system.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.vm_template_client">
<span id="com-vmware-vcenter-vm-template-client-module"></span><h2>com.vmware.vcenter.vm_template_client module<a class="headerlink" href="#module-com.vmware.vcenter.vm_template_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_template_client</span></code> module provides classes and
classes that will let its client manage VMTX template in Content Library.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm_template_client.</span></code><code class="sig-name descname"><span class="pre">LibraryItems</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems</span></code> 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
<code class="docutils literal notranslate"><span class="pre">LibraryItems</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CpuInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CpuInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cores_per_socket</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CpuInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CpuInfo</span></code> class contains CPU related information about
the virtual machine template. This class was added in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Number of CPU cores. This attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>cores_per_socket</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Number of CPU cores per socket. This attribute was added in vSphere
API 6.8.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CpuUpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CpuUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_cpus</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_cores_per_socket</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CpuUpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CpuUpdateSpec</span></code> class describes updates to the CPU
configuration of the deployed virtual machine. This class was added in
vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>num_cpus</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Number of virtual processors in the deployed virtual machine. This
attribute was added in vSphere API 6.8.
If {\&#64;term.unset}, the deployed virtual machine has the same CPU
count as the source virtual machine template contained in the
library item.</p></li>
<li><p><strong>num_cores_per_socket</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Number of cores among which to distribute CPUs in the deployed
virtual machine. This attribute was added in vSphere API 6.8.
If {\&#64;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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreatePlacementSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreatePlacementSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">folder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_pool</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreatePlacementSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CreatePlacementSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
If None, the virtual machine template will be placed in the same
folder as the source virtual machine.</p></li>
<li><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.
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.</p></li>
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Host onto which the virtual machine template should be placed. If
<code class="docutils literal notranslate"><span class="pre">host</span></code> and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code>
must belong to <code class="docutils literal notranslate"><span class="pre">host</span></code>. If <code class="docutils literal notranslate"><span class="pre">host</span></code> and <code class="docutils literal notranslate"><span class="pre">cluster</span></code> are both
specified, <code class="docutils literal notranslate"><span class="pre">host</span></code> must be a member of <code class="docutils literal notranslate"><span class="pre">cluster</span></code>. 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:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
This attribute may be None if <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="pre">cluster</span></code> 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.</p></li>
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Cluster onto which the virtual machine template should be placed.
If <code class="docutils literal notranslate"><span class="pre">cluster</span></code> and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified,
<code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> must belong to <code class="docutils literal notranslate"><span class="pre">cluster</span></code>. If <code class="docutils literal notranslate"><span class="pre">cluster</span></code> and
<code class="docutils literal notranslate"><span class="pre">host</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">host</span></code> must be a member of
<code class="docutils literal notranslate"><span class="pre">cluster</span></code>. 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
If <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="pre">host</span></code> is specified, it is recommended
that this attribute be None.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_vm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">library</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_home_storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disk_storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disk_storage_overrides</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">placement</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec</span></code> class defines the information required to
create a library item containing a virtual machine template. This class was
added in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>source_vm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the library item. This attribute was added in vSphere API
6.8.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Description of the 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.</p></li>
<li><p><strong>library</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code>.</p></li>
<li><p><strong>vm_home_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStorage" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStorage"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStorage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Storage location for the virtual machine templates configuration
and log files. This attribute was added in vSphere API 6.8.
If None, the virtual machine templates configuration and log files
are placed on the default storage backing associated with the
library specified by <code class="docutils literal notranslate"><span class="pre">library</span></code>.</p></li>
<li><p><strong>disk_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStorage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Storage specification for the virtual machine templates disks.
This attribute was added in vSphere API 6.8.
If both <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> are None, the
virtual machine templates disks are placed in the default storage
backing associated with the library specified by <code class="docutils literal notranslate"><span class="pre">library</span></code>.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is None and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
specified, all of the virtual machine templates disks are created
with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is specified and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
None, disks with identifiers that are not in
<code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> are placed in the default storage backing
associated with the library specified by <code class="docutils literal notranslate"><span class="pre">library</span></code>.</p>
<p>If both <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> are specified,
disks with identifiers that are not in <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> are
created with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
</p></li>
<li><p><strong>disk_storage_overrides</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStorage</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>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 <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
a value of this class as a return value, the key in the attribute
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.
If both <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> are None, the
virtual machine templates disks are placed in the default storage
backing associated with the library specified by <code class="docutils literal notranslate"><span class="pre">library</span></code>.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is None and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
specified, all of the virtual machine templates disks are created
with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is specified and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
None, disks with identifiers that are not in
<code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> are placed in the default storage backing
associated with the library specified by <code class="docutils literal notranslate"><span class="pre">library</span></code>.</p>
<p>If both <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> are specified,
disks with identifiers that are not in <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> are
created with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
</p></li>
<li><p><strong>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreatePlacementSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreatePlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreatePlacementSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>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.</p>
<p>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.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpecDiskStorage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datastore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStorage</span></code> class defines the storage
specification for a virtual machine templates disks. This class was added
in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Identifier for the datastore associated with a virtual machine
templates 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:
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
This attribute is currently required.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">storagePolicy</span></code> is also specified and is incompatible with the
<code class="docutils literal notranslate"><span class="pre">datastore</span></code>, then the disk will be flagged as being out of
compliance with the specified storage policy.</p>
</p></li>
<li><p><strong>storage_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStoragePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Storage policy for a virtual machine templates disk. This
attribute was added in vSphere API 6.8.
If None, <code class="docutils literal notranslate"><span class="pre">datastore</span></code> must be specified and the virtual machine
templates disk is created with the default storage policy
associated with the <code class="docutils literal notranslate"><span class="pre">datastore</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpecDiskStoragePolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStoragePolicy</span></code> class defines the storage
policy specification for a virtual machine templates disks. This class was
added in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStoragePolicy.Type</span></code></a>) Policy type to be used when creating a virtual machine templates
disk. This attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>Policy type for a virtual machine templates disk. This enumeration was
added in vSphere API 6.8.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY">
<code class="sig-name descname"><span class="pre">USE_SPECIFIED_POLICY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='USE_SPECIFIED_POLICY')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY" title="Permalink to this definition"></a></dt>
<dd><p>Use the specified policy. This class attribute was added in vSphere API
6.8.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStorage">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpecVmHomeStorage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datastore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStorage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStorage</span></code> class defines the storage
specification for a virtual machine templates configuration and log files.
This class was added in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Identifier of the datastore for the virtual machine templates
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:
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
This attribute is currently required.</p>
<p>When <code class="docutils literal notranslate"><span class="pre">storagePolicy</span></code> is also specified and is incompatible with
the <code class="docutils literal notranslate"><span class="pre">datastore</span></code>, then the virtual machine template will be
flagged as being out of compliance with the specified storage
policy.</p>
</p></li>
<li><p><strong>storage_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStoragePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Storage policy for the virtual machine templates configuration and
log files. This attribute was added in vSphere API 6.8.
If None, <code class="docutils literal notranslate"><span class="pre">datastore</span></code> must be specified and the virtual machine
templates configuration and log files are created with the default
storage policy associated with the <code class="docutils literal notranslate"><span class="pre">datastore</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpecVmHomeStoragePolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStoragePolicy</span></code> class defines the
storage policy specification for a virtual machine templates configuration
and log files. This class was added in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStoragePolicy.Type</span></code></a>) Policy type to be used when creating the virtual machine templates
configuration and log files. This attribute was added in vSphere
API 6.8.</p></li>
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>Policy type for the virtual machine templates configuration and log files.
This enumeration was added in vSphere API 6.8.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY">
<code class="sig-name descname"><span class="pre">USE_SPECIFIED_POLICY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='USE_SPECIFIED_POLICY')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY" title="Permalink to this definition"></a></dt>
<dd><p>Use the specified policy. This class attribute was added in vSphere API
6.8.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeployPlacementSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DeployPlacementSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">folder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_pool</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeployPlacementSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DeployPlacementSpec</span></code> class contains information used to
place a virtual machine onto resources within the vCenter inventory. This
class was added in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>folder</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>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: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Folder</span></code>.
This attribute is currently required.</p>
<p>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.</p>
</p></li>
<li><p><strong>resource_pool</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code>.
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.</p></li>
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Host onto which the virtual machine should be placed. If <code class="docutils literal notranslate"><span class="pre">host</span></code>
and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> must
belong to <code class="docutils literal notranslate"><span class="pre">host</span></code>. If <code class="docutils literal notranslate"><span class="pre">host</span></code> and <code class="docutils literal notranslate"><span class="pre">cluster</span></code> are both specified,
<code class="docutils literal notranslate"><span class="pre">host</span></code> must be a member of <code class="docutils literal notranslate"><span class="pre">cluster</span></code>. 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:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
This attribute may be None if <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="pre">cluster</span></code> 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.</p></li>
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Cluster onto which the deployed virtual machine should be placed.
If <code class="docutils literal notranslate"><span class="pre">cluster</span></code> and <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> are both specified,
<code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> must belong to <code class="docutils literal notranslate"><span class="pre">cluster</span></code>. If <code class="docutils literal notranslate"><span class="pre">cluster</span></code> and
<code class="docutils literal notranslate"><span class="pre">host</span></code> are both specified, <code class="docutils literal notranslate"><span class="pre">host</span></code> must be a member of
<code class="docutils literal notranslate"><span class="pre">cluster</span></code>. 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:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
If <code class="docutils literal notranslate"><span class="pre">resourcePool</span></code> or <code class="docutils literal notranslate"><span class="pre">host</span></code> is specified, it is recommended
that this attribute be None.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DeploySpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_home_storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disk_storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disk_storage_overrides</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">placement</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">powered_on</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guest_customization</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hardware_customization</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DeploySpec</span></code> class defines the deployment parameters
that can be specified for the <code class="docutils literal notranslate"><span class="pre">deploy</span></code> method. This class was added in
vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Name of the deployed virtual machine. This attribute was added in
vSphere API 6.8.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Description of the 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.</p></li>
<li><p><strong>vm_home_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStorage" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStorage"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStorage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Storage location for the deployed virtual machines configuration
and log files. This attribute was added in vSphere API 6.8.
If None, the deployed virtual machines configuration and log files
are created with the same storage spec as the source virtual
machine templates configuration and log files.</p></li>
<li><p><strong>disk_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStorage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Storage specification for the deployed virtual machines disks.
This attribute was added in vSphere API 6.8.
If both <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> are None, the
deployed virtual machines disks are created with the same storage
spec as the corresponding disks in the source virtual machine
template contained in the library item.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is None and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
specified, all of the deployed virtual machines disks are created
with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is specified and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
None, disks with identifiers that are not in
<code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> are created with the same storage spec as
the corresponding disks in the source virtual machine template
contained in the library item.</p>
<p>If both <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> are specified,
disks with identifiers that are not in <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> are
created with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
</p></li>
<li><p><strong>disk_storage_overrides</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStorage</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>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 <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
a value of this class as a return value, the key in the attribute
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.
If both <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> are None, the
deployed virtual machines disks are created with the same storage
spec as the corresponding disks in the source virtual machine
template contained in the library item.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is None and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
specified, all of the deployed virtual machines disks are created
with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> is specified and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> is
None, disks with identifiers that are not in
<code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> are created with the same storage spec as
the corresponding disks in the source virtual machine template
contained in the library item.</p>
<p>If both <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> and <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code> are specified,
disks with identifiers that are not in <code class="docutils literal notranslate"><span class="pre">diskStorageOverrides</span></code> are
created with the storage spec specified by <code class="docutils literal notranslate"><span class="pre">diskStorage</span></code>.</p>
</p></li>
<li><p><strong>placement</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeployPlacementSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeployPlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeployPlacementSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>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.</p>
<p>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.</p>
</p></li>
<li><p><strong>powered_on</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>guest_customization</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.GuestCustomizationSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.GuestCustomizationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.GuestCustomizationSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>hardware_customization</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.HardwareCustomizationSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.HardwareCustomizationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.HardwareCustomizationSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DeploySpecDiskStorage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datastore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStorage</span></code> class contains the storage
specification for disks in the virtual machine. This class was added in
vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Identifier for the datastore associated the deployed virtual
machines 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:
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
This attribute is currently required.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">storagePolicy</span></code> is also specified and is incompatible with the
<code class="docutils literal notranslate"><span class="pre">datastore</span></code>, then the disk will be flagged as being out of
compliance with the specified storage policy.</p>
</p></li>
<li><p><strong>storage_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStoragePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Storage policy for the deployed virtual machines disk. This
attribute was added in vSphere API 6.8.
If None, <code class="docutils literal notranslate"><span class="pre">datastore</span></code> must be specified and the deployed virtual
machines disk is created with the default storage policy
associated with the <code class="docutils literal notranslate"><span class="pre">datastore</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DeploySpecDiskStoragePolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStoragePolicy</span></code> class describes the
storage policy specification for the deployed virtual machines disks. This
class was added in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStoragePolicy.Type</span></code></a>) Policy type to be used when creating the deployed virtual machines
disk. This attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>Policy type for the deployed virtual machines disk. This enumeration was
added in vSphere API 6.8.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SOURCE_POLICY">
<code class="sig-name descname"><span class="pre">USE_SOURCE_POLICY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='USE_SOURCE_POLICY')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SOURCE_POLICY" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY">
<code class="sig-name descname"><span class="pre">USE_SPECIFIED_POLICY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='USE_SPECIFIED_POLICY')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY" title="Permalink to this definition"></a></dt>
<dd><p>Use the specified policy. This class attribute was added in vSphere API
6.8.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStorage">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DeploySpecVmHomeStorage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datastore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStorage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStorage</span></code> class defines the storage
specification for a deployed virtual machines configuration and log files.
This class was added in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Identifier of the datastore for the deployed virtual machines
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:
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.
This attribute is currently required.</p>
<p>When <code class="docutils literal notranslate"><span class="pre">storagePolicy</span></code> is also specified and is incompatible with
the <code class="docutils literal notranslate"><span class="pre">datastore</span></code>, then the deployed virtual machine will be
flagged as being out of compliance with the specified storage
policy.</p>
</p></li>
<li><p><strong>storage_policy</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStoragePolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Storage policy for the deployed virtual machines configuration and
log files. This attribute was added in vSphere API 6.8.
If None, <code class="docutils literal notranslate"><span class="pre">datastore</span></code> must be specified and the deployed virtual
machines configuration and log files are created with the default
storage policy associated with the <code class="docutils literal notranslate"><span class="pre">datastore</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DeploySpecVmHomeStoragePolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStoragePolicy</span></code> class defines the
storage policy specification for the deployed virtual machines
configuration and log files. This class was added in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStoragePolicy.Type</span></code></a>) Policy type to be used when creating the deployed virtual machines
configuration and log files. This attribute was added in vSphere
API 6.8.</p></li>
<li><p><strong>policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>Policy type for the deployed virtual machines configuration and log files.
This enumeration was added in vSphere API 6.8.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SOURCE_POLICY">
<code class="sig-name descname"><span class="pre">USE_SOURCE_POLICY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='USE_SOURCE_POLICY')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SOURCE_POLICY" title="Permalink to this definition"></a></dt>
<dd><p>Use the storage policy that is associated with the source virtual machine
templates configuration and log files. This class attribute was added in
vSphere API 6.8.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY">
<code class="sig-name descname"><span class="pre">USE_SPECIFIED_POLICY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='USE_SPECIFIED_POLICY')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY" title="Permalink to this definition"></a></dt>
<dd><p>Use the specified policy. This class attribute was added in vSphere API
6.8.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DiskInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DiskInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disk_storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DiskInfo</span></code> class contains information about the virtual
machine templates virtual disk. This class was added in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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.</p></li>
<li><p><strong>disk_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskStorageInfo" title="com.vmware.vcenter.vm_template_client.LibraryItems.DiskStorageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DiskStorageInfo</span></code></a>) Disk storage related information. This attribute was added in
vSphere API 6.8.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DiskStorageInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DiskStorageInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datastore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskStorageInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DiskStorageInfo</span></code> class contains storage related
information about a virtual machine templates virtual disk. This class was
added in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p></li>
<li><p><strong>storage_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Identifier of the storage policy associated with the virtual 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>.
If None, the virtual disk does not have a storage policy associated
with it.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.DiskUpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">DiskUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskUpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.DiskUpdateSpec</span></code> class describes updates to the
configuration of a virtual disk in the deployed virtual machine. This class
was added in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) 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.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">EthernetInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">backing_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mac_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.EthernetInfo</span></code> class contains information about a
virtual machine templates virtual Ethernet adapter. This class was added
in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>backing_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType" title="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.EthernetInfo.NetworkBackingType</span></code></a>) Network backing type for the virtual Ethernet adapter. This
attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>mac_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType" title="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.EthernetInfo.MacAddressType</span></code></a>) MAC address type of the ethernet adapter. This attribute was added
in vSphere API 6.8.</p></li>
<li><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Identifier of the 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: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
This attribute will be None if the identifier of the network
backing could not be determined.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">MacAddressType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.EthernetInfo.MacAddressType</span></code> class defines the valid
MAC address origins for a virtual Ethernet adapter. This enumeration was
added in vSphere API 6.8.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">MacAddressType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType.ASSIGNED">
<code class="sig-name descname"><span class="pre">ASSIGNED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MacAddressType(string='ASSIGNED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType.ASSIGNED" title="Permalink to this definition"></a></dt>
<dd><p>MAC address is assigned by vCenter Server. This class attribute was added
in vSphere API 6.8.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType.GENERATED">
<code class="sig-name descname"><span class="pre">GENERATED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MacAddressType(string='GENERATED')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType.GENERATED" title="Permalink to this definition"></a></dt>
<dd><p>MAC address is generated automatically. This class attribute was added in
vSphere API 6.8.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType.MANUAL">
<code class="sig-name descname"><span class="pre">MANUAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MacAddressType(string='MANUAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType.MANUAL" title="Permalink to this definition"></a></dt>
<dd><p>MAC address is assigned statically. This class attribute was added in
vSphere API 6.8.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NetworkBackingType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.EthernetInfo.NetworkBackingType</span></code> class defines valid
network backing types for a virtual Ethernet adapter. This enumeration was
added in vSphere API 6.8.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">NetworkBackingType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.DISTRIBUTED_PORTGROUP">
<code class="sig-name descname"><span class="pre">DISTRIBUTED_PORTGROUP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetworkBackingType(string='DISTRIBUTED_PORTGROUP')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.DISTRIBUTED_PORTGROUP" title="Permalink to this definition"></a></dt>
<dd><p>Distributed virtual switch backing. This class attribute was added in
vSphere API 6.8.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.HOST_DEVICE">
<code class="sig-name descname"><span class="pre">HOST_DEVICE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetworkBackingType(string='HOST_DEVICE')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.HOST_DEVICE" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.OPAQUE_NETWORK">
<code class="sig-name descname"><span class="pre">OPAQUE_NETWORK</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetworkBackingType(string='OPAQUE_NETWORK')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.OPAQUE_NETWORK" title="Permalink to this definition"></a></dt>
<dd><p>Opaque network backing. This class attribute was added in vSphere API 6.8.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.STANDARD_PORTGROUP">
<code class="sig-name descname"><span class="pre">STANDARD_PORTGROUP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">NetworkBackingType(string='STANDARD_PORTGROUP')</span></em><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.STANDARD_PORTGROUP" title="Permalink to this definition"></a></dt>
<dd><p>vSphere standard portgroup network backing. This class attribute was added
in vSphere API 6.8.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetUpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">EthernetUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetUpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.EthernetUpdateSpec</span></code> 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.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>network</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>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: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">Network</span></code>.
This attribute is currently required.</p>
<p>If None, the virtual Ethernet adapter will be connected to same
network as it was in the source virtual machine template.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.GuestCustomizationSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">GuestCustomizationSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.GuestCustomizationSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.GuestCustomizationSpec</span></code> class contains information
required to customize the deployed virtual machine. This class was added in
vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Name of the customization specification. This attribute was added
in vSphere API 6.8.
If None, no guest customization is performed.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.HardwareCustomizationSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">HardwareCustomizationSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nics</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disks_to_remove</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disks_to_update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu_update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.HardwareCustomizationSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.HardwareCustomizationSpec</span></code> class defines the hardware
customization options that are applied to the deployed virtual machine.
This class was added in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>nics</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetUpdateSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.EthernetUpdateSpec</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>. When methods
return a value of this class as a return value, the key in the
attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>.
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.</p></li>
<li><p><strong>disks_to_remove</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return a
value of this class as a return value, the attribute will contain
identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.
If None, all disks will be copied.</p></li>
<li><p><strong>disks_to_update</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskUpdateSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.DiskUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DiskUpdateSpec</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) 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 <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
a value of this class as a return value, the key in the attribute
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.
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.</p></li>
<li><p><strong>cpu_update</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CpuUpdateSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.CpuUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CpuUpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) CPU update specification for the deployed virtual machine. This
attribute was added in vSphere API 6.8.
If {\&#64;term.unset}, the deployed virtual machine has the same CPU
settings as the source virtual machine template contained in the
library item.</p></li>
<li><p><strong>memory_update</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.MemoryUpdateSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.MemoryUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.MemoryUpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Memory update specification for the deployed virtual machine. This
attribute was added in vSphere API 6.8.
If {\&#64;term.unset}, the deployed virtual machine has the same
memory settings as the source virtual machine template contained in
the library item.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guest_os</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cpu</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_home_storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nics</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.Info</span></code> class contains information about a virtual
machine template item in content library. This class was added in vSphere
API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>guest_os</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_client.GuestOS" title="com.vmware.vcenter.vm_client.GuestOS"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm_client.GuestOS</span></code></a>) Configured guest operating system of the virtual machine template.
This attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>cpu</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CpuInfo" title="com.vmware.vcenter.vm_template_client.LibraryItems.CpuInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CpuInfo</span></code></a>) CPU configuration of the virtual machine template. This attribute
was added in vSphere API 6.8.</p></li>
<li><p><strong>memory</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.MemoryInfo" title="com.vmware.vcenter.vm_template_client.LibraryItems.MemoryInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.MemoryInfo</span></code></a>) Memory configuration of the virtual machine template. This
attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>vm_home_storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.VmHomeStorageInfo" title="com.vmware.vcenter.vm_template_client.LibraryItems.VmHomeStorageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.VmHomeStorageInfo</span></code></a>) Storage information about the virtual machine templates
configuration and log files. This attribute was added in vSphere
API 6.8.</p></li>
<li><p><strong>disks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskInfo" title="com.vmware.vcenter.vm_template_client.LibraryItems.DiskInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DiskInfo</span></code></a>) Storage information about the virtual machine templates 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 <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
a value of this class as a return value, the key in the attribute
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>.</p></li>
<li><p><strong>nics</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo" title="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.EthernetInfo</span></code></a>) Information about the virtual machine templates 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 <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>. When methods
return a value of this class as a return value, the key in the
attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>.</p></li>
<li><p><strong>vm_template</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.MemoryInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">MemoryInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size_mib</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.MemoryInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.MemoryInfo</span></code> class contains memory related information
about the virtual machine template. This class was added in vSphere API
6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>size_mib</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Memory size in mebibytes. This attribute was added in vSphere API
6.8.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.MemoryUpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">MemoryUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">memory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.MemoryUpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.MemoryUpdateSpec</span></code> class describes updates to the memory
configuration of the deployed virtual machine. This class was added in
vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>memory</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Size of a virtual machines memory in MB. This attribute was added
in vSphere API 6.8.
If {\&#64;term.unset}, the deployed virtual machine has the same
memory size as the source virtual machine template.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.VmHomeStorageInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VmHomeStorageInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datastore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.VmHomeStorageInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LibraryItems.VmHomeStorageInfo</span></code> class contains storage information
about the virtual machine templates configuration and log files. This
class was added in vSphere API 6.8.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>datastore</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the datastore where the virtual machine templates
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:
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p></li>
<li><p><strong>storage_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Identifier of the storage policy associated with the virtual
machine templates 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code>.
If None, the virtual machine templates configuration and log files
do not have a storage policy associated with them.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.create" title="Permalink to this definition"></a></dt>
<dd><p>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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec</span></code></a>) information used to create the library item from the source virtual
machine.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Identifier of the newly created library item.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if an entity with the name specified by
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec.name</span></code> already exists in the folder
specified by <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreatePlacementSpec.folder</span></code>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec</span></code></a> contains invalid arguments.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the operation cannot be performed because of the source virtual
machines current state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the source virtual machine specified by
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec.source_vm</span></code> does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library specified by <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec.library</span></code>
does not exist.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if there was an error accessing a file from the source virtual
machine.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInUse" title="com.vmware.vapi.std.errors_client.ResourceInUse"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInUse</span></code></a>
if the source virtual machine is busy.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if any of the services involved in the method are unavailable.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
if any of the resources needed to create the virtual machine
template could not be allocated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user that requested the method cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</span></code> referenced by the
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec.library</span></code> requires
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.AddLibraryItem</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec.source_vm</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStorage.datastore</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code> referenced by the
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecVmHomeStoragePolicy.policy</span></code>
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStorage.datastore</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code> referenced by the
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpecDiskStoragePolicy.policy</span></code>
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code> referenced
by the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> key of attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreateSpec.disk_storage_overrides</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Folder</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreatePlacementSpec.folder</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreatePlacementSpec.resource_pool</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreatePlacementSpec.host</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.CreatePlacementSpec.cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.deploy">
<code class="sig-name descname"><span class="pre">deploy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_library_item</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.deploy" title="Permalink to this definition"></a></dt>
<dd><p>Deploys a virtual machine as a copy of the source virtual machine
template contained in the library item specified by
<code class="docutils literal notranslate"><span class="pre">template_library_item</span></code>. It uses the deployment specification in
<code class="docutils literal notranslate"><span class="pre">spec</span></code>. If <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpec.powered_on</span></code> and/or
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpec.guest_customization</span></code> 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.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>template_library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpec</span></code></a>) specification of how the virtual machine should be deployed.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Identifier of the deployed virtual machine.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">VirtualMachine</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if a virtual machine with the name specified by
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpec.name</span></code> already exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains invalid arguments.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if either a specified host or a specified datastore is in an
invalid state for the deployment, such as maintenance mode.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library item specified by <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> cannot
be found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if any resource specified by a attribute of the
<a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec" title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.DeploySpec</span></code></a> class, specified by <code class="docutils literal notranslate"><span class="pre">spec</span></code>
cannot be found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if there was an error accessing the source virtual machine template
contained in the library item specified by
<code class="docutils literal notranslate"><span class="pre">template_library_item</span></code>.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if there an error accessing any of the resources specified in the
<code class="docutils literal notranslate"><span class="pre">spec</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if any of the services involved in the method are unavailable.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
if there was an error in allocating any of the resources required
by the method.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user that requested the method cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VirtualMachine.Provisioning.DeployTemplate</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStorage.datastore</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code> referenced by the
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecVmHomeStoragePolicy.policy</span></code>
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Datastore</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStorage.datastore</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.spbm.StorageProfile</span></code> referenced by the
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpecDiskStoragePolicy.policy</span></code>
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code> referenced
by the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> key of attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeploySpec.disk_storage_overrides</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Folder</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeployPlacementSpec.folder</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ResourcePool</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeployPlacementSpec.resource_pool</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeployPlacementSpec.host</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.DeployPlacementSpec.cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Ethernet</span></code>
referenced by the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> key of attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.HardwareCustomizationSpec.nics</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">Network</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.EthernetUpdateSpec.network</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code> referenced
by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.HardwareCustomizationSpec.disks_to_remove</span></code>
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vm.hardware.Disk</span></code> referenced
by the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> key of attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LibraryItems.HardwareCustomizationSpec.disks_to_update</span></code>
requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.vm_template_client.LibraryItems.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_library_item</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.LibraryItems.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about a virtual machine template contained in the
library item specified by <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code>. This method was
added in vSphere API 6.8.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>template_library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) identifier of the library item containing the virtual machine
template.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.vm_template_client.LibraryItems.Info" title="com.vmware.vcenter.vm_template_client.LibraryItems.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">LibraryItems.Info</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the virtual machine template item contained in
the library item.
If None, the library item specified by <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code>
does not contain a virtual machine template.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library item could not be found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if the virtual machine templates configuration state cannot be
accessed.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if any of the services involved in the method are unavailable.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user that requested the method cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">template_library_item</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.vm_template_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.vm_template_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vm_template_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.vcenter.certificate_management.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.certificate_management package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="com.vmware.vapi.std.html" class="btn btn-neutral float-left" title="com.vmware.vapi.std package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2022, VMware, Inc..
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>