docs: update with antsibull-docs

Signed-off-by: Boris Glimcher <[email protected]>
opiproject · Mar 26, 2024 · e15bf68 · e15bf68
1 parent 0780890
commit e15bf68
Show file tree

Hide file tree

Showing 15 changed files with 1,652 additions and 7 deletions.
diff --git a/docs/bmc_factory_reset_role.rst b/docs/bmc_factory_reset_role.rst
@@ -0,0 +1,258 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+    :trim:
+
+.. meta::
+  :antsibull-docs: 2.7.0
+
+.. Anchors
+
+.. _ansible_collections.opi.dpu.bmc_factory_reset_role:
+
+.. Title
+
+opi.dpu.bmc_factory_reset role -- Factory reset of DPU BMC
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+    This role is part of the `opi.dpu collection <https://galaxy.ansible.com/ui/repo/published/opi/dpu/>`_ (version 1.0.0).
+
+    It is not included in ``ansible-core``.
+    To check whether it is installed, run :code:`ansible-galaxy collection list`.
+
+    To install it use: :code:`ansible-galaxy collection install opi.dpu`.
+
+    To use it in a playbook, specify: :code:`opi.dpu.bmc_factory_reset`.
+
+.. contents::
+   :local:
+   :depth: 2
+
+
+.. Entry point title
+
+Entry point ``main`` -- Factory reset of DPU BMC
+------------------------------------------------
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in opi.dpu 1.0.0
+
+.. Deprecated
+
+
+Synopsis
+^^^^^^^^
+
+.. Description
+
+- Reset all states of the DPU BMC to factory defaults.
+
+.. Requirements
+
+
+.. Options
+
+Parameters
+^^^^^^^^^^
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+  :width: 100%
+  :widths: auto
+  :header-rows: 1
+  :class: longtable ansible-option-table
+
+  * - Parameter
+    - Comments
+
+  * - .. raw:: html
+
+        <div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="parameter-main--hostname"></div>
+
+      .. _ansible_collections.opi.dpu.bmc_factory_reset_role__parameter-main__hostname:
+
+      .. rst-class:: ansible-option-title
+
+      **hostname**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#parameter-main--hostname" title="Permalink to this option"></a>
+
+      .. ansible-option-type-line::
+
+        :ansible-option-type:`string`
+
+
+
+
+      .. raw:: html
+
+        </div>
+
+    - .. raw:: html
+
+        <div class="ansible-option-cell">
+
+      DPU BMC IP Address.
+
+
+      .. raw:: html
+
+        </div>
+
+  * - .. raw:: html
+
+        <div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="parameter-main--https_port"></div>
+
+      .. _ansible_collections.opi.dpu.bmc_factory_reset_role__parameter-main__https_port:
+
+      .. rst-class:: ansible-option-title
+
+      **https_port**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#parameter-main--https_port" title="Permalink to this option"></a>
+
+      .. ansible-option-type-line::
+
+        :ansible-option-type:`integer`
+
+
+
+
+      .. raw:: html
+
+        </div>
+
+    - .. raw:: html
+
+        <div class="ansible-option-cell">
+
+      DPU BMC port.
+
+
+      .. rst-class:: ansible-option-line
+
+      :ansible-option-default-bold:`Default:` :ansible-option-default:`443`
+
+      .. raw:: html
+
+        </div>
+
+  * - .. raw:: html
+
+        <div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="parameter-main--password"></div>
+
+      .. _ansible_collections.opi.dpu.bmc_factory_reset_role__parameter-main__password:
+
+      .. rst-class:: ansible-option-title
+
+      **password**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#parameter-main--password" title="Permalink to this option"></a>
+
+      .. ansible-option-type-line::
+
+        :ansible-option-type:`string`
+
+
+
+
+      .. raw:: html
+
+        </div>
+
+    - .. raw:: html
+
+        <div class="ansible-option-cell">
+
+      DPU BMC user password.
+
+
+      .. raw:: html
+
+        </div>
+
+  * - .. raw:: html
+
+        <div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="parameter-main--username"></div>
+
+      .. _ansible_collections.opi.dpu.bmc_factory_reset_role__parameter-main__username:
+
+      .. rst-class:: ansible-option-title
+
+      **username**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#parameter-main--username" title="Permalink to this option"></a>
+
+      .. ansible-option-type-line::
+
+        :ansible-option-type:`string`
+
+
+
+
+      .. raw:: html
+
+        </div>
+
+    - .. raw:: html
+
+        <div class="ansible-option-cell">
+
+      DPU BMC username.
+
+
+      .. raw:: html
+
+        </div>
+
+
+.. Attributes
+
+
+.. Notes
+
+
+.. Seealso
+
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. ansible-links::
+
+  - title: "Issue Tracker"
+    url: "https://github.com/opiproject/ansible-opi-dpu/issues"
+    external: true
+  - title: "Repository (Sources)"
+    url: "https://github.com/opiproject/ansible-opi-dpu"
+    external: true
+
+
+.. Parsing errors
+