Repair docs (html, md). Update docstrings
This commit is contained in:
parent
e264750187
commit
6a4ad48577
125 changed files with 3706 additions and 4913 deletions
187
SRV/docs/_build/html/api/endpoints/ufw.html
vendored
187
SRV/docs/_build/html/api/endpoints/ufw.html
vendored
|
|
@ -172,7 +172,7 @@
|
|||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
|
|
@ -276,129 +276,172 @@
|
|||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<section id="module-api.v1.ufw">
|
||||
<span id="api-v1-ufw"></span><h1>api.v1.ufw<a class="headerlink" href="#module-api.v1.ufw" title="Link to this heading">¶</a></h1>
|
||||
<section id="api-v1-ufw">
|
||||
<h1>api.v1.ufw<a class="headerlink" href="#api-v1-ufw" title="Link to this heading">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="api.v1.ufw.RuleNumbers">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">RuleNumbers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">numbers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#RuleNumbers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#api.v1.ufw.RuleNumbers" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">RuleNumbers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">numbers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#RuleNumbers"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></p>
|
||||
<p>Модель запроса на удаление UFW правил.</p>
|
||||
<p>Атрибуты:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">numbers</span></code> (List[int]): Список номеров правил для удаления.</p></li>
|
||||
</ul>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="api.v1.ufw.RuleNumbers.model_config">
|
||||
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#api.v1.ufw.RuleNumbers.model_config" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em></dt>
|
||||
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="api.v1.ufw.RuleNumbers.numbers">
|
||||
<span class="sig-name descname"><span class="pre">numbers</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#api.v1.ufw.RuleNumbers.numbers" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-name descname"><span class="pre">numbers</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="api.v1.ufw.add_ufw_in_rules">
|
||||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">add_ufw_in_rules</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rules</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../models/ufw.html#models.ufw.UFWRule" title="models.ufw.UFWRule"><span class="pre">UFWRule</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#add_ufw_in_rules"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#api.v1.ufw.add_ufw_in_rules" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">add_ufw_in_rules</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rules</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">UFWRule</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#add_ufw_in_rules"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Добавляет входящие (in) правила UFW.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><dl class="simple">
|
||||
<dt>rules (List[UFWRule]): Список правил, определяющих направления,</dt><dd><p>порты/диапазоны/протоколы и действия (allow/deny/reject).</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>rules</strong> (<em>List</em><em>[</em><em>UFWRule</em><em>]</em>) – Список правил, определяющих направления,
|
||||
порты/диапазоны/протоколы и действия (allow/deny/reject).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>dict: Итог выполнения с количеством успешно добавленных правил и деталями
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>Итог выполнения с количеством успешно добавленных правил и деталями
|
||||
по каждому правилу.</p>
|
||||
</dd>
|
||||
<dt>Raises:</dt><dd><p>HTTPException: Если UFW отключен (status_code=400) или при внутренних
|
||||
ошибках (status_code=500).</p>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>dict</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><ul class="simple">
|
||||
<li><p><strong>HTTPException</strong> – Если UFW отключен (status_code=400) или при внутренних</p></li>
|
||||
<li><p><strong>ошибках</strong><strong> (</strong><strong>status_code=500</strong><strong>)</strong><strong>.</strong> – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="api.v1.ufw.add_ufw_out_rules">
|
||||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">add_ufw_out_rules</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rules</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../models/ufw.html#models.ufw.UFWRule" title="models.ufw.UFWRule"><span class="pre">UFWRule</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#add_ufw_out_rules"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#api.v1.ufw.add_ufw_out_rules" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">add_ufw_out_rules</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rules</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">UFWRule</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#add_ufw_out_rules"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Добавляет исходящие (out) правила UFW.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><p>rules (List[UFWRule]): Список правил исходящего трафика для добавления.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>rules</strong> (<em>List</em><em>[</em><em>UFWRule</em><em>]</em>) – Список правил исходящего трафика для добавления.</p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>dict: Объект статуса с сообщением об успешном добавлении.</p>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>Объект статуса с сообщением об успешном добавлении.</p>
|
||||
</dd>
|
||||
<dt>Raises:</dt><dd><p>HTTPException: Если UFW отключен (status_code=400) или при внутренних
|
||||
ошибках (status_code=500).</p>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>dict</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><ul class="simple">
|
||||
<li><p><strong>HTTPException</strong> – Если UFW отключен (status_code=400) или при внутренних</p></li>
|
||||
<li><p><strong>ошибках</strong><strong> (</strong><strong>status_code=500</strong><strong>)</strong><strong>.</strong> – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="api.v1.ufw.delete_ufw_rules">
|
||||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">delete_ufw_rules</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rule_numbers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#api.v1.ufw.RuleNumbers" title="api.v1.ufw.RuleNumbers"><span class="pre">RuleNumbers</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#delete_ufw_rules"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#api.v1.ufw.delete_ufw_rules" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">delete_ufw_rules</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rule_numbers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RuleNumbers</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#delete_ufw_rules"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Удаляет правила UFW по их номерам.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args:</dt><dd><dl class="simple">
|
||||
<dt>rule_numbers (RuleNumbers): Номера правил, подлежащих удалению (как в</dt><dd><p>выводе <cite>ufw status numbered</cite>).</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>rule_numbers</strong> (<em>RuleNumbers</em>) – Номера правил, подлежащих удалению (как в
|
||||
выводе <cite>ufw status numbered</cite>).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>dict: Информация об общем количестве удаляемых правил, числе успешных и
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>Информация об общем количестве удаляемых правил, числе успешных и
|
||||
возможной ошибке.</p>
|
||||
</dd>
|
||||
<dt>Raises:</dt><dd><p>HTTPException: При ошибках удаления (status_code=500).</p>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>dict</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><strong>HTTPException</strong> – При ошибках удаления (status_code=500).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="api.v1.ufw.disable_ufw">
|
||||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">disable_ufw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#disable_ufw"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#api.v1.ufw.disable_ufw" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">disable_ufw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#disable_ufw"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Выключает UFW.</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>dict: Словарь с ключами <cite>status</cite> и <cite>message</cite> при успешном выполнении.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>Словарь с ключами <cite>status</cite> и <cite>message</cite> при успешном выполнении.</p>
|
||||
</dd>
|
||||
<dt>Raises:</dt><dd><p>HTTPException: Если выключение завершилось неуспешно (status_code=500).</p>
|
||||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>dict</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raises<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>HTTPException</strong> – Если выключение завершилось неуспешно (status_code=500).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="api.v1.ufw.enable_ufw">
|
||||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">enable_ufw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#enable_ufw"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#api.v1.ufw.enable_ufw" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">enable_ufw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#enable_ufw"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Включает UFW.</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>dict: Словарь с ключами <cite>status</cite> и <cite>message</cite> при успешном выполнении.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>Словарь с ключами <cite>status</cite> и <cite>message</cite> при успешном выполнении.</p>
|
||||
</dd>
|
||||
<dt>Raises:</dt><dd><p>HTTPException: Если включение завершилось неуспешно (status_code=500).</p>
|
||||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>dict</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raises<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>HTTPException</strong> – Если включение завершилось неуспешно (status_code=500).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="api.v1.ufw.get_ufw_rules">
|
||||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">get_ufw_rules</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#get_ufw_rules"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#api.v1.ufw.get_ufw_rules" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">get_ufw_rules</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#get_ufw_rules"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Возвращает все правила UFW.</p>
|
||||
<p>Осуществляет обращение к сервису <cite>UFWService</cite> для чтения текущего списка
|
||||
правил брандмауэра и возвращает результат в сериализованном виде для клиента.</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>UFWRulesResponse: Структура с коллекцией правил и сопутствующей
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>Структура с коллекцией правил и сопутствующей
|
||||
информацией о состоянии.</p>
|
||||
</dd>
|
||||
<dt>Raises:</dt><dd><p>HTTPException: В случае ошибок взаимодействия с UFW (status_code=500).</p>
|
||||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>UFWRulesResponse</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raises<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>HTTPException</strong> – В случае ошибок взаимодействия с UFW (status_code=500).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="api.v1.ufw.get_ufw_status">
|
||||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">get_ufw_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#get_ufw_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#api.v1.ufw.get_ufw_status" title="Link to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ufw.</span></span><span class="sig-name descname"><span class="pre">get_ufw_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ufw.html#get_ufw_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
|
||||
<dd><p>Возвращает текущий статус UFW.</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>UFWStatus: Объект со сведениями о включенности UFW и деталями статуса.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>Объект со сведениями о включенности UFW и деталями статуса.</p>
|
||||
</dd>
|
||||
<dt>Raises:</dt><dd><p>HTTPException: Если не удалось получить статус (status_code=500).</p>
|
||||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>UFWStatus</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raises<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>HTTPException</strong> – Если не удалось получить статус (status_code=500).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -448,39 +491,9 @@
|
|||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
<aside class="toc-drawer no-toc">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">api.v1.ufw</a><ul>
|
||||
<li><a class="reference internal" href="#api.v1.ufw.RuleNumbers"><code class="docutils literal notranslate"><span class="pre">RuleNumbers</span></code></a><ul>
|
||||
<li><a class="reference internal" href="#api.v1.ufw.RuleNumbers.model_config"><code class="docutils literal notranslate"><span class="pre">RuleNumbers.model_config</span></code></a></li>
|
||||
<li><a class="reference internal" href="#api.v1.ufw.RuleNumbers.numbers"><code class="docutils literal notranslate"><span class="pre">RuleNumbers.numbers</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#api.v1.ufw.add_ufw_in_rules"><code class="docutils literal notranslate"><span class="pre">add_ufw_in_rules()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#api.v1.ufw.add_ufw_out_rules"><code class="docutils literal notranslate"><span class="pre">add_ufw_out_rules()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#api.v1.ufw.delete_ufw_rules"><code class="docutils literal notranslate"><span class="pre">delete_ufw_rules()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#api.v1.ufw.disable_ufw"><code class="docutils literal notranslate"><span class="pre">disable_ufw()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#api.v1.ufw.enable_ufw"><code class="docutils literal notranslate"><span class="pre">enable_ufw()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#api.v1.ufw.get_ufw_rules"><code class="docutils literal notranslate"><span class="pre">get_ufw_rules()</span></code></a></li>
|
||||
<li><a class="reference internal" href="#api.v1.ufw.get_ufw_status"><code class="docutils literal notranslate"><span class="pre">get_ufw_status()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue