Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-25 02:39:59 -05:00
Code
0735db02a9
vsphere-automation-sdk-python/vsphere/8.0.1.0/com.vmware.vcenter.content.html
Shweta 968fbec7b4
Referesh vsphere Docs for 8.0U1 release (#371) 
Signed-off-by: shweta purohit <spurohit@vmware.com>
2023-04-19 17:55:36 +05:30

761 lines
68 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.vcenter.content package &mdash; vSphere Automation SDK for Python. 8.0.1.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" 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 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.content.registries package" href="com.vmware.vcenter.content.registries.html" />
<link rel="prev" title="com.vmware.vcenter.consumption_domains.zones package" href="com.vmware.vcenter.consumption_domains.zones.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.1.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" aria-label="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="Navigation menu">
<p class="caption" role="heading"><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="Mobile navigation menu" >
<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="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a></li>
<li class="breadcrumb-item active">com.vmware.vcenter.content package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.content.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">
<section id="module-com.vmware.vcenter.content">
<span id="com-vmware-vcenter-content-package"></span><h1>com.vmware.vcenter.content package<a class="headerlink" href="#module-com.vmware.vcenter.content" title="Permalink to this headline"></a></h1>
<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.content.registries.html">com.vmware.vcenter.content.registries package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.content.registries.html#submodules">Submodules</a></li>
<li class="toctree-l2"><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>
</div>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</section>
<section id="module-com.vmware.vcenter.content.registries_client">
<span id="com-vmware-vcenter-content-registries-client-module"></span><h2>com.vmware.vcenter.content.registries_client module<a class="headerlink" href="#module-com.vmware.vcenter.content.registries_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.registries_client</span></code> module provides classes
and classes for managing image registries in vCenter.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.DayOfWeek">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.content.registries_client.</span></span><span class="sig-name descname"><span class="pre">DayOfWeek</span></span><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.content.registries_client.DayOfWeek" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DayOfWeek</span></code> class describes the supported days of the week to run a
specific operation for a container registry.</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.content.registries_client.DayOfWeek" title="com.vmware.vcenter.content.registries_client.DayOfWeek"><code class="xref py py-class docutils literal notranslate"><span class="pre">DayOfWeek</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.DayOfWeek.FRIDAY">
<span class="sig-name descname"><span class="pre">FRIDAY</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='FRIDAY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.DayOfWeek.FRIDAY" title="Permalink to this definition"></a></dt>
<dd><p>Friday.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.DayOfWeek.MONDAY">
<span class="sig-name descname"><span class="pre">MONDAY</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='MONDAY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.DayOfWeek.MONDAY" title="Permalink to this definition"></a></dt>
<dd><p>Monday.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.DayOfWeek.SATURDAY">
<span class="sig-name descname"><span class="pre">SATURDAY</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='SATURDAY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.DayOfWeek.SATURDAY" title="Permalink to this definition"></a></dt>
<dd><p>Saturday.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.DayOfWeek.SUNDAY">
<span class="sig-name descname"><span class="pre">SUNDAY</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='SUNDAY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.DayOfWeek.SUNDAY" title="Permalink to this definition"></a></dt>
<dd><p>Sunday.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.DayOfWeek.THURSDAY">
<span class="sig-name descname"><span class="pre">THURSDAY</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='THURSDAY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.DayOfWeek.THURSDAY" title="Permalink to this definition"></a></dt>
<dd><p>Thursday.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.DayOfWeek.TUESDAY">
<span class="sig-name descname"><span class="pre">TUESDAY</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='TUESDAY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.DayOfWeek.TUESDAY" title="Permalink to this definition"></a></dt>
<dd><p>Tuesday.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.DayOfWeek.WEDNESDAY">
<span class="sig-name descname"><span class="pre">WEDNESDAY</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DayOfWeek(string='WEDNESDAY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.DayOfWeek.WEDNESDAY" title="Permalink to this definition"></a></dt>
<dd><p>Wednesday.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Harbor">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.content.registries_client.</span></span><span class="sig-name descname"><span class="pre">Harbor</span></span><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.content.registries_client.Harbor" title="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">Harbor</span></code> class provides methods to manage the lifecycle of an
integrated Harbor container registry in 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 class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Harbor.CreateSpec">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">CreateSpec</span></span><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">garbage_collection</span></span><span class="o"><span class="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.content.registries_client.Harbor.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">Harbor.CreateSpec</span></code> class contains the specification required to
create a Harbor registry.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the cluster hosting the registry.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<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 None, registry will not be created on a specified cluster. This
is required in current version, since Harbor can only be created on
a cluster with Kubernetes enabled.</p></li>
<li><p><strong>garbage_collection</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection" title="com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Harbor.GarbageCollection</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Garbage collection configuration for the Harbor registry.
If None, a default configuration is set, Recurrence#WEEKLY,
DayOfWeek#SATURDAY, GarbageCollection#hour is 2,
GarbageCollection#minute is 0.</p></li>
<li><p><strong>storage</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.content.registries_client.Harbor.StorageSpec" title="com.vmware.vcenter.content.registries_client.Harbor.StorageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Harbor.StorageSpec</span></code></a>) – Storage associated with the Harbor registry. The list contains only
one storage backing in this version.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">GarbageCollection</span></span><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">day_of_week</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hour</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minute</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Harbor.GarbageCollection</span></code> class contains garbage collection
configuration for the Harbor registry.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
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.content.registries_client.Recurrence" title="com.vmware.vcenter.content.registries_client.Recurrence"><code class="xref py py-class docutils literal notranslate"><span class="pre">Recurrence</span></code></a>) – Frequency of garbage collection.</p></li>
<li><p><strong>day_of_week</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.DayOfWeek" title="com.vmware.vcenter.content.registries_client.DayOfWeek"><code class="xref py py-class docutils literal notranslate"><span class="pre">DayOfWeek</span></code></a>) – Day of the week when garbage collection should run.
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.content.registries_client.Recurrence.WEEKLY" title="com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Recurrence.WEEKLY</span></code></a>.</p></li>
<li><p><strong>hour</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Hour at which garbage collection should run.
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.content.registries_client.Recurrence.DAILY" title="com.vmware.vcenter.content.registries_client.Recurrence.DAILY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Recurrence.DAILY</span></code></a> or
<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY" title="com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Recurrence.WEEKLY</span></code></a>.</p></li>
<li><p><strong>minute</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Minute at which garbage collection should run.
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.content.registries_client.Recurrence.DAILY" title="com.vmware.vcenter.content.registries_client.Recurrence.DAILY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Recurrence.DAILY</span></code></a> or
<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY" title="com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Recurrence.WEEKLY</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Harbor.Info">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Info</span></span><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">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">creation_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">ui_access_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">cert_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">garbage_collection</span></span><span class="o"><span class="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">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.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">Harbor.Info</span></code> class contains detailed information about a running
Harbor registry.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the cluster.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<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 None, container registry is not created on the cluster specified
by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Harbor.CreateSpec.cluster</span></code>.</p></li>
<li><p><strong>namespace</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 Harbor namespace in case it is created in a
Kubernetes environment.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">NamespaceInstance</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">NamespaceInstance</span></code>.
If None, no Kubernetes namespace is created for the Harbor.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the registry.</p></li>
<li><p><strong>creation_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The date and time when the harbor registry was created.</p></li>
<li><p><strong>ui_access_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL to access the UI of the registry.</p></li>
<li><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>) – Harbor certificate chain in base64 format.</p></li>
<li><p><strong>garbage_collection</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection" title="com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Harbor.GarbageCollection</span></code></a>) – Garbage collection information for the registry.</p></li>
<li><p><strong>storage</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.content.registries_client.Harbor.StorageInfo" title="com.vmware.vcenter.content.registries_client.Harbor.StorageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Harbor.StorageInfo</span></code></a>) – Storage information associated with the registry.</p></li>
<li><p><strong>health</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Health.Info" title="com.vmware.vcenter.content.registries_client.Health.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Health.Info</span></code></a>) – Health status of the container registry.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Harbor.StorageInfo">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">StorageInfo</span></span><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">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">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.content.registries_client.Harbor.StorageInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Harbor.StorageInfo</span></code> class contains the detailed information about
storage used by the Harbor registry.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
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.
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>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Total capacity for the registry storage (in mebibytes). This is the
storage limit set on the Harbor registry. If a storage limit was
not set on the registry, the default registry capacity - 204800
mebibytes is used.</p></li>
<li><p><strong>used</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Overall storage used by the registry (in mebibytes). This is the
sum of used storage associated with storage policies configured for
the registry.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Harbor.StorageSpec">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">StorageSpec</span></span><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.content.registries_client.Harbor.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">Harbor.StorageSpec</span></code> class contains the specification required to
configure storage associated with a Harbor registry. In this version,
Harbor registry is created in Kubernetes environment, information in this
class will result in storage quotas on a Kubernetes namespace.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
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.
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 registry for this specification.
If None, a default limit of 204800 mebibytes will be set as the
registry’s storage capacity.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Harbor.Summary">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Summary</span></span><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">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">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">ui_access_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.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">Harbor.Summary</span></code> class contains basic information about a running
Harbor registry.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the cluster.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<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 None, container registry is not created on the cluster specified
by <code class="xref py py-attr docutils literal notranslate"><span class="pre">Harbor.CreateSpec.cluster</span></code>.</p></li>
<li><p><strong>registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the registry.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</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.content.Registry</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the registry.</p></li>
<li><p><strong>ui_access_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL to access the UI of the registry.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Harbor.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.content.registries_client.Harbor.create" title="Permalink to this definition"></a></dt>
<dd><p>Creates a Harbor registry in the cluster.</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>) – A unique token generated on the client for each creation request.
The token should be a universally unique identifier (UUID), for
example: <code class="docutils literal notranslate"><span class="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></code>. This token can
be used to guarantee idempotent creation.
If not specified, creation is not idempotent.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Harbor.CreateSpec" title="com.vmware.vcenter.content.registries_client.Harbor.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Harbor.CreateSpec</span></code></a>) – Specification for creating the Harbor registry.</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 registry.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</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 Harbor already exists in the associated 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.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-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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">Harbor.CreateSpec.cluster</span></code> does not have vSphere
namespace 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.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.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 ContentLibrary.ManageRegistry and/or
CertificateAuthority.Manage privilege, or user does not have
ContentLibrary.ManageClusterRegistryResource privilege on
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Harbor.CreateSpec.cluster</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Harbor.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete the Harbor registry in the cluster. All Harbor projects,
repositories and images will be deleted upon Harbor registry deletion.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the registry.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</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 registry specified by <code class="docutils literal notranslate"><span class="pre">registry</span></code> could not 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.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 ContentLibrary.ManageRegistry privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Harbor.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.get" title="Permalink to this definition"></a></dt>
<dd><p>Get detailed information of the Harbor registry.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the registry.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Harbor.Info" title="com.vmware.vcenter.content.registries_client.Harbor.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Harbor.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the registry.</p>
</dd>
<dt class="field-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 Harbor registry specified by <code class="docutils literal notranslate"><span class="pre">registry</span></code> could not 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.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 class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Harbor.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Harbor.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns basic information of all Harbor registries.</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.content.registries_client.Harbor.list" title="com.vmware.vcenter.content.registries_client.Harbor.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.content.registries_client.Harbor.Summary" title="com.vmware.vcenter.content.registries_client.Harbor.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Harbor.Summary</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The list of basic information of all Harbor registries.</p>
</dd>
<dt class="field-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 class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Health">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.content.registries_client.</span></span><span class="sig-name descname"><span class="pre">Health</span></span><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.content.registries_client.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.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Health</span></code> class provides methods to retrieve health status for a
container registry.</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 class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Health.Info">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Info</span></span><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">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.content.registries_client.Health.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">Health.Info</span></code> class contains health information about a container
registry.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
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.content.registries_client.Health.Status" title="com.vmware.vcenter.content.registries_client.Health.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Health.Status</span></code></a>) – Container registry status.</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>) – Details about the status.
If None, message details are not required for taking actions.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Health.Status">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Status</span></span><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.content.registries_client.Health.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Health.Status</span></code> class describes the status of the container registry.</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 class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Health.Status.DELETING">
<span class="sig-name descname"><span class="pre">DELETING</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='DELETING')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Health.Status.DELETING" title="Permalink to this definition"></a></dt>
<dd><p>Container registry is being deleted.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Health.Status.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Health.Status.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Container registry failed to start or stopped with fatal error.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Health.Status.RUNNING">
<span class="sig-name descname"><span class="pre">RUNNING</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='RUNNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Health.Status.RUNNING" title="Permalink to this definition"></a></dt>
<dd><p>Container registry is running.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Health.Status.STARTING">
<span class="sig-name descname"><span class="pre">STARTING</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='STARTING')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Health.Status.STARTING" title="Permalink to this definition"></a></dt>
<dd><p>Container registry is starting.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Health.Status.WARNING">
<span class="sig-name descname"><span class="pre">WARNING</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Health.Status.WARNING" title="Permalink to this definition"></a></dt>
<dd><p>Container registry is running with some warning, for example, storage
reaches the threshold configuration.</p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Health.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Health.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the health information of a container registry in the vCenter.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the registry.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.content.registries_client.Health.Info" title="com.vmware.vcenter.content.registries_client.Health.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Health.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Health information of the registry.</p>
</dd>
<dt class="field-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 registry 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.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 is not a member of the Administrators</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Recurrence">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.content.registries_client.</span></span><span class="sig-name descname"><span class="pre">Recurrence</span></span><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.content.registries_client.Recurrence" title="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">Recurrence</span></code> class defines the supported values for how often to run
a specific operation for a container registry.</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.content.registries_client.Recurrence" title="com.vmware.vcenter.content.registries_client.Recurrence"><code class="xref py py-class docutils literal notranslate"><span class="pre">Recurrence</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Recurrence.DAILY">
<span class="sig-name descname"><span class="pre">DAILY</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Recurrence(string='DAILY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Recurrence.DAILY" title="Permalink to this definition"></a></dt>
<dd><p>An operation occurs on a daily basis.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Recurrence.NONE">
<span class="sig-name descname"><span class="pre">NONE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Recurrence(string='NONE')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Recurrence.NONE" title="Permalink to this definition"></a></dt>
<dd><p>No operation is scheduled.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY">
<span class="sig-name descname"><span class="pre">WEEKLY</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Recurrence(string='WEEKLY')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY" title="Permalink to this definition"></a></dt>
<dd><p>An operation occurs on a weekly basis.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.content.registries_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.content.registries_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><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.content.registries_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>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="com.vmware.vcenter.consumption_domains.zones.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.consumption_domains.zones package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="com.vmware.vcenter.content.registries.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.content.registries package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, 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>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink