Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-29 12:00:00 -05:00
Code
f8910c5c2a
vsphere-automation-sdk-python/vsphere/8.0.0.1/com.vmware.vcenter.content.registries.html

677 lines
49 KiB
HTML
Raw Normal View History

Added docs for vSphere 8.0GA Signed-off-by: Ankit Agrawal <aagrawal3@vmware.com>
2022-10-12 08:01:15 -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.vcenter.content.registries package &mdash; vSphere Automation SDK for Python. 8.0.0.1 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.crypto_manager package" href="com.vmware.vcenter.crypto_manager.html" />
<link rel="prev" title="com.vmware.vcenter.content package" href="com.vmware.vcenter.content.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.1
</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><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.content.html">com.vmware.vcenter.content package</a> &raquo;</li>
<li>com.vmware.vcenter.content.registries package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.content.registries.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.content.registries">
<span id="com-vmware-vcenter-content-registries-package"></span><h1>com.vmware.vcenter.content.registries package<a class="headerlink" href="#module-com.vmware.vcenter.content.registries" 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>
<div class="section" id="module-com.vmware.vcenter.content.registries.harbor_client">
<span id="com-vmware-vcenter-content-registries-harbor-client-module"></span><h2>com.vmware.vcenter.content.registries.harbor_client module<a class="headerlink" href="#module-com.vmware.vcenter.content.registries.harbor_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.registries.harbor_client</span></code> module provides
classes and classes for managing Harbor registry in vCenter.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.content.registries.harbor_client.</span></code><code class="sig-name descname"><span class="pre">Projects</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.content.registries.harbor_client.Projects" title="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">Projects</span></code> class provides methods for managing the lifecycle of
Harbor project that stores and distributes container repositories and
images.</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.content.registries.harbor_client.Projects.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.content.registries.harbor_client.Projects.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">Projects.ConfigStatus</span></code> class describes the status of reaching the
desired configuration state for the Harbor project.</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.content.registries.harbor_client.Projects.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.content.registries.harbor_client.Projects.ConfigStatus.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Failed to create Harbor project or apply the configuration to the project,
user intervention needed.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.PENDING">
<code class="sig-name descname"><span class="pre">PENDING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='PENDING')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.PENDING" title="Permalink to this definition"></a></dt>
<dd><p>Harbor project is being created or the configuration is being applied to
the project.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.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.content.registries.harbor_client.Projects.ConfigStatus.READY" title="Permalink to this definition"></a></dt>
<dd><p>Harbor project is created or configured correctly.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.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.content.registries.harbor_client.Projects.ConfigStatus.REMOVING" title="Permalink to this definition"></a></dt>
<dd><p>The configuration is being removed and Harbor project is being deleted.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.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">scope</span></span><span class="o"><span class="pre">=</span></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.harbor_client.Projects.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">Projects.CreateSpec</span></code> class defines the information required to
create a Harbor project.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
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 Harbor project. Should be between 1-63 characters long
alphanumeric string and may contain the following characters:
a-z,0-9, and ‘-‘. Must be starting with characters or numbers, with
the ‘-‘ character allowed anywhere except the first or last
character.</p></li>
<li><p><strong>scope</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope" title="com.vmware.vcenter.content.registries.harbor_client.Projects.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">Projects.Scope</span></code></a>) – Access type of a Harbor project.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.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">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">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">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">update_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">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">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.content.registries.harbor_client.Projects.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">Projects.Info</span></code> class contains detailed information about a Harbor
project.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
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 Harbor project. Should be between 1-63 characters long
alphanumeric string and may contain the following characters:
a-z,0-9, and ‘-‘. Must be starting with characters or numbers, with
the ‘-‘ character allowed anywhere except the first or last
character.</p></li>
<li><p><strong>config_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus" title="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Projects.ConfigStatus</span></code></a>) – The status of the Harbor project.</p></li>
<li><p><strong>scope</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope" title="com.vmware.vcenter.content.registries.harbor_client.Projects.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">Projects.Scope</span></code></a>) – The access type of a Harbor project.</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 project creation API was
triggered and project identifier generated.</p></li>
<li><p><strong>update_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 project purge API was triggered.
In case no purge was triggered, <code class="docutils literal notranslate"><span class="pre">updateTime</span></code> is same as
<code class="docutils literal notranslate"><span class="pre">creationTime</span></code>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">configStatus</span></code> is <a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.READY" title="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Projects.ConfigStatus.READY</span></code></a>.</p></li>
<li><p><strong>access_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL to access the harbor project through docker client.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">configStatus</span></code> is <a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.READY" title="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Projects.ConfigStatus.READY</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>) – Details about the ERROR project status.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">configStatus</span></code> is <a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.ERROR" title="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.ERROR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Projects.ConfigStatus.ERROR</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.Scope">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Scope</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.content.registries.harbor_client.Projects.Scope" title="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">Projects.Scope</span></code> class in a project defines access levels of the
project.</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">Scope</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.Scope.PRIVATE">
<code class="sig-name descname"><span class="pre">PRIVATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Scope(string='PRIVATE')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope.PRIVATE" title="Permalink to this definition"></a></dt>
<dd><p>A Harbor project can only be accessed by assigned users.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.Scope.PUBLIC">
<code class="sig-name descname"><span class="pre">PUBLIC</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Scope(string='PUBLIC')</span></em><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope.PUBLIC" title="Permalink to this definition"></a></dt>
<dd><p>A Harbor project can be accessed by everyone.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.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">project</span></span><span class="o"><span class="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">scope</span></span><span class="o"><span class="pre">=</span></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.harbor_client.Projects.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">Projects.Summary</span></code> class contains basic information about a Harbor
project.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>project</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the harbor project.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry.Harbor.Project</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.Harbor.Project</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 Harbor project. Should be between 1-63 characters long
alphanumeric string and may contain the following characters:
a-z,0-9, and ‘-‘. Must be starting with characters or numbers, with
the ‘-‘ character allowed anywhere except the first or last
character.</p></li>
<li><p><strong>scope</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope" title="com.vmware.vcenter.content.registries.harbor_client.Projects.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">Projects.Scope</span></code></a>) – Access type of a Harbor project.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.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">registry</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.content.registries.harbor_client.Projects.create" title="Permalink to this definition"></a></dt>
<dd><p>Creates a project in a Harbor registry using the supplied
specification. In vSphere 7.0, a Harbor registry is deployed in a
vSphere cluster with vSphere namespaces enabled. When a namespace is
created, a project with same name as the namespace is created in the
Harbor registry, so this method should not be called.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><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></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.CreateSpec" title="com.vmware.vcenter.content.registries.harbor_client.Projects.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Projects.CreateSpec</span></code></a>) – Information used to create the Harbor project.</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 newly created Harbor project.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry.Harbor.Project</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">spec</span></code> contains any 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 Harbor registry is being deleted.</p>
</dd>
<dt class="field-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.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 project with the same name already exists in the registry. In
vSphere 7.0, the existing project could have been created
automatically when a namespace with the same name is created.</p>
</dd>
<dt class="field-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.ManageRegistryProject
privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.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">registry</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.delete" title="Permalink to this definition"></a></dt>
<dd><p>Deletes the specified project from Harbor registry. Repositories and
images in the project will be removed upon project deletion. Storage
space of deleted images in the project will be reclaimed through next
scheduled Harbor registry garbage collection. In vSphere 7.0, a Harbor
registry is deployed in a vSphere cluster with vSphere namespaces
enabled. When a namespace is deleted, a project with same name as the
namespace is deleted from the Harbor registry, so this method should
not be called.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><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></li>
<li><p><strong>project</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Harbor project.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry.Harbor.Project</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.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 Harbor registry is being deleted.</p>
</dd>
<dt class="field-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">registry</span></code> or <code class="docutils literal notranslate"><span class="pre">project</span></code> cannot be found. In vSphere 7.0, the
existing project could have been deleted automatically when a
namespace with the same name is deleted.</p>
</dd>
<dt class="field-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.ManageRegistryProject
privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.content.registries.harbor_client.Projects.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">registry</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns detailed information about the specified Harbor project.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><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></li>
<li><p><strong>project</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Harbor project.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry.Harbor.Project</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.content.registries.harbor_client.Projects.Info" title="com.vmware.vcenter.content.registries.harbor_client.Projects.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Projects.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Detailed information about the specified Harbor project.</p>
</dd>
<dt class="field-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">registry</span></code> or <code class="docutils literal notranslate"><span class="pre">project</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.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.content.registries.harbor_client.Projects.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">registry</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns basic information of all projects in a 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.harbor_client.Projects.list" title="com.vmware.vcenter.content.registries.harbor_client.Projects.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.harbor_client.Projects.Summary" title="com.vmware.vcenter.content.registries.harbor_client.Projects.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Projects.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The list of summary information of all Harbor projects.</p>
</dd>
<dt class="field-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">registry</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.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.content.registries.harbor_client.Projects.purge">
<code class="sig-name descname"><span class="pre">purge</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.purge" title="Permalink to this definition"></a></dt>
<dd><p>Remove all repositories, images and members in the project. Storage
space of deleted images in the project will be reclaimed through next
scheduled Harbor registry garbage collection.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><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></li>
<li><p><strong>project</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Harbor project.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.content.Registry.Harbor.Project</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 <code class="docutils literal notranslate"><span class="pre">registry</span></code> or <code class="docutils literal notranslate"><span class="pre">project</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.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 Harbor registry is being deleted or the project is not in
<a class="reference internal" href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.READY" title="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Projects.ConfigStatus.READY</span></code></a> status.</p>
</dd>
<dt class="field-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.ManageRegistryProject
privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.content.registries.harbor_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.content.registries.harbor_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.content.registries.harbor_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.crypto_manager.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.crypto_manager package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="com.vmware.vcenter.content.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.content 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>
Copy Permalink