2021-03-17 10:57:48 -04:00
<!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.esx.settings.clusters.software.reports package — vSphere Automation SDK for Python. 7.0.2.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.esx.settings.defaults package" href = "com.vmware.esx.settings.defaults.html" / >
< link rel = "prev" title = "com.vmware.esx.settings.clusters.software.drafts package" href = "com.vmware.esx.settings.clusters.software.drafts.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" >
7.0.2.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 >
2021-05-12 05:58:01 -04:00
< 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 >
2021-03-17 10:57:48 -04:00
< / 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 > » < / li >
< li > < a href = "com.html" > com package< / a > » < / li >
< li > < a href = "com.vmware.html" > com.vmware package< / a > » < / li >
< li > < a href = "com.vmware.esx.html" > com.vmware.esx package< / a > » < / li >
< li > < a href = "com.vmware.esx.settings.html" > com.vmware.esx.settings package< / a > » < / li >
< li > < a href = "com.vmware.esx.settings.clusters.html" > com.vmware.esx.settings.clusters package< / a > » < / li >
< li > < a href = "com.vmware.esx.settings.clusters.software.html" > com.vmware.esx.settings.clusters.software package< / a > » < / li >
< li > com.vmware.esx.settings.clusters.software.reports package< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/com.vmware.esx.settings.clusters.software.reports.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.esx.settings.clusters.software.reports" >
< span id = "com-vmware-esx-settings-clusters-software-reports-package" > < / span > < h1 > com.vmware.esx.settings.clusters.software.reports package< a class = "headerlink" href = "#module-com.vmware.esx.settings.clusters.software.reports" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "submodules" >
< h2 > Submodules< a class = "headerlink" href = "#submodules" title = "Permalink to this headline" > ¶< / a > < / h2 >
< / div >
2021-05-12 05:58:01 -04:00
< div class = "section" id = "module-com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client" >
< span id = "com-vmware-esx-settings-clusters-software-reports-hardware-compatibility-client-module" > < / span > < h2 > com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client module< a class = "headerlink" href = "#module-com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The
< code class = "docutils literal notranslate" > < span class = "pre" > com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client< / span > < / code >
module provides classes to manage reports pertaining to the desired state
software for a cluster of ESXi hosts.< / p >
< dl class = "py class" >
< dt id = "com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.Details" >
< em class = "property" > < span class = "pre" > class< / span > < / em > < code class = "sig-prename descclassname" > < span class = "pre" > com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.< / span > < / code > < code class = "sig-name descname" > < span class = "pre" > Details< / 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.esx.settings.clusters.software.reports.hardware_compatibility_client.Details" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
< p > The < code class = "docutils literal notranslate" > < span class = "pre" > Details< / span > < / code > class provides methods to retrieve selected results from a
previously initiated HCL compliance scan.< / 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 > ) – < / p >
< / dd >
< / dl >
< dl class = "py method" >
< dt id = "com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.Details.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.esx.settings.clusters.software.reports.hardware_compatibility_client.Details.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Returns the HCL validation check detailed results.< / 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 > ) –
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.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.CheckResult" title = "com.vmware.esx.settings.clusters.software.reports_client.CheckResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.esx.settings.clusters.software.reports_client.CheckResult< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > CheckResult HCL validation result.< / p >
< / dd >
< dt class = "field-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 other unknown internal error. The accompanying
error message will give more details about the failure and any
possible resolution(s).< / p >
< / dd >
< dt class = "field-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 cluster associated with < code class = "docutils literal notranslate" > < span class = "pre" > cluster< / span > < / code > in the system or
if desired software document 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 service is not 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.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 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" > VcIntegrity.HardwareCompatibility.Read< / 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" > VcIntegrity.HardwareCompatibility.Read< / span > < / code > .< / p > < / li >
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
< / dd > < / dl >
< dl class = "py class" >
< dt id = "com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.StubFactory" >
< em class = "property" > < span class = "pre" > class< / span > < / em > < code class = "sig-prename descclassname" > < span class = "pre" > com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_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.esx.settings.clusters.software.reports.hardware_compatibility_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 > ) – < / p >
< / dd >
< / dl >
< / dd > < / dl >
2021-03-17 10:57:48 -04:00
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "com.vmware.esx.settings.defaults.html" class = "btn btn-neutral float-right" title = "com.vmware.esx.settings.defaults package" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" > < / span > < / a >
< a href = "com.vmware.esx.settings.clusters.software.drafts.html" class = "btn btn-neutral float-left" title = "com.vmware.esx.settings.clusters.software.drafts package" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
< / div >
< hr / >
< div role = "contentinfo" >
< p >
© Copyright 2021, 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 >
