diff options
Diffstat (limited to 'ansible_collections/kaytus/ksmanage/docs')
129 files changed, 45774 insertions, 0 deletions
diff --git a/ansible_collections/kaytus/ksmanage/docs/ad_group_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/ad_group_info_module.rst new file mode 100644 index 000000000..123f0ef6c --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ad_group_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.ad_group_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.ad_group_info -- Get active directory group information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.ad_group_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get active directory group information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Ad group test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get active directory group information"
+ kaytus.ksmanage.ad_group_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/ad_group_module.rst b/ansible_collections/kaytus/ksmanage/docs/ad_group_module.rst new file mode 100644 index 000000000..bbb4efc72 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ad_group_module.rst @@ -0,0 +1,431 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.ad_group_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.ad_group -- Manage active directory group information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.ad_group`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Manage active directory group information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-domain"></div>
+ <b>domain</b>
+ <a class="ansibleOptionLink" href="#parameter-domain" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Enter the Role Group Domain. This is the domain where the role group is located.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-kvm"></div>
+ <b>kvm</b>
+ <a class="ansibleOptionLink" href="#parameter-kvm" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>This field provides access to KVM for AD authenticated role group user.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-name"></div>
+ <b>name</b>
+ <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Enter the Role Group Name. This name identifies the role group in Active Directory.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-pri"></div>
+ <b>pri</b>
+ <a class="ansibleOptionLink" href="#parameter-pri" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>administrator</li>
+ <li>user</li>
+ <li>operator</li>
+ <li>oem</li>
+ <li>none</li>
+ </ul>
+ </td>
+ <td>
+ <div>Enter the Role Group Privilege. This is the level of privilege to be assigned for this role group.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li><div style="color: blue"><b>present</b> ←</div></li>
+ <li>absent</li>
+ </ul>
+ </td>
+ <td>
+ <div>Whether the active directory group should exist or not, taking action if the state is different from what is stated.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-vm"></div>
+ <b>vm</b>
+ <a class="ansibleOptionLink" href="#parameter-vm" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>This field provides access to VMedia for AD authenticated role group user.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Ad group test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Add active directory group information"
+ kaytus.ksmanage.ad_group:
+ state: "present"
+ name: "wbs"
+ domain: "test.com"
+ pri: "administrator"
+ kvm: "enable"
+ vm: "disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set active directory group information"
+ kaytus.ksmanage.ad_group:
+ state: "present"
+ name: "wbs"
+ pri: "user"
+ kvm: "disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Delete active directory group information"
+ kaytus.ksmanage.ad_group:
+ state: "absent"
+ name: "wbs"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/ad_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/ad_info_module.rst new file mode 100644 index 000000000..b75defd6b --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ad_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.ad_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.ad_info -- Get active directory information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.ad_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get active directory information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Ad test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get active directory information"
+ kaytus.ksmanage.ad_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/adapter_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/adapter_info_module.rst new file mode 100644 index 000000000..9b87ba31d --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/adapter_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.adapter_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.adapter_info -- Get adapter information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.adapter_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get adapter information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Adapter test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get adapter information"
+ kaytus.ksmanage.adapter_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/add_ldisk_module.rst b/ansible_collections/kaytus/ksmanage/docs/add_ldisk_module.rst new file mode 100644 index 000000000..c5eec8c88 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/add_ldisk_module.rst @@ -0,0 +1,589 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.add_ldisk_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.add_ldisk -- Create logical disk
+++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.add_ldisk`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Create logical disk on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-accelerator"></div>
+ <b>accelerator</b>
+ <a class="ansibleOptionLink" href="#parameter-accelerator" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ </ul>
+ </td>
+ <td>
+ <div>Driver accelerator, 1 - 1h, 2 - 2h, 3 - 3h.</div>
+ <div>Required when controller type is PMC.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-access"></div>
+ <b>access</b>
+ <a class="ansibleOptionLink" href="#parameter-access" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ </ul>
+ </td>
+ <td>
+ <div>Access Policy, 1 - Read Write, 2 - Read Only, 3 - Blocked.</div>
+ <div>Required when controller type is LSI.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-cache"></div>
+ <b>cache</b>
+ <a class="ansibleOptionLink" href="#parameter-cache" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ </ul>
+ </td>
+ <td>
+ <div>Drive Cache, 1 - Unchanged, 2 - Enabled, 3 - Disabled.</div>
+ <div>Required when controller type is LSI.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ctrl_id"></div>
+ <b>ctrl_id</b>
+ <a class="ansibleOptionLink" href="#parameter-ctrl_id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Raid controller ID.</div>
+ <div>Required when controller type is LSI, PMC or MV.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-init"></div>
+ <b>init</b>
+ <a class="ansibleOptionLink" href="#parameter-init" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ </ul>
+ </td>
+ <td>
+ <div>Init State, 1 - No Init, 2 - Quick Init, 3 - Full Init.</div>
+ <div>Required when controller type is LSI.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-io"></div>
+ <b>io</b>
+ <a class="ansibleOptionLink" href="#parameter-io" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>1</li>
+ <li>2</li>
+ </ul>
+ </td>
+ <td>
+ <div>IO Policy, 1 - Direct IO, 2 - Cached IO.</div>
+ <div>Required when controller type is LSI.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-level"></div>
+ <b>level</b>
+ <a class="ansibleOptionLink" href="#parameter-level" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ <li>5</li>
+ <li>6</li>
+ <li>10</li>
+ </ul>
+ </td>
+ <td>
+ <div>RAID Level, 0 - RAID0, 1 - RAID1, 5 - RAID5, 6 - RAID6, 10 - RAID10.</div>
+ <div>Required when and controller type is LSI or PMC.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-r"></div>
+ <b>r</b>
+ <a class="ansibleOptionLink" href="#parameter-r" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>1</li>
+ <li>2</li>
+ </ul>
+ </td>
+ <td>
+ <div>Read Policy, 1 - Read Ahead, 2 - No Read Ahead.</div>
+ <div>Required when controller type is LSI.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-select"></div>
+ <b>select</b>
+ <a class="ansibleOptionLink" href="#parameter-select" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Select Size, from 1 to 100.</div>
+ <div>Required when controller type is LSI.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-size"></div>
+ <b>size</b>
+ <a class="ansibleOptionLink" href="#parameter-size" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ <li>4</li>
+ <li>5</li>
+ </ul>
+ </td>
+ <td>
+ <div>Strip Size, 0 - 32k, 1 - 64k, 2 - 128k, 3 - 256k, 4 - 512k, 5 - 1024k.</div>
+ <div>Required when <em>Info=None</em> and controller type is LSI, PMC or MV.</div>
+ <div>When the controller type is MV, size is [0, 1].</div>
+ <div>When the controller type is LSI or PMC, size is [1, 2, 3, 4, 5].</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-slot"></div>
+ <b>slot</b>
+ <a class="ansibleOptionLink" href="#parameter-slot" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">list</span>
+ / <span style="color: purple">elements=integer</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Slot Num, input multiple slotNumber like 0, 1, 2....</div>
+ <div>Required when controller type is LSI or PMC.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-vname"></div>
+ <b>vname</b>
+ <a class="ansibleOptionLink" href="#parameter-vname" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Virtual drive name.</div>
+ <div>Required when controller type is PMC or server model is M7.</div>
+ <div>Required when controller type is MV.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-w"></div>
+ <b>w</b>
+ <a class="ansibleOptionLink" href="#parameter-w" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ </ul>
+ </td>
+ <td>
+ <div>Write Policy, 1 - Write Through, 2 - Write Back, 3 - Write caching ok if bad BBU.</div>
+ <div>Required when controller type is LSI.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Add ldisk test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Add LSI ldisk"
+ kaytus.ksmanage.add_ldisk:
+ ctrl_id: 0
+ level: 1
+ size: 1
+ access: 1
+ r: 1
+ w: 1
+ io: 1
+ cache: 1
+ init: 2
+ select: 10
+ slot: 0, 1
+ provider: "{{ ksmanage }}"
+
+ - name: "Add PMC ldisk"
+ kaytus.ksmanage.add_ldisk:
+ ctrl_id: 0
+ level: 1
+ size: 1
+ accelerator: 1
+ slot: 0, 1
+ vname: "test"
+ provider: "{{ ksmanage }}"
+
+ - name: "Add MV ldisk"
+ kaytus.ksmanage.add_ldisk:
+ ctrl_id: 0
+ size: 1
+ vname: "test"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/alert_policy_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/alert_policy_info_module.rst new file mode 100644 index 000000000..73cca53e3 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/alert_policy_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.alert_policy_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.alert_policy_info -- Get alert policy
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.alert_policy_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get alert policy on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Alert test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get alert policy"
+ kaytus.ksmanage.alert_policy_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/audit_log_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/audit_log_info_module.rst new file mode 100644 index 000000000..e5e620208 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/audit_log_info_module.rst @@ -0,0 +1,358 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.audit_log_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.audit_log_info -- Get BMC audit log information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.audit_log_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get BMC audit log information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-audit_file"></div>
+ <b>audit_file</b>
+ <a class="ansibleOptionLink" href="#parameter-audit_file" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Store logs to a file.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-count"></div>
+ <b>count</b>
+ <a class="ansibleOptionLink" href="#parameter-count" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Get the most recent log of a specified number.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-log_time"></div>
+ <b>log_time</b>
+ <a class="ansibleOptionLink" href="#parameter-log_time" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Bmc audit log test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get bmc audit log information"
+ kaytus.ksmanage.audit_log_info:
+ log_time: "2020-06-01T12:30+08:00"
+ provider: "{{ ksmanage }}"
+
+ - name: "Get bmc audit log information"
+ kaytus.ksmanage.audit_log_info:
+ count: 30
+ provider: "{{ ksmanage }}"
+
+ - name: "Get bmc audit log information"
+ kaytus.ksmanage.audit_log_info:
+ audit_file: "/home/wbs/wbs.log"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/auto_capture_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/auto_capture_info_module.rst new file mode 100644 index 000000000..02edf7255 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/auto_capture_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.auto_capture_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.auto_capture_info -- Get auto capture screen information
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.auto_capture_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get auto capture screen information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Screen test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get auto capture screen information"
+ kaytus.ksmanage.auto_capture_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/backplane_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/backplane_info_module.rst new file mode 100644 index 000000000..e918903ce --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/backplane_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.backplane_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.backplane_info -- Get disk backplane information
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.backplane_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get disk backplane information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Disk backplane test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get backplane information"
+ kaytus.ksmanage.backplane_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/backup_module.rst b/ansible_collections/kaytus/ksmanage/docs/backup_module.rst new file mode 100644 index 000000000..ee88063be --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/backup_module.rst @@ -0,0 +1,355 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.backup_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.backup -- Backup server settings
+++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.backup`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Backup server settings on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-bak_file"></div>
+ <b>bak_file</b>
+ <a class="ansibleOptionLink" href="#parameter-bak_file" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Backup file or bak folder.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-item"></div>
+ <b>item</b>
+ <a class="ansibleOptionLink" href="#parameter-item" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>all</li>
+ <li>network</li>
+ <li>service</li>
+ <li>ntp</li>
+ <li>snmptrap</li>
+ <li>dns</li>
+ <li>smtp</li>
+ <li>ad</li>
+ <li>ldap</li>
+ <li>user</li>
+ <li>bios</li>
+ <li>kvm</li>
+ <li>ipmi</li>
+ <li>authentication</li>
+ <li>syslog</li>
+ <li>ncsi</li>
+ </ul>
+ </td>
+ <td>
+ <div>Export item.</div>
+ <div>The values for M5 modules are 'all', 'network', 'service', 'ntp', 'snmptrap', 'dns', 'smtp', 'ad', 'ldap', 'user', 'bios'.</div>
+ <div>The values for M6 modules are 'all', 'network', 'service', 'ntp', 'snmptrap', 'kvm', 'ipmi', 'authentication', 'syslog'.</div>
+ <div>The values for M7 modules are 'all', 'network', 'service', 'syslog', 'ncsi'.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Backup test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Backup server settings"
+ kaytus.ksmanage.backup:
+ bak_file: "/home/wbs/"
+ item: "all"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/bios_export_module.rst b/ansible_collections/kaytus/ksmanage/docs/bios_export_module.rst new file mode 100644 index 000000000..64eb77270 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/bios_export_module.rst @@ -0,0 +1,318 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.bios_export_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.bios_export -- Export BIOS config
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.bios_export`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Export BIOS config on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-file_url"></div>
+ <b>file_url</b>
+ <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Suffix is .json/.conf, FILEURI format, "/directory/filename".</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Bios test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Export bios config"
+ kaytus.ksmanage.bios_export:
+ file_url: "/home/wbs/bios.conf"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/bios_import_module.rst b/ansible_collections/kaytus/ksmanage/docs/bios_import_module.rst new file mode 100644 index 000000000..dd9e07c01 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/bios_import_module.rst @@ -0,0 +1,318 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.bios_import_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.bios_import -- Import BIOS config
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.bios_import`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Import BIOS config on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-file_url"></div>
+ <b>file_url</b>
+ <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Suffix is .json/.conf, FILEURI format, "/directory/filename".</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Bios test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Import bios config"
+ kaytus.ksmanage.bios_import:
+ file_url: "/home/wbs/bios.conf"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/bios_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/bios_info_module.rst new file mode 100644 index 000000000..a7318a4c8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/bios_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.bios_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.bios_info -- Get BIOS setup
++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.bios_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get BIOS setup on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Bios test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get bios setup"
+ kaytus.ksmanage.bios_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/bmc_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/bmc_info_module.rst new file mode 100644 index 000000000..e7a44a3ba --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/bmc_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.bmc_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.bmc_info -- Get BMC information
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.bmc_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get BMC information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Bmc info test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get BMC information"
+ kaytus.ksmanage.bmc_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/boot_image_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/boot_image_info_module.rst new file mode 100644 index 000000000..400782f81 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/boot_image_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.boot_image_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.boot_image_info -- Get bmc boot image information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.boot_image_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get bmc boot image information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Boot image test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get bmc boot image information"
+ kaytus.ksmanage.boot_image_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/boot_option_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/boot_option_info_module.rst new file mode 100644 index 000000000..30efdda01 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/boot_option_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.boot_option_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.boot_option_info -- Get BIOS boot options
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.boot_option_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get BIOS boot options on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Boot test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get bios boot option"
+ kaytus.ksmanage.boot_option_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/clear_audit_log_module.rst b/ansible_collections/kaytus/ksmanage/docs/clear_audit_log_module.rst new file mode 100644 index 000000000..8b38949c4 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/clear_audit_log_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.clear_audit_log_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.clear_audit_log -- Clear BMC audit log
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.clear_audit_log`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Clear BMC audit log on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Clear BMC audit log test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Clear BMC audit log "
+ kaytus.ksmanage.clear_audit_log:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/clear_event_log_module.rst b/ansible_collections/kaytus/ksmanage/docs/clear_event_log_module.rst new file mode 100644 index 000000000..095526741 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/clear_event_log_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.clear_event_log_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.clear_event_log -- Clear event log
+++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.clear_event_log`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Clear event log on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Clear event log test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Clear event log"
+ kaytus.ksmanage.clear_event_log:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/clear_system_log_module.rst b/ansible_collections/kaytus/ksmanage/docs/clear_system_log_module.rst new file mode 100644 index 000000000..561df8d35 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/clear_system_log_module.rst @@ -0,0 +1,334 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.clear_system_log_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.clear_system_log -- Clear BMC system log
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.clear_system_log`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Clear BMC system log on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-level"></div>
+ <b>level</b>
+ <a class="ansibleOptionLink" href="#parameter-level" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li><div style="color: blue"><b>alert</b> ←</div></li>
+ <li>critical</li>
+ <li>error</li>
+ <li>notice</li>
+ <li>warning</li>
+ <li>debug</li>
+ <li>emergency</li>
+ <li>info</li>
+ <li>all</li>
+ </ul>
+ </td>
+ <td>
+ <div>Log level.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Clear BMC system log test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Clear BMC system log"
+ kaytus.ksmanage.clear_system_log:
+ level: "alert"
+ provider: "{{ ksmanage }}"
+
+ - name: "Clear BMC system log"
+ kaytus.ksmanage.clear_system_log:
+ level: "all"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/collect_blackbox_module.rst b/ansible_collections/kaytus/ksmanage/docs/collect_blackbox_module.rst new file mode 100644 index 000000000..1a2268bce --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/collect_blackbox_module.rst @@ -0,0 +1,319 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.collect_blackbox_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.collect_blackbox -- Collect blackbox log
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.collect_blackbox`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Collect blackbox log on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-file_url"></div>
+ <b>file_url</b>
+ <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>File download path.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Collect blackbox test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Collect blackbox log"
+ kaytus.ksmanage.collect_blackbox:
+ file_url: "/home/wbs/wbs.log"
+ provider: "{{ ksmanage }}"
+
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/collect_log_module.rst b/ansible_collections/kaytus/ksmanage/docs/collect_log_module.rst new file mode 100644 index 000000000..6786d75c1 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/collect_log_module.rst @@ -0,0 +1,318 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.collect_log_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.collect_log -- Collect logs
++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.collect_log`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Collect logs on kaytus Server, it takes about 5 minutes.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-file_url"></div>
+ <b>file_url</b>
+ <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>File download path or path with filename, for example filepath/filename.tar.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Collect test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Collect logs"
+ kaytus.ksmanage.collect_log:
+ file_url: "/home/wbs/test.tar"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/connect_media_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/connect_media_info_module.rst new file mode 100644 index 000000000..41e742ed6 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/connect_media_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.connect_media_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.connect_media_info -- Get remote images redirection information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.connect_media_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get remote images redirection information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Connect media test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get remote images redirection information"
+ kaytus.ksmanage.connect_media_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/cpu_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/cpu_info_module.rst new file mode 100644 index 000000000..49bab2565 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/cpu_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.cpu_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.cpu_info -- Get CPU information
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.cpu_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get CPU information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: CPU test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get cpu information"
+ kaytus.ksmanage.cpu_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/del_session_module.rst b/ansible_collections/kaytus/ksmanage/docs/del_session_module.rst new file mode 100644 index 000000000..ea4c6630c --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/del_session_module.rst @@ -0,0 +1,318 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.del_session_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.del_session -- Delete session
++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.del_session`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Delete session on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-sid"></div>
+ <b>sid</b>
+ <a class="ansibleOptionLink" href="#parameter-sid" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Session Id, input "all" to delete all sessions.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Delete session test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Delete session"
+ kaytus.ksmanage.del_session:
+ sid: "223"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/dns_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/dns_info_module.rst new file mode 100644 index 000000000..c183ea16d --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/dns_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.dns_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.dns_info -- Get dns information
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.dns_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get dns information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: DNS test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get dns information"
+ kaytus.ksmanage.dns_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/download_auto_screenshot_module.rst b/ansible_collections/kaytus/ksmanage/docs/download_auto_screenshot_module.rst new file mode 100644 index 000000000..767f2e6d8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/download_auto_screenshot_module.rst @@ -0,0 +1,318 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.download_auto_screenshot_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.download_auto_screenshot -- Download auto screenshots
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.download_auto_screenshot`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Download auto screenshots on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-file_url"></div>
+ <b>file_url</b>
+ <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Screen capture file path.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Screen test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Download auto screenshots"
+ kaytus.ksmanage.download_auto_screenshot:
+ file_url: "/home/wbs/screen"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/download_manual_screenshot_module.rst b/ansible_collections/kaytus/ksmanage/docs/download_manual_screenshot_module.rst new file mode 100644 index 000000000..4cbe1fba2 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/download_manual_screenshot_module.rst @@ -0,0 +1,318 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.download_manual_screenshot_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.download_manual_screenshot -- Download manual screenshots
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.download_manual_screenshot`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Download manual screenshots on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-file_url"></div>
+ <b>file_url</b>
+ <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Screen capture file path.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Screen test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Download manual screenshots"
+ kaytus.ksmanage.download_manual_screenshot:
+ file_url: "/home/wbs/screen"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_ad_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_ad_module.rst new file mode 100644 index 000000000..a0116cd7c --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_ad_module.rst @@ -0,0 +1,459 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_ad_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_ad -- Set active directory information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_ad`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set active directory information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-addr1"></div>
+ <b>addr1</b>
+ <a class="ansibleOptionLink" href="#parameter-addr1" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Domain Controller Server Address1. Enter the IP address of Active Directory server.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-addr2"></div>
+ <b>addr2</b>
+ <a class="ansibleOptionLink" href="#parameter-addr2" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Domain Controller Server Address2. Enter the IP address of Active Directory server.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-addr3"></div>
+ <b>addr3</b>
+ <a class="ansibleOptionLink" href="#parameter-addr3" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Domain Controller Server Address3. Enter the IP address of Active Directory server.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-code"></div>
+ <b>code</b>
+ <a class="ansibleOptionLink" href="#parameter-code" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Secret Password. Specify the Password of the administrator.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-domain"></div>
+ <b>domain</b>
+ <a class="ansibleOptionLink" href="#parameter-domain" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>User Domain Name. Specify the Domain Name for the user for example MyDomain.com.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-enable"></div>
+ <b>enable</b>
+ <a class="ansibleOptionLink" href="#parameter-enable" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Active Directory Authentication Status.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-name"></div>
+ <b>name</b>
+ <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Secret Username. Specify the Username of an administrator of the Active Directory Server.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ssl_enable"></div>
+ <b>ssl_enable</b>
+ <a class="ansibleOptionLink" href="#parameter-ssl_enable" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Active Directory SSL Status.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-timeout"></div>
+ <b>timeout</b>
+ <a class="ansibleOptionLink" href="#parameter-timeout" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>The Time Out configuration(15-300).</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Ad test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set active directory information"
+ kaytus.ksmanage.edit_ad:
+ enable: "disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set active directory information"
+ kaytus.ksmanage.edit_ad:
+ enable: "enable"
+ name: "test"
+ code: "123456"
+ timeout: 120
+ domain: "test.com"
+ addr1: "100.2.2.2"
+ addr2: "100.2.2.3"
+ addr3: "100.2.2.4"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_alert_policy_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_alert_policy_module.rst new file mode 100644 index 000000000..bf081d5d1 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_alert_policy_module.rst @@ -0,0 +1,430 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_alert_policy_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_alert_policy -- Set alert policy
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_alert_policy`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set alert policy on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-channel"></div>
+ <b>channel</b>
+ <a class="ansibleOptionLink" href="#parameter-channel" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>shared</li>
+ <li>dedicated</li>
+ </ul>
+ </td>
+ <td>
+ <div>LAN Channel.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-destination"></div>
+ <b>destination</b>
+ <a class="ansibleOptionLink" href="#parameter-destination" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Alert destination. The address of the server receiving trap information sent by Trap.</div>
+ <div>when type is snmp, specify an IP address.</div>
+ <div>When type is email, specify a username.</div>
+ <div>When type is snmpdomain, specify a domain.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-id"></div>
+ <b>id</b>
+ <a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ <li>4</li>
+ </ul>
+ </td>
+ <td>
+ <div>Alert id. Customize the channel for sending alarms in Trap.</div>
+ <div>The values for M5 modules are 1, 2, 3.</div>
+ <div>The values for M6 modules are 1, 2, 3, 4.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-status"></div>
+ <b>status</b>
+ <a class="ansibleOptionLink" href="#parameter-status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Alert policy status. Whether to enable the receiving end for sending messages in trap mode.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-trap_port"></div>
+ <b>trap_port</b>
+ <a class="ansibleOptionLink" href="#parameter-trap_port" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>SNMP trap port(1-65535).</div>
+ <div>Only the M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-type"></div>
+ <b>type</b>
+ <a class="ansibleOptionLink" href="#parameter-type" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>snmp</li>
+ <li>email</li>
+ <li>snmpdomain</li>
+ </ul>
+ </td>
+ <td>
+ <div>Alert Type.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Alert policy test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set alert policy"
+ kaytus.ksmanage.edit_alert_policy:
+ id: 1
+ status: "enable"
+ type: "snmp"
+ destination: "100.2.2.2"
+ channel: "shared"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set alert policy"
+ kaytus.ksmanage.edit_alert_policy:
+ id: 1
+ status: "disable"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_auto_capture_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_auto_capture_module.rst new file mode 100644 index 000000000..afe6776c8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_auto_capture_module.rst @@ -0,0 +1,322 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_auto_capture_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_auto_capture -- Set auto capture screen
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_auto_capture`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set auto capture screen on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-status"></div>
+ <b>status</b>
+ <a class="ansibleOptionLink" href="#parameter-status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Capture status.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Screen test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set auto capture screen"
+ kaytus.ksmanage.edit_auto_capture:
+ status: "enable"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_bios_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_bios_module.rst new file mode 100644 index 000000000..ecc2eed00 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_bios_module.rst @@ -0,0 +1,377 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_bios_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_bios -- Set BIOS setup attributes
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_bios`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set BIOS setup attributes on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-attribute"></div>
+ <b>attribute</b>
+ <a class="ansibleOptionLink" href="#parameter-attribute" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>BIOS setup option.</div>
+ <div>Required when <em>list=False</em> and <em>file_url=None</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-file_url"></div>
+ <b>file_url</b>
+ <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>BIOS option file. attribute must be used with value.</div>
+ <div>Mutually exclusive with fileurl format, "/directory/filename".</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-list"></div>
+ <b>list</b>
+ <a class="ansibleOptionLink" href="#parameter-list" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li><div style="color: blue"><b>no</b> ←</div></li>
+ <li>yes</li>
+ </ul>
+ </td>
+ <td>
+ <div>Show attribute name and configurable value.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-value"></div>
+ <b>value</b>
+ <a class="ansibleOptionLink" href="#parameter-value" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>BIOS setup option value.</div>
+ <div>Required when <em>list=False</em> and <em>file_url=None</em>.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Bios test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set bios setup"
+ kaytus.ksmanage.edit_bios:
+ attribute: "VMX"
+ value: "Disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set bios setup"
+ kaytus.ksmanage.edit_bios:
+ attribute: "VMX"
+ value: "Enable"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_boot_image_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_boot_image_module.rst new file mode 100644 index 000000000..c8443f0e9 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_boot_image_module.rst @@ -0,0 +1,327 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_boot_image_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_boot_image -- Set bmc boot image
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_boot_image`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set bmc boot image on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-image"></div>
+ <b>image</b>
+ <a class="ansibleOptionLink" href="#parameter-image" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ <li>4</li>
+ <li>5</li>
+ </ul>
+ </td>
+ <td>
+ <div>BMC boot image.</div>
+ <div>0-Higher firmware version; 1-Image 1; 2-Image 2; 3-Lower firmware version; 4-Latest updated firmware; 5-Not latest updated firmware.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Boot image test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set bmc boot image"
+ kaytus.ksmanage.edit_boot_image:
+ image: 2
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_boot_option_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_boot_option_module.rst new file mode 100644 index 000000000..b3ef68d54 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_boot_option_module.rst @@ -0,0 +1,365 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_boot_option_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_boot_option -- Set BIOS boot options
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_boot_option`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set BIOS boot options on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-device"></div>
+ <b>device</b>
+ <a class="ansibleOptionLink" href="#parameter-device" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>none</li>
+ <li>HDD</li>
+ <li>PXE</li>
+ <li>CD</li>
+ <li>BIOSSETUP</li>
+ </ul>
+ </td>
+ <td>
+ <div>Boot device.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-effective"></div>
+ <b>effective</b>
+ <a class="ansibleOptionLink" href="#parameter-effective" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>Once</li>
+ <li>Continuous</li>
+ </ul>
+ </td>
+ <td>
+ <div>Effective, once or continuous.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-mode"></div>
+ <b>mode</b>
+ <a class="ansibleOptionLink" href="#parameter-mode" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>Legacy</li>
+ <li>UEFI</li>
+ </ul>
+ </td>
+ <td>
+ <div>Boot type.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Boot test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set bios boot option"
+ kaytus.ksmanage.edit_boot_option:
+ device: "PXE"
+ effective: "Once"
+ mode: "Legacy"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_connect_media_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_connect_media_module.rst new file mode 100644 index 000000000..f4eb71c0e --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_connect_media_module.rst @@ -0,0 +1,360 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_connect_media_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_connect_media -- Start/Stop virtual media Image
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_connect_media`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Start/Stop virtual media Image on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-image_name"></div>
+ <b>image_name</b>
+ <a class="ansibleOptionLink" href="#parameter-image_name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Image name.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-image_type"></div>
+ <b>image_type</b>
+ <a class="ansibleOptionLink" href="#parameter-image_type" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>CD</li>
+ <li>FD</li>
+ <li>HD</li>
+ </ul>
+ </td>
+ <td>
+ <div>Virtual media type.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-op_type"></div>
+ <b>op_type</b>
+ <a class="ansibleOptionLink" href="#parameter-op_type" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>start</li>
+ <li>stop</li>
+ </ul>
+ </td>
+ <td>
+ <div>Start or stop media.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Connect media test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set remote image redirection"
+ kaytus.ksmanage.edit_connect_media:
+ image_type: "CD"
+ op_type: "start"
+ image_name: "aa.iso"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_dns_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_dns_module.rst new file mode 100644 index 000000000..f436412dc --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_dns_module.rst @@ -0,0 +1,620 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_dns_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_dns -- Set dns information
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_dns`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set dns information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-dns_iface"></div>
+ <b>dns_iface</b>
+ <a class="ansibleOptionLink" href="#parameter-dns_iface" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>DNS Interface, input like 'eth0', 'eth1', 'bond0'.</div>
+ <div>Required when <em>dns_manual=auto</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-dns_manual"></div>
+ <b>dns_manual</b>
+ <a class="ansibleOptionLink" href="#parameter-dns_manual" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>manual</li>
+ <li>auto</li>
+ </ul>
+ </td>
+ <td>
+ <div>DNS Settings. Select whether the DNS interface will be configured manually or automatically.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-dns_priority"></div>
+ <b>dns_priority</b>
+ <a class="ansibleOptionLink" href="#parameter-dns_priority" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>4</li>
+ <li>6</li>
+ </ul>
+ </td>
+ <td>
+ <div>IP Priority.</div>
+ <div>Required when <em>dns_manual=auto</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-dns_server1"></div>
+ <b>dns_server1</b>
+ <a class="ansibleOptionLink" href="#parameter-dns_server1" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>DNS Server1 IPv4 or IPv6 address.</div>
+ <div>Required when <em>dns_manual=manual</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-dns_server2"></div>
+ <b>dns_server2</b>
+ <a class="ansibleOptionLink" href="#parameter-dns_server2" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>DNS Server2 IPv4 or IPv6 address.</div>
+ <div>Required when <em>dns_manual=manual</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-dns_server3"></div>
+ <b>dns_server3</b>
+ <a class="ansibleOptionLink" href="#parameter-dns_server3" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>DNS Server3 IPv4 or IPv6 address.</div>
+ <div>Required when <em>dns_manual=manual</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-dns_status"></div>
+ <b>dns_status</b>
+ <a class="ansibleOptionLink" href="#parameter-dns_status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>DNS status.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-domain_iface"></div>
+ <b>domain_iface</b>
+ <a class="ansibleOptionLink" href="#parameter-domain_iface" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Network Interface, input like 'eth0_v4', 'eth0_v6', 'eth1_v4', 'eth1_v6', 'bond0_v4', 'bond0_v6'.</div>
+ <div>Required when <em>domain_manual=auto</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-domain_manual"></div>
+ <b>domain_manual</b>
+ <a class="ansibleOptionLink" href="#parameter-domain_manual" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>manual</li>
+ <li>auto</li>
+ </ul>
+ </td>
+ <td>
+ <div>Domain Settings. Select whether the domain interface will be configured manually or automatically.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-domain_name"></div>
+ <b>domain_name</b>
+ <a class="ansibleOptionLink" href="#parameter-domain_name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Domain Name.</div>
+ <div>Required when <em>domain_manual=manual</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host_cfg"></div>
+ <b>host_cfg</b>
+ <a class="ansibleOptionLink" href="#parameter-host_cfg" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>manual</li>
+ <li>auto</li>
+ </ul>
+ </td>
+ <td>
+ <div>Host Settings. Select whether the host name will be configured manually or automatically.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host_name"></div>
+ <b>host_name</b>
+ <a class="ansibleOptionLink" href="#parameter-host_name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Host Name.</div>
+ <div>Required when <em>host_cfg=manual</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-register_status1"></div>
+ <b>register_status1</b>
+ <a class="ansibleOptionLink" href="#parameter-register_status1" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>BMC register status 1.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-register_status2"></div>
+ <b>register_status2</b>
+ <a class="ansibleOptionLink" href="#parameter-register_status2" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>BMC register status 2.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-registration_method1"></div>
+ <b>registration_method1</b>
+ <a class="ansibleOptionLink" href="#parameter-registration_method1" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>nsupdate</li>
+ <li>dhcp</li>
+ <li>hostname</li>
+ </ul>
+ </td>
+ <td>
+ <div>Registration method 1.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ <div>Required when <em>register_status1=enable</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-registration_method2"></div>
+ <b>registration_method2</b>
+ <a class="ansibleOptionLink" href="#parameter-registration_method2" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>nsupdate</li>
+ <li>dhcp</li>
+ <li>hostname</li>
+ </ul>
+ </td>
+ <td>
+ <div>Registration method 2.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ <div>Required when <em>register_status2=enable</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: DNS test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set dns information"
+ kaytus.ksmanage.edit_dns:
+ dns_status: "disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set dns information"
+ kaytus.ksmanage.edit_dns:
+ dns_status: "enable"
+ host_cfg: "manual"
+ host_name: "123456789"
+ domain_manual: "auto"
+ domain_iface: "eth0_v4"
+ dns_manual: "manual"
+ dns_server1: "100.2.2.2"
+ dns_server2: "100.2.2.3"
+ dns_server3: "100.2.2.4"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set dns information"
+ kaytus.ksmanage.edit_dns:
+ dns_status: "enable"
+ host_cfg: "manual"
+ host_name: "123456789"
+ domain_manual: "manual"
+ domain_name: "test.com"
+ dns_manual: "auto"
+ dns_iface: "eth0"
+ dns_priority: "4"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_event_log_policy_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_event_log_policy_module.rst new file mode 100644 index 000000000..3161894bb --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_event_log_policy_module.rst @@ -0,0 +1,322 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_event_log_policy_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_event_log_policy -- Set event log policy
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_event_log_policy`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set event log policy on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-policy"></div>
+ <b>policy</b>
+ <a class="ansibleOptionLink" href="#parameter-policy" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>Linear</li>
+ <li>Circular</li>
+ </ul>
+ </td>
+ <td>
+ <div>Event log policy.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Event log policy test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set event log policy"
+ kaytus.ksmanage.edit_event_log_policy:
+ policy: "Linear"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_fan_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_fan_module.rst new file mode 100644 index 000000000..403c59785 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_fan_module.rst @@ -0,0 +1,359 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_fan_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_fan -- Set fan information
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_fan`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set fan information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-fan_speed"></div>
+ <b>fan_speed</b>
+ <a class="ansibleOptionLink" href="#parameter-fan_speed" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Fan speed (duty ratio), range in 1 - 100.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-id"></div>
+ <b>id</b>
+ <a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Fan id 255 is for all fans, 0~n.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-mode"></div>
+ <b>mode</b>
+ <a class="ansibleOptionLink" href="#parameter-mode" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>Automatic</li>
+ <li>Manual</li>
+ </ul>
+ </td>
+ <td>
+ <div>Control mode, Manual or Automatic , Manual must be used with fans_peed.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Fan test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set fan information"
+ kaytus.ksmanage.edit_fan:
+ mode: "Automatic"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set fan information"
+ kaytus.ksmanage.edit_fan:
+ mode: "Manual"
+ id: 1
+ fan_speed: 80
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_fru_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_fru_module.rst new file mode 100644 index 000000000..f205bb1fd --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_fru_module.rst @@ -0,0 +1,352 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_fru_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_fru -- Set fru settings
+++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_fru`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set fru settings on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-attribute"></div>
+ <b>attribute</b>
+ <a class="ansibleOptionLink" href="#parameter-attribute" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>CP</li>
+ <li>CS</li>
+ <li>PM</li>
+ <li>PPN</li>
+ <li>PS</li>
+ <li>PN</li>
+ <li>PV</li>
+ <li>PAT</li>
+ <li>BM</li>
+ <li>BPN</li>
+ <li>BS</li>
+ <li>BP</li>
+ </ul>
+ </td>
+ <td>
+ <div>CP is Chassis Part Number, CS is Chassis Serial, PM is Product Manufacturer.</div>
+ <div>PPN is Product Part Number, PS is Product Serial, PN is Product Name.</div>
+ <div>PV is Product Version, PAT is Product Asset Tag, BM is Board Mfg, BPN is Board Product Name.</div>
+ <div>BS is Board Serial, BP is Board Part Number.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-value"></div>
+ <b>value</b>
+ <a class="ansibleOptionLink" href="#parameter-value" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set the value of attribute.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Fru test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set Fru"
+ kaytus.ksmanage.edit_fru:
+ attribute: "CP"
+ value: "test"
+ provider: "{{ ksmanage }}"
+
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_ipv4_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_ipv4_module.rst new file mode 100644 index 000000000..1e87370c3 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_ipv4_module.rst @@ -0,0 +1,427 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_ipv4_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_ipv4 -- Set ipv4 information
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_ipv4`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set ipv4 information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-interface_name"></div>
+ <b>interface_name</b>
+ <a class="ansibleOptionLink" href="#parameter-interface_name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>eth0</li>
+ <li>eth1</li>
+ <li>bond0</li>
+ </ul>
+ </td>
+ <td>
+ <div>Set interface name. Select the LAN interface to be configured.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ipv4_address"></div>
+ <b>ipv4_address</b>
+ <a class="ansibleOptionLink" href="#parameter-ipv4_address" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>If DHCP is disabled, specify a static IPv4 address to be configured for the selected interface.</div>
+ <div>Required when <em>ipv4_dhcp_enable=static</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ipv4_dhcp_enable"></div>
+ <b>ipv4_dhcp_enable</b>
+ <a class="ansibleOptionLink" href="#parameter-ipv4_dhcp_enable" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>dhcp</li>
+ <li>static</li>
+ </ul>
+ </td>
+ <td>
+ <div>Enable 'Enable DHCP' to dynamically configure IPv4 address using Dynamic Host Configuration Protocol (DHCP).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ipv4_gateway"></div>
+ <b>ipv4_gateway</b>
+ <a class="ansibleOptionLink" href="#parameter-ipv4_gateway" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>If DHCP is disabled, specify a static Default Gateway to be configured for the selected interface.</div>
+ <div>Required when <em>ipv4_dhcp_enable=static</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ipv4_status"></div>
+ <b>ipv4_status</b>
+ <a class="ansibleOptionLink" href="#parameter-ipv4_status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Enable or disable IPV4.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ipv4_subnet"></div>
+ <b>ipv4_subnet</b>
+ <a class="ansibleOptionLink" href="#parameter-ipv4_subnet" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>If DHCP is disabled, specify a static Subnet Mask to be configured for the selected interface.</div>
+ <div>Required when <em>ipv4_dhcp_enable=static</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Ipv4 test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set ipv4 information"
+ kaytus.ksmanage.edit_ipv4:
+ interface_name: "eth0"
+ ipv4_status: "disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set ipv4 information"
+ kaytus.ksmanage.edit_ipv4:
+ interface_name: "eth0"
+ ipv4_status: "enable"
+ ipv4_dhcp_enable: "dhcp"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set ipv4 information"
+ kaytus.ksmanage.edit_ipv4:
+ interface_name: "eth0"
+ ipv4_status: "enable"
+ ipv4_dhcp_enable: "static"
+ ipv4_address: "100.2.36.10"
+ ipv4_subnet: "255.255.255.0"
+ ipv4_gateway: "100.2.36.1"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_ipv6_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_ipv6_module.rst new file mode 100644 index 000000000..69cb8acb8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_ipv6_module.rst @@ -0,0 +1,444 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_ipv6_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_ipv6 -- Set ipv6 information
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_ipv6`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set ipv6 information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-interface_name"></div>
+ <b>interface_name</b>
+ <a class="ansibleOptionLink" href="#parameter-interface_name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>eth0</li>
+ <li>eth1</li>
+ <li>bond0</li>
+ </ul>
+ </td>
+ <td>
+ <div>Set interface name. Select the LAN interface to be configured.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ipv6_address"></div>
+ <b>ipv6_address</b>
+ <a class="ansibleOptionLink" href="#parameter-ipv6_address" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>If DHCP is disabled, specify a static IPv6 address to be configured for the selected interface.</div>
+ <div>Required when <em>ipv6_dhcp_enable=static</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ipv6_dhcp_enable"></div>
+ <b>ipv6_dhcp_enable</b>
+ <a class="ansibleOptionLink" href="#parameter-ipv6_dhcp_enable" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>dhcp</li>
+ <li>static</li>
+ </ul>
+ </td>
+ <td>
+ <div>Enable 'Enable DHCP' to dynamically configure IPv6 address using Dynamic Host Configuration Protocol (DHCP).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ipv6_gateway"></div>
+ <b>ipv6_gateway</b>
+ <a class="ansibleOptionLink" href="#parameter-ipv6_gateway" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>If DHCP is disabled, specify a static Default Gateway to be configured for the selected interface.</div>
+ <div>Required when <em>ipv6_dhcp_enable=static</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ipv6_index"></div>
+ <b>ipv6_index</b>
+ <a class="ansibleOptionLink" href="#parameter-ipv6_index" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Ipv6 index(0-15).</div>
+ <div>Required when <em>ipv6_dhcp_enable=static</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ipv6_prefix"></div>
+ <b>ipv6_prefix</b>
+ <a class="ansibleOptionLink" href="#parameter-ipv6_prefix" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>The subnet prefix length for the IPv6 settings(0-128).</div>
+ <div>Required when <em>ipv6_dhcp_enable=static</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ipv6_status"></div>
+ <b>ipv6_status</b>
+ <a class="ansibleOptionLink" href="#parameter-ipv6_status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Enable or disable IPV6.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Ipv6 test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set ipv6 information"
+ kaytus.ksmanage.edit_ipv6:
+ interface_name: "eth0"
+ ipv6_status: "disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set ipv6 information"
+ kaytus.ksmanage.edit_ipv6:
+ interface_name: "eth0"
+ ipv6_status: "enable"
+ ipv6_dhcp_enable: "dhcp"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set ipv6 information"
+ kaytus.ksmanage.edit_ipv6:
+ interface_name: "eth0"
+ ipv6_status: "enable"
+ ipv6_dhcp_enable: "static"
+ ipv6_address: "::ffff:100:2:36:10"
+ ipv6_index: 12
+ ipv6_prefix: 16
+ ipv6_gateway: "::"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_kvm_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_kvm_module.rst new file mode 100644 index 000000000..bf4d36aaa --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_kvm_module.rst @@ -0,0 +1,543 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_kvm_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_kvm -- Set KVM
++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_kvm`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set KVM on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-automatic_off"></div>
+ <b>automatic_off</b>
+ <a class="ansibleOptionLink" href="#parameter-automatic_off" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Automatically OFF Server Monitor, When KVM Launches.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-client_type"></div>
+ <b>client_type</b>
+ <a class="ansibleOptionLink" href="#parameter-client_type" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>vnc</li>
+ <li>viewer</li>
+ </ul>
+ </td>
+ <td>
+ <div>Client Type.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-keyboard_language"></div>
+ <b>keyboard_language</b>
+ <a class="ansibleOptionLink" href="#parameter-keyboard_language" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>AD</li>
+ <li>DA</li>
+ <li>NL-BE</li>
+ <li>NL-NL</li>
+ <li>GB</li>
+ <li>US</li>
+ <li>FI</li>
+ <li>FR-BE</li>
+ <li>FR</li>
+ <li>DE</li>
+ <li>DE-CH</li>
+ <li>IT</li>
+ <li>JP</li>
+ <li>ON</li>
+ <li>PT</li>
+ <li>EC</li>
+ <li>SV</li>
+ <li>TR_F</li>
+ <li>TR_Q</li>
+ </ul>
+ </td>
+ <td>
+ <div>Select the Keyboard Language.</div>
+ <div>AD is Auto Detect, DA is Danish, NL-BE is Dutch Belgium, NL-NL is Dutch Netherland.</div>
+ <div>GB is English UK , US is English US, FI is Finnish, FR-BE is French Belgium, FR is French France.</div>
+ <div>DE is German Germany, DE-CH is German Switzerland, IT is Italian, JP is Japanese.</div>
+ <div>NO is Norwegian, PT is Portuguese, ES is Spanish, SV is Swedish, TR_F is Turkish F, TR_Q is Turkish Q.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-kvm_encryption"></div>
+ <b>kvm_encryption</b>
+ <a class="ansibleOptionLink" href="#parameter-kvm_encryption" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Encrypt KVM packets.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-local_monitor_off"></div>
+ <b>local_monitor_off</b>
+ <a class="ansibleOptionLink" href="#parameter-local_monitor_off" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Server Monitor OFF Feature Status.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-media_attach"></div>
+ <b>media_attach</b>
+ <a class="ansibleOptionLink" href="#parameter-media_attach" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>attach</li>
+ <li>auto</li>
+ </ul>
+ </td>
+ <td>
+ <div>Two types of VM attach mode are available.</div>
+ <div>Attach is Immediately attaches Virtual Media to the server upon bootup.</div>
+ <div>Auto is Attaches Virtual Media to the server only when a virtual media session is started.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-non_secure"></div>
+ <b>non_secure</b>
+ <a class="ansibleOptionLink" href="#parameter-non_secure" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Enable/disable Non Secure Connection Type.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ <div>Required when <em>client_type=vnc</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-retry_count"></div>
+ <b>retry_count</b>
+ <a class="ansibleOptionLink" href="#parameter-retry_count" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Number of times to be retried in case a KVM failure occurs.Retry count ranges from 1 to 20.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-retry_time_interval"></div>
+ <b>retry_time_interval</b>
+ <a class="ansibleOptionLink" href="#parameter-retry_time_interval" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>The Identification for retry time interval configuration (5-30) seconds.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ssh_vnc"></div>
+ <b>ssh_vnc</b>
+ <a class="ansibleOptionLink" href="#parameter-ssh_vnc" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Enable/disable VNC over SSH in BMC.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ <div>Required when <em>client_type=vnc</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-stunnel_vnc"></div>
+ <b>stunnel_vnc</b>
+ <a class="ansibleOptionLink" href="#parameter-stunnel_vnc" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Enable/disable VNC over Stunnel in BMC.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ <div>Required when <em>client_type=vnc</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: KVM test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set KVM"
+ kaytus.ksmanage.edit_kvm:
+ kvm_encryption: "enable"
+ media_attach: "auto"
+ keyboard_language: "AD"
+ retry_count: 13
+ retry_time_interval: 10
+ local_monitor_off: "enable"
+ automatic_off: "enable"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_ldap_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_ldap_module.rst new file mode 100644 index 000000000..99b725d90 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_ldap_module.rst @@ -0,0 +1,526 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_ldap_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_ldap -- Set ldap information
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_ldap`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set ldap information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-address"></div>
+ <b>address</b>
+ <a class="ansibleOptionLink" href="#parameter-address" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Server Address.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-attr"></div>
+ <b>attr</b>
+ <a class="ansibleOptionLink" href="#parameter-attr" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>cn</li>
+ <li>uid</li>
+ </ul>
+ </td>
+ <td>
+ <div>Attribute of User Login.</div>
+ <div>The Attribute of User Login field indicates to the LDAP/E-Directory server which attribute should be used to identify the user.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-base"></div>
+ <b>base</b>
+ <a class="ansibleOptionLink" href="#parameter-base" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Search Base.</div>
+ <div>The Search Base allows the LDAP/E-Directory server to find which part of the external directory tree is to be searched.</div>
+ <div>This search base may be equivalent to the organization or the group of the external directory.</div>
+ <div>Search base is a string of 4 to 64 alphanumeric characters.</div>
+ <div>It must start with an alphabetical character.</div>
+ <div>Special Symbols like dot(.), comma(, ), hyphen(-), underscore(_), equal-to(=) are allowed.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ca"></div>
+ <b>ca</b>
+ <a class="ansibleOptionLink" href="#parameter-ca" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>CA certificate file path.</div>
+ <div>Required when <em>encry=StartTLS</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ce"></div>
+ <b>ce</b>
+ <a class="ansibleOptionLink" href="#parameter-ce" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Certificate file path.</div>
+ <div>Required when <em>encry=StartTLS</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-cn"></div>
+ <b>cn</b>
+ <a class="ansibleOptionLink" href="#parameter-cn" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>ip</li>
+ <li>fqdn</li>
+ </ul>
+ </td>
+ <td>
+ <div>Common name type.</div>
+ <div>Required when <em>encry=StartTLS</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-code"></div>
+ <b>code</b>
+ <a class="ansibleOptionLink" href="#parameter-code" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Password. The Bind password is also used in the bind authentication operations between client and server.</div>
+ <div>Required when <em>enable=enable</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-dn"></div>
+ <b>dn</b>
+ <a class="ansibleOptionLink" href="#parameter-dn" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Bind DN. The Bind DN is used in bind operations, which authenticates the client to the server.</div>
+ <div>Bind DN is a string of 4 to 64 alphanumeric characters.</div>
+ <div>It must start with an alphabetical character.</div>
+ <div>Special Symbols like dot(.), comma(, ), hyphen(-), underscore(_), equal-to(=) are allowed.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-enable"></div>
+ <b>enable</b>
+ <a class="ansibleOptionLink" href="#parameter-enable" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>LDAP/E-Directory Authentication Status.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-encry"></div>
+ <b>encry</b>
+ <a class="ansibleOptionLink" href="#parameter-encry" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>no</li>
+ <li>SSL</li>
+ <li>StartTLS</li>
+ </ul>
+ </td>
+ <td>
+ <div>Encryption Type.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-pk"></div>
+ <b>pk</b>
+ <a class="ansibleOptionLink" href="#parameter-pk" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Private Key file path.</div>
+ <div>Required when <em>encry=StartTLS</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server_port"></div>
+ <b>server_port</b>
+ <a class="ansibleOptionLink" href="#parameter-server_port" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Server Port. Specify the LDAP/E-Directory Port.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Ldap test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set ldap information"
+ kaytus.ksmanage.edit_ldap:
+ enable: "disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set ldap information"
+ kaytus.ksmanage.edit_ldap:
+ enable: "enable"
+ encry: "SSL"
+ address: "100.2.2.2"
+ server_port: 389
+ dn: "cn=manager,ou=login,dc=domain,dc=com"
+ code: "123456"
+ base: "cn=manager"
+ attr: "uid"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_ldisk_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_ldisk_module.rst new file mode 100644 index 000000000..50b3a7bc5 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_ldisk_module.rst @@ -0,0 +1,378 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_ldisk_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_ldisk -- Set logical disk
+++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_ldisk`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set logical disk on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ctrl_id"></div>
+ <b>ctrl_id</b>
+ <a class="ansibleOptionLink" href="#parameter-ctrl_id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Raid controller ID.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-duration"></div>
+ <b>duration</b>
+ <a class="ansibleOptionLink" href="#parameter-duration" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Duration range is 1-255, physical drive under PMC raid controller.</div>
+ <div>Required when <em>option=LOC</em>.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ldisk_id"></div>
+ <b>ldisk_id</b>
+ <a class="ansibleOptionLink" href="#parameter-ldisk_id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Logical disk ID.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-option"></div>
+ <b>option</b>
+ <a class="ansibleOptionLink" href="#parameter-option" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>LOC</li>
+ <li>STL</li>
+ <li>FI</li>
+ <li>SFI</li>
+ <li>SI</li>
+ <li>DEL</li>
+ </ul>
+ </td>
+ <td>
+ <div>Set operation options for a logical disk.</div>
+ <div>LOC is Locate Logical Drive, STL is Stop Locate LogicalDrive.</div>
+ <div>FI is Fast Initialization, SFI is Slow/Full Initialization.</div>
+ <div>SI is Stop Initialization, DEL is Delete LogicalDrive.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Edit ldisk test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Edit ldisk"
+ kaytus.ksmanage.edit_ldisk:
+ ctrl_id: 0
+ ldisk_id: 1
+ option: "LOC"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_log_setting_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_log_setting_module.rst new file mode 100644 index 000000000..5cec4672c --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_log_setting_module.rst @@ -0,0 +1,474 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_log_setting_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_log_setting -- Set bmc system and audit log setting
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_log_setting`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set bmc system and audit log setting on kaytus Server.
+- Only the M5 models support this feature.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-audit_status"></div>
+ <b>audit_status</b>
+ <a class="ansibleOptionLink" href="#parameter-audit_status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Audit Log Status.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-audit_type"></div>
+ <b>audit_type</b>
+ <a class="ansibleOptionLink" href="#parameter-audit_type" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>local</li>
+ <li>remote</li>
+ <li>both</li>
+ </ul>
+ </td>
+ <td>
+ <div>Audit log type.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-file_size"></div>
+ <b>file_size</b>
+ <a class="ansibleOptionLink" href="#parameter-file_size" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>File Size(3-65535bytes), set when type is local(default 30000).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-protocol_type"></div>
+ <b>protocol_type</b>
+ <a class="ansibleOptionLink" href="#parameter-protocol_type" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>UDP</li>
+ <li>TCP</li>
+ </ul>
+ </td>
+ <td>
+ <div>Protocol Type, set when type is remote.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-rotate_count"></div>
+ <b>rotate_count</b>
+ <a class="ansibleOptionLink" href="#parameter-rotate_count" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ </ul>
+ </td>
+ <td>
+ <div>Rotate Count, set when type is local, 0-delete old files(default), 1-bak old files.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server_addr"></div>
+ <b>server_addr</b>
+ <a class="ansibleOptionLink" href="#parameter-server_addr" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Server Address, set when type is remote.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server_port"></div>
+ <b>server_port</b>
+ <a class="ansibleOptionLink" href="#parameter-server_port" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Server Port(0-65535), set when type is remote.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-status"></div>
+ <b>status</b>
+ <a class="ansibleOptionLink" href="#parameter-status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>System Log Status.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-type"></div>
+ <b>type</b>
+ <a class="ansibleOptionLink" href="#parameter-type" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>local</li>
+ <li>remote</li>
+ <li>both</li>
+ </ul>
+ </td>
+ <td>
+ <div>System log type.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Edit log setting test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Edit bmc system log setting"
+ kaytus.ksmanage.edit_log_setting:
+ status: "enable"
+ type: "both"
+ provider: "{{ ksmanage }}"
+
+ - name: "Edit bmc audit log setting"
+ kaytus.ksmanage.edit_log_setting:
+ audit_status: "enable"
+ audit_type: "remote"
+ server_addr: "100.2.126.11"
+ server_port: "514"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_m6_log_setting_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_m6_log_setting_module.rst new file mode 100644 index 000000000..4468a6a03 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_m6_log_setting_module.rst @@ -0,0 +1,490 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_m6_log_setting_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_m6_log_setting -- Set bmc system and audit log setting
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_m6_log_setting`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set bmc system and audit log setting on kaytus Server.
+- Only the M6 models support this feature.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host_tag"></div>
+ <b>host_tag</b>
+ <a class="ansibleOptionLink" href="#parameter-host_tag" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>HostName</li>
+ <li>SerialNum</li>
+ <li>AssertTag</li>
+ </ul>
+ </td>
+ <td>
+ <div>System log host tag, set when <em>status=enable</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-level"></div>
+ <b>level</b>
+ <a class="ansibleOptionLink" href="#parameter-level" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>Critical</li>
+ <li>Warning</li>
+ <li>Info</li>
+ </ul>
+ </td>
+ <td>
+ <div>Events Level, set when <em>status=enable</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-log_type"></div>
+ <b>log_type</b>
+ <a class="ansibleOptionLink" href="#parameter-log_type" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>idl</li>
+ <li>audit</li>
+ <li>both</li>
+ </ul>
+ </td>
+ <td>
+ <div>Remote Log Type, set when server_id is not none.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-protocol_type"></div>
+ <b>protocol_type</b>
+ <a class="ansibleOptionLink" href="#parameter-protocol_type" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>UDP</li>
+ <li>TCP</li>
+ </ul>
+ </td>
+ <td>
+ <div>Protocol Type, set when <em>status=enable</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server_addr"></div>
+ <b>server_addr</b>
+ <a class="ansibleOptionLink" href="#parameter-server_addr" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Server Address, set when server_id is not none.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server_id"></div>
+ <b>server_id</b>
+ <a class="ansibleOptionLink" href="#parameter-server_id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ </ul>
+ </td>
+ <td>
+ <div>Syslog Server ID, set when <em>status=enable</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server_port"></div>
+ <b>server_port</b>
+ <a class="ansibleOptionLink" href="#parameter-server_port" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Server Address, set when server_id is not none.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-status"></div>
+ <b>status</b>
+ <a class="ansibleOptionLink" href="#parameter-status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>System Log Status.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-test"></div>
+ <b>test</b>
+ <a class="ansibleOptionLink" href="#parameter-test" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li><div style="color: blue"><b>no</b> ←</div></li>
+ <li>yes</li>
+ </ul>
+ </td>
+ <td>
+ <div>Test remote log settings, set when server_id is not none.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Edit log setting test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Edit bmc system log setting"
+ kaytus.ksmanage.edit_m6_log_setting:
+ status: "disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Edit bmc audit log setting"
+ kaytus.ksmanage.edit_m6_log_setting:
+ status: "enable"
+ host_tag: "HostName"
+ level: "Info"
+ protocol_type: "TCP"
+ server_id: 0
+ server_addr: "100.2.126.11"
+ server_port: 514
+ log_type: "both"
+ provider: "{{ ksmanage }}"
+
+ - name: "test bmc audit log"
+ kaytus.ksmanage.edit_m6_log_setting:
+ server_id: 0
+ test: True
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_manual_capture_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_manual_capture_module.rst new file mode 100644 index 000000000..569225d31 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_manual_capture_module.rst @@ -0,0 +1,322 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_manual_capture_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_manual_capture -- Set manual capture screen
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_manual_capture`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set manual capture screen on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-type"></div>
+ <b>type</b>
+ <a class="ansibleOptionLink" href="#parameter-type" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>capture</li>
+ <li>delete</li>
+ </ul>
+ </td>
+ <td>
+ <div>Manual type.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Screen test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set manual capture screen"
+ kaytus.ksmanage.edit_manual_capture:
+ type: "capture"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_media_instance_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_media_instance_module.rst new file mode 100644 index 000000000..8120c19d4 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_media_instance_module.rst @@ -0,0 +1,502 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_media_instance_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_media_instance -- Set Virtual Media Instance
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_media_instance`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set Virtual Media Instance on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-kvm_num_cd"></div>
+ <b>kvm_num_cd</b>
+ <a class="ansibleOptionLink" href="#parameter-kvm_num_cd" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ <li>4</li>
+ </ul>
+ </td>
+ <td>
+ <div>Select the number of Remote KVM CD/DVD devices that support for virtual Media redirection.</div>
+ <div>The max support number of html5 KVM is 2 and java KVM is 4.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-kvm_num_fd"></div>
+ <b>kvm_num_fd</b>
+ <a class="ansibleOptionLink" href="#parameter-kvm_num_fd" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ <li>4</li>
+ </ul>
+ </td>
+ <td>
+ <div>Select the number of Remote KVM floppy devices that support for Virtual Media redirection.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-kvm_num_hd"></div>
+ <b>kvm_num_hd</b>
+ <a class="ansibleOptionLink" href="#parameter-kvm_num_hd" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ <li>4</li>
+ </ul>
+ </td>
+ <td>
+ <div>Select the number of Remote KVM Hard disk devices to support for Virtual Media redirection.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-num_cd"></div>
+ <b>num_cd</b>
+ <a class="ansibleOptionLink" href="#parameter-num_cd" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ <li>4</li>
+ </ul>
+ </td>
+ <td>
+ <div>Select the number of CD/DVD devices that support for Virtual Media redirection.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-num_fd"></div>
+ <b>num_fd</b>
+ <a class="ansibleOptionLink" href="#parameter-num_fd" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ <li>4</li>
+ </ul>
+ </td>
+ <td>
+ <div>Select the number of floppy devices that support for Virtual Media redirection.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-num_hd"></div>
+ <b>num_hd</b>
+ <a class="ansibleOptionLink" href="#parameter-num_hd" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ <li>4</li>
+ </ul>
+ </td>
+ <td>
+ <div>Select the number of harddisk devices that support for Virtual Media redirection.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-power_save_mode"></div>
+ <b>power_save_mode</b>
+ <a class="ansibleOptionLink" href="#parameter-power_save_mode" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>Enable</li>
+ <li>Disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Check this option to enable Power Save Mode in BMC.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-sd_media"></div>
+ <b>sd_media</b>
+ <a class="ansibleOptionLink" href="#parameter-sd_media" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>Enable</li>
+ <li>Disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Check this option to enable SD Media support in BMC.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-secure_channel"></div>
+ <b>secure_channel</b>
+ <a class="ansibleOptionLink" href="#parameter-secure_channel" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>Enable</li>
+ <li>Disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Check this option to enable encrypt media recirection packets.</div>
+ <div>Only the M5/M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Media instance test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set media instance"
+ kaytus.ksmanage.edit_media_instance:
+ num_fd: 1
+ num_cd: 1
+ num_hd: 1
+ kvm_num_fd: 1
+ kvm_num_cd: 1
+ kvm_num_hd: 1
+ sd_media: "Enable"
+ secure_channel: "Enable"
+ power_save_mode: "Enable"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_ncsi_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_ncsi_module.rst new file mode 100644 index 000000000..d3fe17c74 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_ncsi_module.rst @@ -0,0 +1,389 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_ncsi_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_ncsi -- Set ncsi information
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_ncsi`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set ncsi information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-channel_number"></div>
+ <b>channel_number</b>
+ <a class="ansibleOptionLink" href="#parameter-channel_number" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ </ul>
+ </td>
+ <td>
+ <div>Channel number.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-interface_name"></div>
+ <b>interface_name</b>
+ <a class="ansibleOptionLink" href="#parameter-interface_name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Interface name, for example eth0.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-mode"></div>
+ <b>mode</b>
+ <a class="ansibleOptionLink" href="#parameter-mode" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>auto</li>
+ <li>manual</li>
+ <li>Disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>NCSI mode, auto-Auto Failover, manual-Manual Switch.</div>
+ <div>Only M6 model supports <code>Disable</code> Settings.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-nic_type"></div>
+ <b>nic_type</b>
+ <a class="ansibleOptionLink" href="#parameter-nic_type" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>PHY</li>
+ <li>OCP</li>
+ <li>OCP1</li>
+ <li>PCIE</li>
+ <li>auto</li>
+ <li>Disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Nic type.</div>
+ <div>Only NF3280A6 and NF3180A6 model supports <code>Disable</code> Settings, but not support <code>PHY</code> Settings.</div>
+ <div>M6 model only support <code>OCP</code>, <code>OCP1</code>, <code>PCIE</code> settings.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: NCSI test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set ncsi information"
+ kaytus.ksmanage.edit_ncsi:
+ mode: "manual"
+ nic_type: "PCIE"
+ interface_name: "eth0"
+ channel_number: 1
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_network_bond_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_network_bond_module.rst new file mode 100644 index 000000000..7be810932 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_network_bond_module.rst @@ -0,0 +1,363 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_network_bond_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_network_bond -- Set network bond
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_network_bond`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set network bond on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-auto_config"></div>
+ <b>auto_config</b>
+ <a class="ansibleOptionLink" href="#parameter-auto_config" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Enable this option to configure the interfaces in service configuration automatically.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-bond"></div>
+ <b>bond</b>
+ <a class="ansibleOptionLink" href="#parameter-bond" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Network bond status, If VLAN is enabled for slave interfaces, then Bonding cannot be enabled.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-interface"></div>
+ <b>interface</b>
+ <a class="ansibleOptionLink" href="#parameter-interface" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>shared</li>
+ <li>dedicated</li>
+ <li>both</li>
+ </ul>
+ </td>
+ <td>
+ <div>Interface name.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Bond test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set network bond"
+ kaytus.ksmanage.edit_network_bond:
+ bond: "enable"
+ interface: "dedicated"
+ auto_config: "enable"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_network_link_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_network_link_module.rst new file mode 100644 index 000000000..997d8d2d9 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_network_link_module.rst @@ -0,0 +1,392 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_network_link_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_network_link -- Set network link
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_network_link`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set network link on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-auto_nego"></div>
+ <b>auto_nego</b>
+ <a class="ansibleOptionLink" href="#parameter-auto_nego" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>This option allows the device to perform auto-configuration.</div>
+ <div>To achieve the best mode of operation (speed and duplex) on the link.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-duplex_mode"></div>
+ <b>duplex_mode</b>
+ <a class="ansibleOptionLink" href="#parameter-duplex_mode" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>HALF</li>
+ <li>FULL</li>
+ </ul>
+ </td>
+ <td>
+ <div>Select any one of the following Duplex Mode.</div>
+ <div>Required when <em>auto_nego=disable</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-interface"></div>
+ <b>interface</b>
+ <a class="ansibleOptionLink" href="#parameter-interface" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>shared</li>
+ <li>dedicated</li>
+ <li>both</li>
+ </ul>
+ </td>
+ <td>
+ <div>Interface name.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-link_speed"></div>
+ <b>link_speed</b>
+ <a class="ansibleOptionLink" href="#parameter-link_speed" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>10</li>
+ <li>100</li>
+ </ul>
+ </td>
+ <td>
+ <div>Link speed will list all the supported capabilities of the network interface. It can be 10/100 Mbps.</div>
+ <div>Required when <em>auto_nego=disable</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Link test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set network link"
+ kaytus.ksmanage.edit_network_link:
+ interface: "dedicated"
+ auto_nego: "enable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set network link"
+ kaytus.ksmanage.edit_network_link:
+ interface: "dedicated"
+ auto_nego: "disable"
+ link_speed: 100
+ duplex_mode: "FULL"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_network_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_network_module.rst new file mode 100644 index 000000000..c22cbccb5 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_network_module.rst @@ -0,0 +1,343 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_network_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_network -- Set network information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_network`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set network information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-interface_name"></div>
+ <b>interface_name</b>
+ <a class="ansibleOptionLink" href="#parameter-interface_name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>eth0</li>
+ <li>eth1</li>
+ <li>bond0</li>
+ </ul>
+ </td>
+ <td>
+ <div>Set interface name. Select the LAN interface to be configured.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-lan_enable"></div>
+ <b>lan_enable</b>
+ <a class="ansibleOptionLink" href="#parameter-lan_enable" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Enable or disable this interface. If disable, you cannot use this interface any more.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Network test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set network information"
+ kaytus.ksmanage.edit_network:
+ interface_name: "eth0"
+ lan_enable: "enable"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_ntp_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_ntp_module.rst new file mode 100644 index 000000000..ecf48a766 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_ntp_module.rst @@ -0,0 +1,486 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_ntp_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_ntp -- Set NTP
++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_ntp`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set NTP on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-auto_date"></div>
+ <b>auto_date</b>
+ <a class="ansibleOptionLink" href="#parameter-auto_date" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Date auto synchronize.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-max_variety"></div>
+ <b>max_variety</b>
+ <a class="ansibleOptionLink" href="#parameter-max_variety" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>NTP Maximum jump time(minute), max variety(1-60).</div>
+ <div>Only the M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ntp_time"></div>
+ <b>ntp_time</b>
+ <a class="ansibleOptionLink" href="#parameter-ntp_time" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>NTP time(YYYYmmddHHMMSS).</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server1"></div>
+ <b>server1</b>
+ <a class="ansibleOptionLink" href="#parameter-server1" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>NTP Server1(ipv4 or ipv6 or domain name), set when auto_date is enable.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server2"></div>
+ <b>server2</b>
+ <a class="ansibleOptionLink" href="#parameter-server2" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>NTP Server2(ipv4 or ipv6 or domain name), set when auto_date is enable.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server3"></div>
+ <b>server3</b>
+ <a class="ansibleOptionLink" href="#parameter-server3" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>NTP Server3(ipv4 or ipv6 or domain name), set when auto_date is enable.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server4"></div>
+ <b>server4</b>
+ <a class="ansibleOptionLink" href="#parameter-server4" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>NTP Server4(ipv4 or ipv6 or domain name), set when auto_date is enable.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server5"></div>
+ <b>server5</b>
+ <a class="ansibleOptionLink" href="#parameter-server5" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>NTP Server5(ipv4 or ipv6 or domain name), set when auto_date is enable.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server6"></div>
+ <b>server6</b>
+ <a class="ansibleOptionLink" href="#parameter-server6" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>NTP Server6(ipv4 or ipv6 or domain name), set when auto_date is enable.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-syn_cycle"></div>
+ <b>syn_cycle</b>
+ <a class="ansibleOptionLink" href="#parameter-syn_cycle" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>NTP syn cycle(minute), sync cycle(5-1440).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-time_zone"></div>
+ <b>time_zone</b>
+ <a class="ansibleOptionLink" href="#parameter-time_zone" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>UTC time zone, chose from {-12, -11.5, -11, ... , 11, 11.5, 12}.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: NTP test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set ntp"
+ kaytus.ksmanage.edit_ntp:
+ auto_date: "enable"
+ server2: "time.nist.gov"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set ntp"
+ kaytus.ksmanage.edit_ntp:
+ auto_date: "disable"
+ ntp_time: "20200609083600"
+ provider: "{{ ksmanage }}"
+
+ - name: "set ntp"
+ kaytus.ksmanage.edit_ntp:
+ time_zone: "8"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_pdisk_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_pdisk_module.rst new file mode 100644 index 000000000..db2e9118d --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_pdisk_module.rst @@ -0,0 +1,482 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_pdisk_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_pdisk -- Set physical disk
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_pdisk`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set physical disk on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-action"></div>
+ <b>action</b>
+ <a class="ansibleOptionLink" href="#parameter-action" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>remove</li>
+ <li>global</li>
+ <li>dedicate</li>
+ </ul>
+ </td>
+ <td>
+ <div>Action while set physical drive hotspare.</div>
+ <div>Required when <em>option=HS</em>.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ctrl_id"></div>
+ <b>ctrl_id</b>
+ <a class="ansibleOptionLink" href="#parameter-ctrl_id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Raid controller ID.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-device_id"></div>
+ <b>device_id</b>
+ <a class="ansibleOptionLink" href="#parameter-device_id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Physical drive id.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-duration"></div>
+ <b>duration</b>
+ <a class="ansibleOptionLink" href="#parameter-duration" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Duration range is 1-255, physical drive under PMC raid controller.</div>
+ <div>Required when <em>option=LOC</em>.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-encl"></div>
+ <b>encl</b>
+ <a class="ansibleOptionLink" href="#parameter-encl" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>yes</li>
+ <li>no</li>
+ </ul>
+ </td>
+ <td>
+ <div>IsEnclAffinity while set physical drive hotspare.</div>
+ <div>Required when <em>option=HS</em> and <em>action=dedicate</em>.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-logical_drivers"></div>
+ <b>logical_drivers</b>
+ <a class="ansibleOptionLink" href="#parameter-logical_drivers" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">list</span>
+ / <span style="color: purple">elements=integer</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Logical Drivers while set physical drive hotspare, input multiple Logical Drivers index like 0, 1, 2.....</div>
+ <div>Required when <em>option=HS</em> and <em>action=dedicate</em>.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-option"></div>
+ <b>option</b>
+ <a class="ansibleOptionLink" href="#parameter-option" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>UG</li>
+ <li>UB</li>
+ <li>OFF</li>
+ <li>FAIL</li>
+ <li>RBD</li>
+ <li>ON</li>
+ <li>JB</li>
+ <li>ES</li>
+ <li>EM</li>
+ <li>EN</li>
+ <li>ET</li>
+ <li>LOC</li>
+ <li>STL</li>
+ <li>HS</li>
+ </ul>
+ </td>
+ <td>
+ <div>Set operation options for a physical disk.</div>
+ <div>UG is Unconfigured Good, UB is Unconfigured Bad.</div>
+ <div>OFF is offline, FAIL is Failed, RBD is Rebuild.</div>
+ <div>ON is Online, JB is JBOD, ES is Drive Erase stop.</div>
+ <div>EM is Drive Erase Simple, EN is Drive Erase Normal.</div>
+ <div>ET is Drive Erase Through, LOC is Locate, STL is Stop Locate.</div>
+ <div>HS is Hot spare.</div>
+ <div>Only the M5 model supports <code>HS</code> Settings.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-revertible"></div>
+ <b>revertible</b>
+ <a class="ansibleOptionLink" href="#parameter-revertible" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>yes</li>
+ <li>no</li>
+ </ul>
+ </td>
+ <td>
+ <div>IsRevertible while set physical drive hotspare.</div>
+ <div>Required when <em>option=HS</em> and <em>action=dedicate</em>.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Edit pdisk test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Edit pdisk"
+ kaytus.ksmanage.edit_pdisk:
+ ctrl_id: 0
+ device_id: 1
+ option: "LOC"
+ provider: "{{ ksmanage }}"
+
+ - name: "M5 Edit pdisk"
+ kaytus.ksmanage.edit_pdisk:
+ ctrl_id: 0
+ device_id: 1
+ option: "HS"
+ action: "dedicate"
+ revertible: "yes"
+ encl: "yes"
+ logical_drivers: 1
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_power_budget_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_power_budget_module.rst new file mode 100644 index 000000000..7d28c1a97 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_power_budget_module.rst @@ -0,0 +1,685 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_power_budget_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_power_budget -- Set power budget information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_power_budget`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set power budget information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-action"></div>
+ <b>action</b>
+ <a class="ansibleOptionLink" href="#parameter-action" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>add</li>
+ <li>delete</li>
+ <li>open</li>
+ <li>close</li>
+ </ul>
+ </td>
+ <td>
+ <div>Type to action.</div>
+ <div>Required when <em>range=False</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-domain"></div>
+ <b>domain</b>
+ <a class="ansibleOptionLink" href="#parameter-domain" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>system</li>
+ <li>cpu</li>
+ </ul>
+ </td>
+ <td>
+ <div>Domain id.</div>
+ <div>Required when <em>range=False</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-end1"></div>
+ <b>end1</b>
+ <a class="ansibleOptionLink" href="#parameter-end1" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Pause period of add, end time, must be greater than start time, from 0 to 24.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-end2"></div>
+ <b>end2</b>
+ <a class="ansibleOptionLink" href="#parameter-end2" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Pause period of add, end time, must be greater than start time, from 0 to 24.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-end3"></div>
+ <b>end3</b>
+ <a class="ansibleOptionLink" href="#parameter-end3" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Pause period of add, end time, must be greater than start time, from 0 to 24.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-end4"></div>
+ <b>end4</b>
+ <a class="ansibleOptionLink" href="#parameter-end4" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Pause period of add, end time, must be greater than start time, from 0 to 24.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-end5"></div>
+ <b>end5</b>
+ <a class="ansibleOptionLink" href="#parameter-end5" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Pause period of add, end time, must be greater than start time, from 0 to 24.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-except_action"></div>
+ <b>except_action</b>
+ <a class="ansibleOptionLink" href="#parameter-except_action" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ </ul>
+ </td>
+ <td>
+ <div>Except action, 0 is do nothing, 1 is send alert, 2 is shutdown system, 3 is shutdown system and send alert.</div>
+ <div>Only the M7 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-id"></div>
+ <b>id</b>
+ <a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ <li>4</li>
+ </ul>
+ </td>
+ <td>
+ <div>Policy id.</div>
+ <div>Required when <em>range=False</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-range"></div>
+ <b>range</b>
+ <a class="ansibleOptionLink" href="#parameter-range" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li><div style="color: blue"><b>no</b> ←</div></li>
+ <li>yes</li>
+ </ul>
+ </td>
+ <td>
+ <div>Range of power budget watts.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-start1"></div>
+ <b>start1</b>
+ <a class="ansibleOptionLink" href="#parameter-start1" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Pause period of add, start time, from 0 to 24.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-start2"></div>
+ <b>start2</b>
+ <a class="ansibleOptionLink" href="#parameter-start2" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Pause period of add, start time, from 0 to 24.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-start3"></div>
+ <b>start3</b>
+ <a class="ansibleOptionLink" href="#parameter-start3" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Pause period of add, start time, from 0 to 24.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-start4"></div>
+ <b>start4</b>
+ <a class="ansibleOptionLink" href="#parameter-start4" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Pause period of add, start time, from 0 to 24.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-start5"></div>
+ <b>start5</b>
+ <a class="ansibleOptionLink" href="#parameter-start5" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Period of add, start time, from 0 to 24.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-watts"></div>
+ <b>watts</b>
+ <a class="ansibleOptionLink" href="#parameter-watts" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Power budget watts of add.</div>
+ <div>Required when <em>action=add</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-week1"></div>
+ <b>week1</b>
+ <a class="ansibleOptionLink" href="#parameter-week1" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">list</span>
+ / <span style="color: purple">elements=string</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Pause period of add, repetition period.</div>
+ <div>The input parameters are 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat', 'Sun', separated by commas, such as Mon, Wed, Fri.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-week2"></div>
+ <b>week2</b>
+ <a class="ansibleOptionLink" href="#parameter-week2" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">list</span>
+ / <span style="color: purple">elements=string</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Pause period of add, repetition period.</div>
+ <div>The input parameters are 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat', 'Sun', separated by commas, such as Mon, Wed, Fri.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-week3"></div>
+ <b>week3</b>
+ <a class="ansibleOptionLink" href="#parameter-week3" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">list</span>
+ / <span style="color: purple">elements=string</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Pause period of add, repetition period.</div>
+ <div>The input parameters are 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat', 'Sun', separated by commas, such as Mon, Wed, Fri.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-week4"></div>
+ <b>week4</b>
+ <a class="ansibleOptionLink" href="#parameter-week4" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">list</span>
+ / <span style="color: purple">elements=string</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Pause period of add, repetition period.</div>
+ <div>The input parameters are 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat', 'Sun', separated by commas, such as Mon, Wed, Fri.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-week5"></div>
+ <b>week5</b>
+ <a class="ansibleOptionLink" href="#parameter-week5" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">list</span>
+ / <span style="color: purple">elements=string</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Pause period of add, repetition period.</div>
+ <div>The input parameters are 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat', 'Sun', separated by commas, such as Mon, Wed, Fri.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Power budget test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get power budget range"
+ kaytus.ksmanage.edit_power_budget:
+ range: True
+ provider: "{{ ksmanage }}"
+
+ - name: "add power budget"
+ kaytus.ksmanage.edit_power_budget:
+ action: "add"
+ id: 1
+ watts: 1500
+ start1: 2
+ end1: 5
+ week1:
+ - Mon
+ - Wed
+ - Fri
+ provider: "{{ ksmanage }}"
+
+ - name: "Set power budget status to open"
+ kaytus.ksmanage.edit_power_budget:
+ action: "open"
+ id: 1
+ provider: "{{ ksmanage }}"
+
+ - name: "Set power budget status to close"
+ kaytus.ksmanage.edit_power_budget:
+ action: "close"
+ id: 1
+ provider: "{{ ksmanage }}"
+
+ - name: "Delete power budget"
+ kaytus.ksmanage.edit_power_budget:
+ action: "delete"
+ id: 1
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_power_restore_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_power_restore_module.rst new file mode 100644 index 000000000..8a4fdfd77 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_power_restore_module.rst @@ -0,0 +1,323 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_power_restore_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_power_restore -- Set power restore information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_power_restore`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set power restore information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-option"></div>
+ <b>option</b>
+ <a class="ansibleOptionLink" href="#parameter-option" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>on</li>
+ <li>off</li>
+ <li>restore</li>
+ </ul>
+ </td>
+ <td>
+ <div>Set power policy option.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Power restore test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set power restore information"
+ kaytus.ksmanage.edit_power_restore:
+ option: "on"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_power_status_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_power_status_module.rst new file mode 100644 index 000000000..61d8ce18f --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_power_status_module.rst @@ -0,0 +1,325 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_power_status_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_power_status -- Set power status information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_power_status`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set power status information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>On</li>
+ <li>ForceOff</li>
+ <li>ForcePowerCycle</li>
+ <li>ForceReset</li>
+ <li>GracefulShutdown</li>
+ </ul>
+ </td>
+ <td>
+ <div>Power status.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Power status test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set power status information"
+ kaytus.ksmanage.edit_power_status:
+ state: "On"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_preserve_config_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_preserve_config_module.rst new file mode 100644 index 000000000..1cc0f8008 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_preserve_config_module.rst @@ -0,0 +1,373 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_preserve_config_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_preserve_config -- Set preserve config
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_preserve_config`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set preserve config on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-override"></div>
+ <b>override</b>
+ <a class="ansibleOptionLink" href="#parameter-override" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">list</span>
+ / <span style="color: purple">elements=string</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>authentication</li>
+ <li>dcmi</li>
+ <li>fru</li>
+ <li>hostname</li>
+ <li>ipmi</li>
+ <li>kvm</li>
+ <li>network</li>
+ <li>ntp</li>
+ <li>pef</li>
+ <li>sdr</li>
+ <li>sel</li>
+ <li>smtp</li>
+ <li>snmp</li>
+ <li>sol</li>
+ <li>ssh</li>
+ <li>syslog</li>
+ <li>user</li>
+ </ul>
+ </td>
+ <td>
+ <div>Configuration items that need to be retained.</div>
+ <div>Required when <em>setting=manual</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-setting"></div>
+ <b>setting</b>
+ <a class="ansibleOptionLink" href="#parameter-setting" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>all</li>
+ <li>none</li>
+ <li>manual</li>
+ </ul>
+ </td>
+ <td>
+ <div>Preserve option, all - preserve all config; none - overwrite all config; manual - manual choose.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Preserve test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set preserve all"
+ kaytus.ksmanage.edit_preserve_config:
+ setting: "all"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set preserve none"
+ edit_preserve_config:
+ setting: "none"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set preserve manual"
+ edit_preserve_config:
+ setting: "manual"
+ override:
+ - fru
+ - ntp
+ - network
+ - user
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_psu_config_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_psu_config_module.rst new file mode 100644 index 000000000..1466ceac0 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_psu_config_module.rst @@ -0,0 +1,339 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_psu_config_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_psu_config -- Set psu config information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_psu_config`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set psu config information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-id"></div>
+ <b>id</b>
+ <a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Power id.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-switch"></div>
+ <b>switch</b>
+ <a class="ansibleOptionLink" href="#parameter-switch" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>active</li>
+ <li>standby</li>
+ <li>normal</li>
+ </ul>
+ </td>
+ <td>
+ <div>Power supply mode, active or standby.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Psu config test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set psu config information"
+ kaytus.ksmanage.edit_psu_config:
+ id: 1
+ switch: "active"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_psu_peak_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_psu_peak_module.rst new file mode 100644 index 000000000..d01632022 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_psu_peak_module.rst @@ -0,0 +1,343 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_psu_peak_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_psu_peak -- Set psu peak information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_psu_peak`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set psu peak information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-status"></div>
+ <b>status</b>
+ <a class="ansibleOptionLink" href="#parameter-status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Power peak status.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-time"></div>
+ <b>time</b>
+ <a class="ansibleOptionLink" href="#parameter-time" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Maximum random time, range of values(1-600), unit(second).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Psu peak test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set psu peak information"
+ kaytus.ksmanage.edit_psu_peak:
+ status: "disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set psu peak information"
+ kaytus.ksmanage.edit_psu_peak:
+ status: "enable"
+ time: 10
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_restore_factory_default_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_restore_factory_default_module.rst new file mode 100644 index 000000000..77ffa69e4 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_restore_factory_default_module.rst @@ -0,0 +1,368 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_restore_factory_default_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_restore_factory_default -- Set preserver config
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_restore_factory_default`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set preserver config on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-mode"></div>
+ <b>mode</b>
+ <a class="ansibleOptionLink" href="#parameter-mode" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>all</li>
+ <li>none</li>
+ <li>manual</li>
+ </ul>
+ </td>
+ <td>
+ <div>Restore factory defaults mode.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-override"></div>
+ <b>override</b>
+ <a class="ansibleOptionLink" href="#parameter-override" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">list</span>
+ / <span style="color: purple">elements=string</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>authentication</li>
+ <li>dcmi</li>
+ <li>fru</li>
+ <li>hostname</li>
+ <li>ipmi</li>
+ <li>kvm</li>
+ <li>network</li>
+ <li>ntp</li>
+ <li>pef</li>
+ <li>sdr</li>
+ <li>sel</li>
+ <li>smtp</li>
+ <li>snmp</li>
+ <li>sol</li>
+ <li>ssh</li>
+ <li>syslog</li>
+ <li>user</li>
+ </ul>
+ </td>
+ <td>
+ <div>Configuration items that need to be retained.</div>
+ <div>Required when <em>mode=manual</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Restore default test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set restore default auto"
+ kaytus.ksmanage.edit_restore_factory_default:
+ mode: "all"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set restore default manual"
+ kaytus.ksmanage.edit_restore_factory_default:
+ mode: "manual"
+ override:
+ - fru
+ - ntp
+ - network
+ - user
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_service_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_service_module.rst new file mode 100644 index 000000000..d5628c468 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_service_module.rst @@ -0,0 +1,428 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_service_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_service -- Set service settings
+++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_service`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set service settings on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-interface"></div>
+ <b>interface</b>
+ <a class="ansibleOptionLink" href="#parameter-interface" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>eth0</li>
+ <li>eth1</li>
+ <li>both</li>
+ <li>bond0</li>
+ </ul>
+ </td>
+ <td>
+ <div>It shows the interface in which service is running.</div>
+ <div>The user can choose any one of the available interfaces.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-non_secure_port"></div>
+ <b>non_secure_port</b>
+ <a class="ansibleOptionLink" href="#parameter-non_secure_port" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Used to configure non secure port number for the service.</div>
+ <div>Port value ranges from 1 to 65535.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-secure_port"></div>
+ <b>secure_port</b>
+ <a class="ansibleOptionLink" href="#parameter-secure_port" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Used to configure secure port number for the service.</div>
+ <div>Port value ranges from 1 to 65535.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-service_name"></div>
+ <b>service_name</b>
+ <a class="ansibleOptionLink" href="#parameter-service_name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>web</li>
+ <li>kvm</li>
+ <li>cd-media</li>
+ <li>fd-media</li>
+ <li>hd-media</li>
+ <li>ssh</li>
+ <li>telnet</li>
+ <li>solssh</li>
+ <li>snmp</li>
+ <li>vnc</li>
+ </ul>
+ </td>
+ <td>
+ <div>Displays service name of the selected slot(readonly).</div>
+ <div>The <em>vnc</em> option is not supported in M5.</div>
+ <div>The <em>fd-media/telnet/snmp</em> option is not supported in M6.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>active</li>
+ <li>inactive</li>
+ </ul>
+ </td>
+ <td>
+ <div>Displays the current status of the service, either active or inactive state.</div>
+ <div>Check this option to start the inactive service.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-timeout"></div>
+ <b>timeout</b>
+ <a class="ansibleOptionLink" href="#parameter-timeout" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Displays the session timeout value of the service.</div>
+ <div>For web, SSH and telnet service, user can configure the session timeout value.</div>
+ <div>Web timeout value ranges from 300 to 1800 seconds.</div>
+ <div>SSH and Telnet timeout value ranges from 60 to 1800 seconds.</div>
+ <div>Timeout value should be in multiples of 60 seconds.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Edit service test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Edit kvm"
+ kaytus.ksmanage.edit_service:
+ service_name: "kvm"
+ state: "active"
+ timeout: "1200"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_smtp_com_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_smtp_com_module.rst new file mode 100644 index 000000000..24f139729 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_smtp_com_module.rst @@ -0,0 +1,578 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_smtp_com_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_smtp_com -- Set SMTP information
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_smtp_com`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set SMTP com information on kaytus Server.
+- Only the M6 models support this feature.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-asset_tag"></div>
+ <b>asset_tag</b>
+ <a class="ansibleOptionLink" href="#parameter-asset_tag" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Product asset label.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-email"></div>
+ <b>email</b>
+ <a class="ansibleOptionLink" href="#parameter-email" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Sender email.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-event_level"></div>
+ <b>event_level</b>
+ <a class="ansibleOptionLink" href="#parameter-event_level" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>Info</li>
+ <li>Warning</li>
+ <li>Critical</li>
+ </ul>
+ </td>
+ <td>
+ <div>Events above this level will be sent.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host_name"></div>
+ <b>host_name</b>
+ <a class="ansibleOptionLink" href="#parameter-host_name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Server name.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-serial_number"></div>
+ <b>serial_number</b>
+ <a class="ansibleOptionLink" href="#parameter-serial_number" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Serial number.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server_auth"></div>
+ <b>server_auth</b>
+ <a class="ansibleOptionLink" href="#parameter-server_auth" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>SMTP server authentication.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server_ip"></div>
+ <b>server_ip</b>
+ <a class="ansibleOptionLink" href="#parameter-server_ip" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>SMTP server IP.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server_password"></div>
+ <b>server_password</b>
+ <a class="ansibleOptionLink" href="#parameter-server_password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>SMTP server Password, length be 4 to 64 bits, cannot contain ' '(space).</div>
+ <div>Required when <em>server_auth=enable</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server_port"></div>
+ <b>server_port</b>
+ <a class="ansibleOptionLink" href="#parameter-server_port" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>SMTP server port, The Identification for retry count configuration(1-65535).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server_secure_port"></div>
+ <b>server_secure_port</b>
+ <a class="ansibleOptionLink" href="#parameter-server_secure_port" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>SMTP server secure port, The Identification for retry count configuration(1-65535).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-server_username"></div>
+ <b>server_username</b>
+ <a class="ansibleOptionLink" href="#parameter-server_username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>SMTP server Username, length be 4 to 64 bits.</div>
+ <div>Must start with letters and cannot contain ','(comma) ':'(colon) ' '(space) ';'(semicolon) '\'(backslash).</div>
+ <div>Required when <em>server_auth=enable</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-ssl_tls_enable"></div>
+ <b>ssl_tls_enable</b>
+ <a class="ansibleOptionLink" href="#parameter-ssl_tls_enable" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>SMTP SSLTLS Enable.</div>
+ <div><em>ssl_tls_enable=disable</em>, when <em>star_tls_enable=enable</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-star_tls_enable"></div>
+ <b>star_tls_enable</b>
+ <a class="ansibleOptionLink" href="#parameter-star_tls_enable" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>SMTP STARTTLS Enable.</div>
+ <div><em>star_tls_enable=disable</em>, when <em>ssl_tls_enable=enable</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-status"></div>
+ <b>status</b>
+ <a class="ansibleOptionLink" href="#parameter-status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>SMTP Support.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-subject"></div>
+ <b>subject</b>
+ <a class="ansibleOptionLink" href="#parameter-subject" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Email theme.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Smtp com test
+ hosts: ksmanage
+ no_log: true
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set smtp com information"
+ kaytus.ksmanage.edit_smtp_com:
+ status: "disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set smtp com information"
+ kaytus.ksmanage.edit_smtp_com:
+ status: "enable"
+ server_ip: "100.2.2.2"
+ email: "ks@kaytus.com"
+ server_auth: "enable"
+ server_username: "admin"
+ server_password: "1234qwer!@#$"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_smtp_dest_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_smtp_dest_module.rst new file mode 100644 index 000000000..e2c403eb8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_smtp_dest_module.rst @@ -0,0 +1,383 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_smtp_dest_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_smtp_dest -- Set SMTP information
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_smtp_dest`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set SMTP dest information on kaytus Server.
+- Only the M6 models support this feature.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-address"></div>
+ <b>address</b>
+ <a class="ansibleOptionLink" href="#parameter-address" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Email address.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-description"></div>
+ <b>description</b>
+ <a class="ansibleOptionLink" href="#parameter-description" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Description information.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-id"></div>
+ <b>id</b>
+ <a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ <li>4</li>
+ </ul>
+ </td>
+ <td>
+ <div>Email destination id.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-status"></div>
+ <b>status</b>
+ <a class="ansibleOptionLink" href="#parameter-status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Email enable.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Smtp dest test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set smtp dest information"
+ kaytus.ksmanage.edit_smtp_dest:
+ id: 1
+ status: "disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set smtp dest information"
+ kaytus.ksmanage.edit_smtp_dest:
+ id: 1
+ status: "enable"
+ address: "100.2.2.2"
+ description": "test"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_smtp_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_smtp_module.rst new file mode 100644 index 000000000..b00842ae8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_smtp_module.rst @@ -0,0 +1,587 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_smtp_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_smtp -- Set SMTP information
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_smtp`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set SMTP information on kaytus Server.
+- Only the M5 models support this feature.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-email"></div>
+ <b>email</b>
+ <a class="ansibleOptionLink" href="#parameter-email" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Sender email.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-interface"></div>
+ <b>interface</b>
+ <a class="ansibleOptionLink" href="#parameter-interface" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>eth0</li>
+ <li>eth1</li>
+ <li>bond0</li>
+ </ul>
+ </td>
+ <td>
+ <div>LAN Channel, eth0 is shared, eth1 is dedicated.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-primary_auth"></div>
+ <b>primary_auth</b>
+ <a class="ansibleOptionLink" href="#parameter-primary_auth" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Primary SMTP server authentication.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-primary_ip"></div>
+ <b>primary_ip</b>
+ <a class="ansibleOptionLink" href="#parameter-primary_ip" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Primary SMTP server IP.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-primary_name"></div>
+ <b>primary_name</b>
+ <a class="ansibleOptionLink" href="#parameter-primary_name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Primary SMTP server name.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-primary_password"></div>
+ <b>primary_password</b>
+ <a class="ansibleOptionLink" href="#parameter-primary_password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Primary SMTP server Password, length be 4 to 64 bits, cannot contain ' '(space).</div>
+ <div>Required when <em>primary_auth=enable</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-primary_port"></div>
+ <b>primary_port</b>
+ <a class="ansibleOptionLink" href="#parameter-primary_port" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Primary SMTP server port, The Identification for retry count configuration(1-65535).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-primary_status"></div>
+ <b>primary_status</b>
+ <a class="ansibleOptionLink" href="#parameter-primary_status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Primary SMTP Support.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-primary_username"></div>
+ <b>primary_username</b>
+ <a class="ansibleOptionLink" href="#parameter-primary_username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Primary SMTP server Username, length be 4 to 64 bits.</div>
+ <div>Must start with letters and cannot contain ', '(comma) ':'(colon) ' '(space) ';'(semicolon) '\'(backslash).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-secondary_auth"></div>
+ <b>secondary_auth</b>
+ <a class="ansibleOptionLink" href="#parameter-secondary_auth" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Secondary SMTP server authentication.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-secondary_ip"></div>
+ <b>secondary_ip</b>
+ <a class="ansibleOptionLink" href="#parameter-secondary_ip" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Secondary SMTP server IP.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-secondary_name"></div>
+ <b>secondary_name</b>
+ <a class="ansibleOptionLink" href="#parameter-secondary_name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Secondary SMTP server name.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-secondary_password"></div>
+ <b>secondary_password</b>
+ <a class="ansibleOptionLink" href="#parameter-secondary_password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Secondary SMTP server Password, length be 4 to 64 bits, cannot contain ' '(space).</div>
+ <div>Required when <em>secondary_auth=enable</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-secondary_port"></div>
+ <b>secondary_port</b>
+ <a class="ansibleOptionLink" href="#parameter-secondary_port" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Secondary SMTP server port, The Identification for retry count configuration(1-65535).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-secondary_status"></div>
+ <b>secondary_status</b>
+ <a class="ansibleOptionLink" href="#parameter-secondary_status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Secondary SMTP Support.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-secondary_username"></div>
+ <b>secondary_username</b>
+ <a class="ansibleOptionLink" href="#parameter-secondary_username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Secondary SMTP server Username, length be 4 to 64 bits.</div>
+ <div>Must start with letters and cannot contain ','(comma) ':'(colon) ' '(space) ';'(semicolon) '\'(backslash).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Smtp test
+ hosts: ksmanage
+ no_log: true
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set smtp information"
+ kaytus.ksmanage.edit_smtp:
+ interface: "eth0"
+ email: "ieit@ieisystem.com"
+ primary_status: "enable"
+ primary_ip: "100.2.2.2"
+ primary_name: "test"
+ primary_auth: "disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set smtp information"
+ kaytus.ksmanage.edit_smtp:
+ interface: "eth0"
+ email: "ieit@ieisystem.com"
+ primary_status: "enable"
+ primary_ip: "100.2.2.2"
+ primary_name: "test"
+ primary_auth: "enable"
+ primary_username: "test"
+ primary_password: my_password
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_snmp_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_snmp_module.rst new file mode 100644 index 000000000..d153a2fb1 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_snmp_module.rst @@ -0,0 +1,540 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_snmp_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_snmp -- Set snmp
++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_snmp`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set snmp on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-auth_password"></div>
+ <b>auth_password</b>
+ <a class="ansibleOptionLink" href="#parameter-auth_password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set the authentication password for the V3 trap or v3get/v3set.</div>
+ <div>The password is a string of 8 to 16 alphanumeric characters.</div>
+ <div>Required when <em>auth_protocol</em> is either <code>SHA</code> or <code>MD5</code>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-auth_protocol"></div>
+ <b>auth_protocol</b>
+ <a class="ansibleOptionLink" href="#parameter-auth_protocol" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>NONE</li>
+ <li>SHA</li>
+ <li>MD5</li>
+ </ul>
+ </td>
+ <td>
+ <div>Choose the authentication protocol for the V3 trap or v3get/v3set.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-community"></div>
+ <b>community</b>
+ <a class="ansibleOptionLink" href="#parameter-community" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Community of v1/v2c or v1get/v1set/v2cget/v2cset.</div>
+ <div>Only the M5 models support this feature.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-priv_password"></div>
+ <b>priv_password</b>
+ <a class="ansibleOptionLink" href="#parameter-priv_password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set the privacy password for the V3 trap or v3get/v3set.</div>
+ <div>The password is a string of 8 to 16 alphanumeric characters.</div>
+ <div>Required when <em>priv_protocol</em> is either <code>DES</code> or <code>AES</code>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-priv_protocol"></div>
+ <b>priv_protocol</b>
+ <a class="ansibleOptionLink" href="#parameter-priv_protocol" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>NONE</li>
+ <li>DES</li>
+ <li>AES</li>
+ </ul>
+ </td>
+ <td>
+ <div>Choose the privacy protocol for the V3 trap or v3get/v3set.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-read_community"></div>
+ <b>read_community</b>
+ <a class="ansibleOptionLink" href="#parameter-read_community" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Read Only Community, Community should between 1 and 16 characters.</div>
+ <div>Only the M6 models support this feature.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-read_write_community"></div>
+ <b>read_write_community</b>
+ <a class="ansibleOptionLink" href="#parameter-read_write_community" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Read And Write Community, Community should between 1 and 16 characters.</div>
+ <div>Only the M6 models support this feature.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-snmp_status"></div>
+ <b>snmp_status</b>
+ <a class="ansibleOptionLink" href="#parameter-snmp_status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">list</span>
+ / <span style="color: purple">elements=string</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>NMP read/write status of customize.</div>
+ <div>The input parameters are 'v1get', 'v1set', 'v2cget', 'v2cset', 'v3get', 'v3set', separated by commas, such as v1get, v1set, v2cget.</div>
+ <div>Only the M5 models support this feature.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-v1status"></div>
+ <b>v1status</b>
+ <a class="ansibleOptionLink" href="#parameter-v1status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>SNMP V1 enable.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-v2status"></div>
+ <b>v2status</b>
+ <a class="ansibleOptionLink" href="#parameter-v2status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>SNMP V2 enable.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-v3status"></div>
+ <b>v3status</b>
+ <a class="ansibleOptionLink" href="#parameter-v3status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>SNMP V3 enable.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-v3username"></div>
+ <b>v3username</b>
+ <a class="ansibleOptionLink" href="#parameter-v3username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set a username for the V3 trap or v3get/v3set.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-version"></div>
+ <b>version</b>
+ <a class="ansibleOptionLink" href="#parameter-version" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ <li>4</li>
+ </ul>
+ </td>
+ <td>
+ <div>SNMP trap version option, 0 - 'v1', 1 - 'v2c', 2 - 'v3', 3 - 'all', 4 - 'customize'.</div>
+ <div>Only the M5 models support this feature.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Snmp test
+ hosts: ksmanage
+ no_log: true
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set snmp get/set"
+ kaytus.ksmanage.edit_snmp:
+ community: "test"
+ v3username: "test"
+ provider: "{{ ksmanage }}"
+
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_snmp_trap_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_snmp_trap_module.rst new file mode 100644 index 000000000..8efffc81a --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_snmp_trap_module.rst @@ -0,0 +1,598 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_snmp_trap_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_snmp_trap -- Set snmp trap
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_snmp_trap`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set snmp trap on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-auth_password"></div>
+ <b>auth_password</b>
+ <a class="ansibleOptionLink" href="#parameter-auth_password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set the authentication password for the V3 trap.</div>
+ <div>The password is a string of 8 to 16 alphanumeric characters.</div>
+ <div>Required when <em>auth_protocol</em> is either <code>SHA</code> or <code>MD5</code>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-auth_protocol"></div>
+ <b>auth_protocol</b>
+ <a class="ansibleOptionLink" href="#parameter-auth_protocol" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>NONE</li>
+ <li>SHA</li>
+ <li>MD5</li>
+ </ul>
+ </td>
+ <td>
+ <div>Choose the authentication protocol for the V3 trap.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-community"></div>
+ <b>community</b>
+ <a class="ansibleOptionLink" href="#parameter-community" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Community of v1/v2c.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-contact"></div>
+ <b>contact</b>
+ <a class="ansibleOptionLink" href="#parameter-contact" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set the contact, can be NULL.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-engine_id"></div>
+ <b>engine_id</b>
+ <a class="ansibleOptionLink" href="#parameter-engine_id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies an engine identifier for the V3 trap. The value should be string of 10 to 48 hex characters, must be even, can be NULL.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-event_severity"></div>
+ <b>event_severity</b>
+ <a class="ansibleOptionLink" href="#parameter-event_severity" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>all</li>
+ <li>warning</li>
+ <li>critical</li>
+ </ul>
+ </td>
+ <td>
+ <div>Event Severity.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host_id"></div>
+ <b>host_id</b>
+ <a class="ansibleOptionLink" href="#parameter-host_id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>HostName</li>
+ <li>SerialNum</li>
+ <li>AssertTag</li>
+ </ul>
+ </td>
+ <td>
+ <div>Host id.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-location"></div>
+ <b>location</b>
+ <a class="ansibleOptionLink" href="#parameter-location" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set the host location, can be NULL.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-os"></div>
+ <b>os</b>
+ <a class="ansibleOptionLink" href="#parameter-os" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set the host operating system, can be NULL.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-priv_password"></div>
+ <b>priv_password</b>
+ <a class="ansibleOptionLink" href="#parameter-priv_password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set the privacy password for the V3 trap.</div>
+ <div>The password is a string of 8 to 16 alphanumeric characters.</div>
+ <div>Required when <em>priv_protocol</em> is either <code>DES</code> or <code>AES</code>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-priv_protocol"></div>
+ <b>priv_protocol</b>
+ <a class="ansibleOptionLink" href="#parameter-priv_protocol" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>NONE</li>
+ <li>DES</li>
+ <li>AES</li>
+ </ul>
+ </td>
+ <td>
+ <div>Choose the privacy protocol for the V3 trap.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-system_id"></div>
+ <b>system_id</b>
+ <a class="ansibleOptionLink" href="#parameter-system_id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set the system ID, can be NULL.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-system_name"></div>
+ <b>system_name</b>
+ <a class="ansibleOptionLink" href="#parameter-system_name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set the system name, can be NULL.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-trap_port"></div>
+ <b>trap_port</b>
+ <a class="ansibleOptionLink" href="#parameter-trap_port" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set a port for the SNMP trap in the range of 1 to 65535.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-v3username"></div>
+ <b>v3username</b>
+ <a class="ansibleOptionLink" href="#parameter-v3username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set the username for the V3 trap.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-version"></div>
+ <b>version</b>
+ <a class="ansibleOptionLink" href="#parameter-version" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ <li>2</li>
+ <li>3</li>
+ </ul>
+ </td>
+ <td>
+ <div>SNMP trap version, 1 is v1, 2 is v2c(v2), 3 is v3, 0 is disable snmp trap.</div>
+ <div>Only the M6 model supports <code>0</code> Settings.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Trap test
+ hosts: ksmanage
+ no_log: true
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set snmp trap v2c"
+ kaytus.ksmanage.edit_snmp_trap:
+ version: 2
+ event_severity: "warning"
+ community: "test"
+ system_name: "ieisystem"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set snmp trap v3"
+ kaytus.ksmanage.edit_snmp_trap:
+ version: 3
+ event_severity: "all"
+ v3username: "ieisystem"
+ engine_id: "1234567890"
+ auth_protocol: "SHA"
+ auth_password: "12345678"
+ priv_protocol: "AES"
+ priv_password: "123454678"
+ trap_port: 162
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_threshold_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_threshold_module.rst new file mode 100644 index 000000000..b9aff43a0 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_threshold_module.rst @@ -0,0 +1,410 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_threshold_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_threshold -- Set threshold information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_threshold`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set threshold information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-lc"></div>
+ <b>lc</b>
+ <a class="ansibleOptionLink" href="#parameter-lc" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Lower critical threshold, should be integer.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-lnc"></div>
+ <b>lnc</b>
+ <a class="ansibleOptionLink" href="#parameter-lnc" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Lower non critical threshold, should be integer.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-lnr"></div>
+ <b>lnr</b>
+ <a class="ansibleOptionLink" href="#parameter-lnr" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Lower non recoverable threshold, should be integer.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-name"></div>
+ <b>name</b>
+ <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Sensor name.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-uc"></div>
+ <b>uc</b>
+ <a class="ansibleOptionLink" href="#parameter-uc" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Up critical threshold, should be integer.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-unc"></div>
+ <b>unc</b>
+ <a class="ansibleOptionLink" href="#parameter-unc" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Up non critical threshold, should be integer.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-unr"></div>
+ <b>unr</b>
+ <a class="ansibleOptionLink" href="#parameter-unr" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Up non recoverable threshold, should be integer.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Threshold test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set threshold information"
+ kaytus.ksmanage.edit_threshold:
+ name: "GPU1_Temp"
+ uc: 94
+ unc: 92
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_uid_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_uid_module.rst new file mode 100644 index 000000000..7dbc0d87e --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_uid_module.rst @@ -0,0 +1,343 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_uid_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_uid -- Set UID
++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_uid`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set UID on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-led"></div>
+ <b>led</b>
+ <a class="ansibleOptionLink" href="#parameter-led" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>on</li>
+ <li>off</li>
+ </ul>
+ </td>
+ <td>
+ <div>Turn on or turn off the led.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-time"></div>
+ <b>time</b>
+ <a class="ansibleOptionLink" href="#parameter-time" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set led blink time(second).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: UID test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set uid"
+ kaytus.ksmanage.edit_uid:
+ led: "on"
+ time: 10
+ provider: "{{ ksmanage }}"
+
+ - name: "Set uid"
+ kaytus.ksmanage.edit_uid:
+ led: "off"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_virtual_media_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_virtual_media_module.rst new file mode 100644 index 000000000..ae75b9534 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_virtual_media_module.rst @@ -0,0 +1,511 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_virtual_media_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_virtual_media -- Set virtual media
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_virtual_media`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set virtual media on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-local_media_support"></div>
+ <b>local_media_support</b>
+ <a class="ansibleOptionLink" href="#parameter-local_media_support" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>Enable</li>
+ <li>Disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>To enable or disable Local Media Support, check or uncheck the checkbox respectively.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-mount"></div>
+ <b>mount</b>
+ <a class="ansibleOptionLink" href="#parameter-mount" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>Enable</li>
+ <li>Disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Whether to mount virtual media.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-mount_type"></div>
+ <b>mount_type</b>
+ <a class="ansibleOptionLink" href="#parameter-mount_type" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>CD</li>
+ <li>FD</li>
+ <li>HD</li>
+ </ul>
+ </td>
+ <td>
+ <div>Virtual mount type.</div>
+ <div>The <em>FD</em> option is not supported in M6.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-remote_domain_name"></div>
+ <b>remote_domain_name</b>
+ <a class="ansibleOptionLink" href="#parameter-remote_domain_name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Remote Domain Name, Domain Name field is optional.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-remote_media_support"></div>
+ <b>remote_media_support</b>
+ <a class="ansibleOptionLink" href="#parameter-remote_media_support" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>Enable</li>
+ <li>Disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>To enable or disable Remote Media support, check or uncheck the checkbox respectively.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-remote_password"></div>
+ <b>remote_password</b>
+ <a class="ansibleOptionLink" href="#parameter-remote_password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Remote Password.</div>
+ <div>Required when <em>remote_share_type=cifs</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-remote_server_address"></div>
+ <b>remote_server_address</b>
+ <a class="ansibleOptionLink" href="#parameter-remote_server_address" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Address of the server where the remote media images are stored.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-remote_share_type"></div>
+ <b>remote_share_type</b>
+ <a class="ansibleOptionLink" href="#parameter-remote_share_type" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>nfs</li>
+ <li>cifs</li>
+ </ul>
+ </td>
+ <td>
+ <div>Share Type of the remote media server either NFS or Samba(CIFS).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-remote_source_path"></div>
+ <b>remote_source_path</b>
+ <a class="ansibleOptionLink" href="#parameter-remote_source_path" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Source path to the remote media images..</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-remote_user_name"></div>
+ <b>remote_user_name</b>
+ <a class="ansibleOptionLink" href="#parameter-remote_user_name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Remote User Name.</div>
+ <div>Required when <em>remote_share_type=cifs</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-same_settings"></div>
+ <b>same_settings</b>
+ <a class="ansibleOptionLink" href="#parameter-same_settings" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ </ul>
+ </td>
+ <td>
+ <div>Same settings with <em>CD</em>, 0 is No, 1 is Yes.</div>
+ <div>Required when <em>mount_type=0</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Media test
+ hosts: ksmanage
+ no_log: true
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set local media"
+ kaytus.ksmanage.edit_virtual_media:
+ local_media_support: "Enable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set remote media"
+ kaytus.ksmanage.edit_virtual_media:
+ remote_media_support: "Enable"
+ mount_type: 'CD'
+ same_settings: 0
+ mount: "Enable"
+ remote_server_address: "100.2.28.203"
+ remote_source_path: "/data/nfs/server/"
+ remote_share_type: "nfs"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/edit_vlan_module.rst b/ansible_collections/kaytus/ksmanage/docs/edit_vlan_module.rst new file mode 100644 index 000000000..de8697253 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/edit_vlan_module.rst @@ -0,0 +1,381 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.edit_vlan_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.edit_vlan -- Set vlan information
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.edit_vlan`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Set vlan information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-interface_name"></div>
+ <b>interface_name</b>
+ <a class="ansibleOptionLink" href="#parameter-interface_name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>eth0</li>
+ <li>eth1</li>
+ <li>bond0</li>
+ </ul>
+ </td>
+ <td>
+ <div>Set interface name. Select the LAN interface to be configured.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-vlan_id"></div>
+ <b>vlan_id</b>
+ <a class="ansibleOptionLink" href="#parameter-vlan_id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>The Identification for VLAN configuration(2-4094).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-vlan_priority"></div>
+ <b>vlan_priority</b>
+ <a class="ansibleOptionLink" href="#parameter-vlan_priority" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>The priority for VLAN configuration(1-7).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-vlan_status"></div>
+ <b>vlan_status</b>
+ <a class="ansibleOptionLink" href="#parameter-vlan_status" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Enable or disable vlan.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Vlan test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Set vlan information"
+ kaytus.ksmanage.edit_vlan:
+ interface_name: "eth0"
+ vlan_status: "disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set vlan information"
+ kaytus.ksmanage.edit_vlan:
+ interface_name: "eth0"
+ vlan_status: "enable"
+ vlan_id: 2
+ vlan_priority: 1
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/event_log_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/event_log_info_module.rst new file mode 100644 index 000000000..f044fa131 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/event_log_info_module.rst @@ -0,0 +1,358 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.event_log_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.event_log_info -- Get event log information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.event_log_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get event log information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-count"></div>
+ <b>count</b>
+ <a class="ansibleOptionLink" href="#parameter-count" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Get the most recent log of a specified number.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-event_file"></div>
+ <b>event_file</b>
+ <a class="ansibleOptionLink" href="#parameter-event_file" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Store logs to a file.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-log_time"></div>
+ <b>log_time</b>
+ <a class="ansibleOptionLink" href="#parameter-log_time" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Event log info test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get event log information"
+ kaytus.ksmanage.event_log_info:
+ log_time: "2020-06-01T12:30+08:00"
+ provider: "{{ ksmanage }}"
+
+ - name: "Get event log information"
+ kaytus.ksmanage.event_log_info:
+ count: 30
+ provider: "{{ ksmanage }}"
+
+ - name: "Get event log information"
+ kaytus.ksmanage.event_log_info:
+ event_file: "/home/wbs/wbs.log"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/event_log_policy_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/event_log_policy_info_module.rst new file mode 100644 index 000000000..15f9eabb4 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/event_log_policy_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.event_log_policy_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.event_log_policy_info -- Get event log policy information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.event_log_policy_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get event log policy information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Event log policy test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get event log policy information"
+ kaytus.ksmanage.event_log_policy_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/fan_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/fan_info_module.rst new file mode 100644 index 000000000..e6312749b --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/fan_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.fan_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.fan_info -- Get fan information
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.fan_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get fan information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Fan test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get fan information"
+ kaytus.ksmanage.fan_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/fru_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/fru_info_module.rst new file mode 100644 index 000000000..d6cb650ad --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/fru_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.fru_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.fru_info -- Get fru information
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.fru_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get fru information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Fru info test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get fru information"
+ kaytus.ksmanage.fru_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/fw_version_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/fw_version_info_module.rst new file mode 100644 index 000000000..249c9960a --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/fw_version_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.fw_version_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.fw_version_info -- Get firmware version information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.fw_version_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get firmware version information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Firmware version test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get firmware version information"
+ kaytus.ksmanage.fw_version_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/gpu_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/gpu_info_module.rst new file mode 100644 index 000000000..cbef0cd68 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/gpu_info_module.rst @@ -0,0 +1,303 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.gpu_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.gpu_info -- Get GPU information
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.gpu_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get GPU information on kaytus Server.
+- Only the M6 models support this feature.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: GPU test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get gpu information"
+ kaytus.ksmanage.gpu_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/hard_disk_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/hard_disk_info_module.rst new file mode 100644 index 000000000..0e3c61bdb --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/hard_disk_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.hard_disk_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.hard_disk_info -- Get hard disk information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.hard_disk_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get hard disk information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Hard disk test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get hard disk information"
+ kaytus.ksmanage.hard_disk_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/hba_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/hba_info_module.rst new file mode 100644 index 000000000..da2f90f34 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/hba_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.hba_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.hba_info -- Get CPU information
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.hba_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get HBA information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: HBA test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get hba information"
+ kaytus.ksmanage.hba_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/index.rst b/ansible_collections/kaytus/ksmanage/docs/index.rst new file mode 100644 index 000000000..5f7e2fcf8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/index.rst @@ -0,0 +1,149 @@ +:orphan:
+
+.. _plugins_in_kaytus.ksmanage:
+
+Plugin Index
+============
+
+These are the plugins in the kaytus.ksmanage collection
+
+.. toctree::
+ :maxdepth: 1
+
+
+Modules
+-------
+
+* :ref:`ad_group <ansible_collections.kaytus.ksmanage.ad_group_module>` -- Manage active directory group information
+* :ref:`ad_group_info <ansible_collections.kaytus.ksmanage.ad_group_info_module>` -- Get active directory group information
+* :ref:`ad_info <ansible_collections.kaytus.ksmanage.ad_info_module>` -- Get active directory information
+* :ref:`adapter_info <ansible_collections.kaytus.ksmanage.adapter_info_module>` -- Get adapter information
+* :ref:`add_ldisk <ansible_collections.kaytus.ksmanage.add_ldisk_module>` -- Create logical disk
+* :ref:`alert_policy_info <ansible_collections.kaytus.ksmanage.alert_policy_info_module>` -- Get alert policy
+* :ref:`audit_log_info <ansible_collections.kaytus.ksmanage.audit_log_info_module>` -- Get BMC audit log information
+* :ref:`auto_capture_info <ansible_collections.kaytus.ksmanage.auto_capture_info_module>` -- Get auto capture screen information
+* :ref:`backplane_info <ansible_collections.kaytus.ksmanage.backplane_info_module>` -- Get disk backplane information
+* :ref:`backup <ansible_collections.kaytus.ksmanage.backup_module>` -- Backup server settings
+* :ref:`bios_export <ansible_collections.kaytus.ksmanage.bios_export_module>` -- Export BIOS config
+* :ref:`bios_import <ansible_collections.kaytus.ksmanage.bios_import_module>` -- Import BIOS config
+* :ref:`bios_info <ansible_collections.kaytus.ksmanage.bios_info_module>` -- Get BIOS setup
+* :ref:`bmc_info <ansible_collections.kaytus.ksmanage.bmc_info_module>` -- Get BMC information
+* :ref:`boot_image_info <ansible_collections.kaytus.ksmanage.boot_image_info_module>` -- Get bmc boot image information
+* :ref:`boot_option_info <ansible_collections.kaytus.ksmanage.boot_option_info_module>` -- Get BIOS boot options
+* :ref:`clear_audit_log <ansible_collections.kaytus.ksmanage.clear_audit_log_module>` -- Clear BMC audit log
+* :ref:`clear_event_log <ansible_collections.kaytus.ksmanage.clear_event_log_module>` -- Clear event log
+* :ref:`clear_system_log <ansible_collections.kaytus.ksmanage.clear_system_log_module>` -- Clear BMC system log
+* :ref:`collect_blackbox <ansible_collections.kaytus.ksmanage.collect_blackbox_module>` -- Collect blackbox log
+* :ref:`collect_log <ansible_collections.kaytus.ksmanage.collect_log_module>` -- Collect logs
+* :ref:`connect_media_info <ansible_collections.kaytus.ksmanage.connect_media_info_module>` -- Get remote images redirection information
+* :ref:`cpu_info <ansible_collections.kaytus.ksmanage.cpu_info_module>` -- Get CPU information
+* :ref:`del_session <ansible_collections.kaytus.ksmanage.del_session_module>` -- Delete session
+* :ref:`dns_info <ansible_collections.kaytus.ksmanage.dns_info_module>` -- Get dns information
+* :ref:`download_auto_screenshot <ansible_collections.kaytus.ksmanage.download_auto_screenshot_module>` -- Download auto screenshots
+* :ref:`download_manual_screenshot <ansible_collections.kaytus.ksmanage.download_manual_screenshot_module>` -- Download manual screenshots
+* :ref:`edit_ad <ansible_collections.kaytus.ksmanage.edit_ad_module>` -- Set active directory information
+* :ref:`edit_alert_policy <ansible_collections.kaytus.ksmanage.edit_alert_policy_module>` -- Set alert policy
+* :ref:`edit_auto_capture <ansible_collections.kaytus.ksmanage.edit_auto_capture_module>` -- Set auto capture screen
+* :ref:`edit_bios <ansible_collections.kaytus.ksmanage.edit_bios_module>` -- Set BIOS setup attributes
+* :ref:`edit_boot_image <ansible_collections.kaytus.ksmanage.edit_boot_image_module>` -- Set bmc boot image
+* :ref:`edit_boot_option <ansible_collections.kaytus.ksmanage.edit_boot_option_module>` -- Set BIOS boot options
+* :ref:`edit_connect_media <ansible_collections.kaytus.ksmanage.edit_connect_media_module>` -- Start/Stop virtual media Image
+* :ref:`edit_dns <ansible_collections.kaytus.ksmanage.edit_dns_module>` -- Set dns information
+* :ref:`edit_event_log_policy <ansible_collections.kaytus.ksmanage.edit_event_log_policy_module>` -- Set event log policy
+* :ref:`edit_fan <ansible_collections.kaytus.ksmanage.edit_fan_module>` -- Set fan information
+* :ref:`edit_fru <ansible_collections.kaytus.ksmanage.edit_fru_module>` -- Set fru settings
+* :ref:`edit_ipv4 <ansible_collections.kaytus.ksmanage.edit_ipv4_module>` -- Set ipv4 information
+* :ref:`edit_ipv6 <ansible_collections.kaytus.ksmanage.edit_ipv6_module>` -- Set ipv6 information
+* :ref:`edit_kvm <ansible_collections.kaytus.ksmanage.edit_kvm_module>` -- Set KVM
+* :ref:`edit_ldap <ansible_collections.kaytus.ksmanage.edit_ldap_module>` -- Set ldap information
+* :ref:`edit_ldisk <ansible_collections.kaytus.ksmanage.edit_ldisk_module>` -- Set logical disk
+* :ref:`edit_log_setting <ansible_collections.kaytus.ksmanage.edit_log_setting_module>` -- Set bmc system and audit log setting
+* :ref:`edit_m6_log_setting <ansible_collections.kaytus.ksmanage.edit_m6_log_setting_module>` -- Set bmc system and audit log setting
+* :ref:`edit_manual_capture <ansible_collections.kaytus.ksmanage.edit_manual_capture_module>` -- Set manual capture screen
+* :ref:`edit_media_instance <ansible_collections.kaytus.ksmanage.edit_media_instance_module>` -- Set Virtual Media Instance
+* :ref:`edit_ncsi <ansible_collections.kaytus.ksmanage.edit_ncsi_module>` -- Set ncsi information
+* :ref:`edit_network <ansible_collections.kaytus.ksmanage.edit_network_module>` -- Set network information
+* :ref:`edit_network_bond <ansible_collections.kaytus.ksmanage.edit_network_bond_module>` -- Set network bond
+* :ref:`edit_network_link <ansible_collections.kaytus.ksmanage.edit_network_link_module>` -- Set network link
+* :ref:`edit_ntp <ansible_collections.kaytus.ksmanage.edit_ntp_module>` -- Set NTP
+* :ref:`edit_pdisk <ansible_collections.kaytus.ksmanage.edit_pdisk_module>` -- Set physical disk
+* :ref:`edit_power_budget <ansible_collections.kaytus.ksmanage.edit_power_budget_module>` -- Set power budget information
+* :ref:`edit_power_restore <ansible_collections.kaytus.ksmanage.edit_power_restore_module>` -- Set power restore information
+* :ref:`edit_power_status <ansible_collections.kaytus.ksmanage.edit_power_status_module>` -- Set power status information
+* :ref:`edit_preserve_config <ansible_collections.kaytus.ksmanage.edit_preserve_config_module>` -- Set preserve config
+* :ref:`edit_psu_config <ansible_collections.kaytus.ksmanage.edit_psu_config_module>` -- Set psu config information
+* :ref:`edit_psu_peak <ansible_collections.kaytus.ksmanage.edit_psu_peak_module>` -- Set psu peak information
+* :ref:`edit_restore_factory_default <ansible_collections.kaytus.ksmanage.edit_restore_factory_default_module>` -- Set preserver config
+* :ref:`edit_service <ansible_collections.kaytus.ksmanage.edit_service_module>` -- Set service settings
+* :ref:`edit_smtp <ansible_collections.kaytus.ksmanage.edit_smtp_module>` -- Set SMTP information
+* :ref:`edit_smtp_com <ansible_collections.kaytus.ksmanage.edit_smtp_com_module>` -- Set SMTP information
+* :ref:`edit_smtp_dest <ansible_collections.kaytus.ksmanage.edit_smtp_dest_module>` -- Set SMTP information
+* :ref:`edit_snmp <ansible_collections.kaytus.ksmanage.edit_snmp_module>` -- Set snmp
+* :ref:`edit_snmp_trap <ansible_collections.kaytus.ksmanage.edit_snmp_trap_module>` -- Set snmp trap
+* :ref:`edit_threshold <ansible_collections.kaytus.ksmanage.edit_threshold_module>` -- Set threshold information
+* :ref:`edit_uid <ansible_collections.kaytus.ksmanage.edit_uid_module>` -- Set UID
+* :ref:`edit_virtual_media <ansible_collections.kaytus.ksmanage.edit_virtual_media_module>` -- Set virtual media
+* :ref:`edit_vlan <ansible_collections.kaytus.ksmanage.edit_vlan_module>` -- Set vlan information
+* :ref:`event_log_info <ansible_collections.kaytus.ksmanage.event_log_info_module>` -- Get event log information
+* :ref:`event_log_policy_info <ansible_collections.kaytus.ksmanage.event_log_policy_info_module>` -- Get event log policy information
+* :ref:`fan_info <ansible_collections.kaytus.ksmanage.fan_info_module>` -- Get fan information
+* :ref:`fru_info <ansible_collections.kaytus.ksmanage.fru_info_module>` -- Get fru information
+* :ref:`fw_version_info <ansible_collections.kaytus.ksmanage.fw_version_info_module>` -- Get firmware version information
+* :ref:`gpu_info <ansible_collections.kaytus.ksmanage.gpu_info_module>` -- Get GPU information
+* :ref:`hard_disk_info <ansible_collections.kaytus.ksmanage.hard_disk_info_module>` -- Get hard disk information
+* :ref:`hba_info <ansible_collections.kaytus.ksmanage.hba_info_module>` -- Get CPU information
+* :ref:`kvm_info <ansible_collections.kaytus.ksmanage.kvm_info_module>` -- Get KVM information
+* :ref:`ldap_group <ansible_collections.kaytus.ksmanage.ldap_group_module>` -- Manage ldap group information
+* :ref:`ldap_group_info <ansible_collections.kaytus.ksmanage.ldap_group_info_module>` -- Get ldap group information
+* :ref:`ldap_info <ansible_collections.kaytus.ksmanage.ldap_info_module>` -- Get ldap information
+* :ref:`ldisk_info <ansible_collections.kaytus.ksmanage.ldisk_info_module>` -- Get logical disks information
+* :ref:`log_setting_info <ansible_collections.kaytus.ksmanage.log_setting_info_module>` -- Get bmc log setting information
+* :ref:`media_instance_info <ansible_collections.kaytus.ksmanage.media_instance_info_module>` -- Get Virtual Media Instance information
+* :ref:`mem_info <ansible_collections.kaytus.ksmanage.mem_info_module>` -- Get memory information
+* :ref:`ncsi_info <ansible_collections.kaytus.ksmanage.ncsi_info_module>` -- Get ncsi information
+* :ref:`network_bond_info <ansible_collections.kaytus.ksmanage.network_bond_info_module>` -- Get network bond information
+* :ref:`network_info <ansible_collections.kaytus.ksmanage.network_info_module>` -- Get network information
+* :ref:`network_link_info <ansible_collections.kaytus.ksmanage.network_link_info_module>` -- Get network link information
+* :ref:`ntp_info <ansible_collections.kaytus.ksmanage.ntp_info_module>` -- Get NTP information
+* :ref:`onboard_disk_info <ansible_collections.kaytus.ksmanage.onboard_disk_info_module>` -- Get onboard disks information
+* :ref:`pcie_info <ansible_collections.kaytus.ksmanage.pcie_info_module>` -- Get PCIE information
+* :ref:`pdisk_info <ansible_collections.kaytus.ksmanage.pdisk_info_module>` -- Get physical disks information
+* :ref:`power_budget_info <ansible_collections.kaytus.ksmanage.power_budget_info_module>` -- Get power budget information
+* :ref:`power_consumption_info <ansible_collections.kaytus.ksmanage.power_consumption_info_module>` -- Get power consumption information
+* :ref:`power_restore_info <ansible_collections.kaytus.ksmanage.power_restore_info_module>` -- Get power restore information
+* :ref:`power_status_info <ansible_collections.kaytus.ksmanage.power_status_info_module>` -- Get power status information
+* :ref:`preserve_config_info <ansible_collections.kaytus.ksmanage.preserve_config_info_module>` -- Get preserve config information
+* :ref:`psu_config_info <ansible_collections.kaytus.ksmanage.psu_config_info_module>` -- Get psu config information
+* :ref:`psu_info <ansible_collections.kaytus.ksmanage.psu_info_module>` -- Get psu information
+* :ref:`psu_peak_info <ansible_collections.kaytus.ksmanage.psu_peak_info_module>` -- Get psu peak information
+* :ref:`raid_info <ansible_collections.kaytus.ksmanage.raid_info_module>` -- Get RAID/HBA card and controller information
+* :ref:`reset_bmc <ansible_collections.kaytus.ksmanage.reset_bmc_module>` -- BMC reset
+* :ref:`reset_kvm <ansible_collections.kaytus.ksmanage.reset_kvm_module>` -- KVM reset
+* :ref:`restore <ansible_collections.kaytus.ksmanage.restore_module>` -- Restore server settings
+* :ref:`self_test_info <ansible_collections.kaytus.ksmanage.self_test_info_module>` -- Get self test information
+* :ref:`sensor_info <ansible_collections.kaytus.ksmanage.sensor_info_module>` -- Get sensor information
+* :ref:`server_info <ansible_collections.kaytus.ksmanage.server_info_module>` -- Get server status information
+* :ref:`service_info <ansible_collections.kaytus.ksmanage.service_info_module>` -- Get service information
+* :ref:`session_info <ansible_collections.kaytus.ksmanage.session_info_module>` -- Get online session information
+* :ref:`smtp_info <ansible_collections.kaytus.ksmanage.smtp_info_module>` -- Get SMTP information
+* :ref:`snmp_info <ansible_collections.kaytus.ksmanage.snmp_info_module>` -- Get snmp get/set information
+* :ref:`snmp_trap_info <ansible_collections.kaytus.ksmanage.snmp_trap_info_module>` -- Get snmp trap information
+* :ref:`support_info <ansible_collections.kaytus.ksmanage.support_info_module>` -- Get support information
+* :ref:`system_log_info <ansible_collections.kaytus.ksmanage.system_log_info_module>` -- Get BMC system log information
+* :ref:`temp_info <ansible_collections.kaytus.ksmanage.temp_info_module>` -- Get temp information
+* :ref:`threshold_info <ansible_collections.kaytus.ksmanage.threshold_info_module>` -- Get threshold information
+* :ref:`uid_info <ansible_collections.kaytus.ksmanage.uid_info_module>` -- Get UID information
+* :ref:`update_cpld <ansible_collections.kaytus.ksmanage.update_cpld_module>` -- Update CPLD
+* :ref:`update_fw <ansible_collections.kaytus.ksmanage.update_fw_module>` -- Update firmware
+* :ref:`update_psu <ansible_collections.kaytus.ksmanage.update_psu_module>` -- Update PSU
+* :ref:`user <ansible_collections.kaytus.ksmanage.user_module>` -- Manage user
+* :ref:`user_group <ansible_collections.kaytus.ksmanage.user_group_module>` -- Manage user group
+* :ref:`user_group_info <ansible_collections.kaytus.ksmanage.user_group_info_module>` -- Get user group information
+* :ref:`user_info <ansible_collections.kaytus.ksmanage.user_info_module>` -- Get user information
+* :ref:`virtual_media_info <ansible_collections.kaytus.ksmanage.virtual_media_info_module>` -- Get Virtual Media information
+* :ref:`volt_info <ansible_collections.kaytus.ksmanage.volt_info_module>` -- Get volt information
+
+
+.. seealso::
+
+ List of :ref:`collections <list_of_collections>` with docs hosted here.
\ No newline at end of file diff --git a/ansible_collections/kaytus/ksmanage/docs/kvm_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/kvm_info_module.rst new file mode 100644 index 000000000..d49a4419d --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/kvm_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.kvm_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.kvm_info -- Get KVM information
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.kvm_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get KVM information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: KVM test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get KVM information"
+ kaytus.ksmanage.kvm_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/ldap_group_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/ldap_group_info_module.rst new file mode 100644 index 000000000..b9547b613 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ldap_group_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.ldap_group_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.ldap_group_info -- Get ldap group information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.ldap_group_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get ldap group information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Ldap group test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get ldap group information"
+ kaytus.ksmanage.ldap_group_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/ldap_group_module.rst b/ansible_collections/kaytus/ksmanage/docs/ldap_group_module.rst new file mode 100644 index 000000000..11bb506fe --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ldap_group_module.rst @@ -0,0 +1,431 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.ldap_group_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.ldap_group -- Manage ldap group information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.ldap_group`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Manage ldap group information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-base"></div>
+ <b>base</b>
+ <a class="ansibleOptionLink" href="#parameter-base" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Search Base.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-kvm"></div>
+ <b>kvm</b>
+ <a class="ansibleOptionLink" href="#parameter-kvm" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Kvm privilege.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-name"></div>
+ <b>name</b>
+ <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Group name.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-pri"></div>
+ <b>pri</b>
+ <a class="ansibleOptionLink" href="#parameter-pri" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>administrator</li>
+ <li>user</li>
+ <li>operator</li>
+ <li>oem</li>
+ <li>none</li>
+ </ul>
+ </td>
+ <td>
+ <div>Group privilege.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li><div style="color: blue"><b>present</b> ←</div></li>
+ <li>absent</li>
+ </ul>
+ </td>
+ <td>
+ <div>Whether the ldap group should exist or not, taking action if the state is different from what is stated.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-vm"></div>
+ <b>vm</b>
+ <a class="ansibleOptionLink" href="#parameter-vm" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Vmedia privilege.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Ldap group test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Add ldap group information"
+ kaytus.ksmanage.ldap_group:
+ state: "present"
+ name: "wbs"
+ base: "cn=manager"
+ pri: "administrator"
+ kvm: "enable"
+ vm: "disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set ldap group information"
+ kaytus.ksmanage.ldap_group:
+ state: "present"
+ name: "wbs"
+ pri: "user"
+ kvm: "disable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Delete ldap group information"
+ kaytus.ksmanage.ldap_group:
+ state: "absent"
+ name: "wbs"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/ldap_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/ldap_info_module.rst new file mode 100644 index 000000000..ff3930935 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ldap_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.ldap_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.ldap_info -- Get ldap information
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.ldap_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get ldap information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Ldap test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get ldap information"
+ kaytus.ksmanage.ldap_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/ldisk_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/ldisk_info_module.rst new file mode 100644 index 000000000..5bdc084f4 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ldisk_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.ldisk_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.ldisk_info -- Get logical disks information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.ldisk_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get logical disks information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Ldisk test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get logical disks information"
+ kaytus.ksmanage.ldisk_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/log_setting_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/log_setting_info_module.rst new file mode 100644 index 000000000..8ee414a37 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/log_setting_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.log_setting_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.log_setting_info -- Get bmc log setting information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.log_setting_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get bmc log setting information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Bmc log setting test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get bmc log setting information"
+ kaytus.ksmanage.log_setting_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/media_instance_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/media_instance_info_module.rst new file mode 100644 index 000000000..526996e24 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/media_instance_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.media_instance_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.media_instance_info -- Get Virtual Media Instance information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.media_instance_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get Virtual Media Instance information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Media instance test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get Virtual Media Instance information"
+ kaytus.ksmanage.media_instance_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/mem_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/mem_info_module.rst new file mode 100644 index 000000000..2eec9089b --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/mem_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.mem_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.mem_info -- Get memory information
+++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.mem_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get memory information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Memory test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get memory information"
+ kaytus.ksmanage.mem_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/ncsi_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/ncsi_info_module.rst new file mode 100644 index 000000000..02f5968e3 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ncsi_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.ncsi_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.ncsi_info -- Get ncsi information
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.ncsi_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get ncsi information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: NCSI test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get ncsi information"
+ kaytus.ksmanage.ncsi_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/network_bond_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/network_bond_info_module.rst new file mode 100644 index 000000000..982b0cd3a --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/network_bond_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.network_bond_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.network_bond_info -- Get network bond information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.network_bond_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get network bond information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Bond test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get network bond information"
+ kaytus.ksmanage.network_bond_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/network_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/network_info_module.rst new file mode 100644 index 000000000..18f60a34e --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/network_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.network_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.network_info -- Get network information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.network_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get network information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Network test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get network information"
+ kaytus.ksmanage.network_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/network_link_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/network_link_info_module.rst new file mode 100644 index 000000000..1eee30569 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/network_link_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.network_link_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.network_link_info -- Get network link information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.network_link_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get network link information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Link test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get network link information"
+ kaytus.ksmanage.network_link_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/ntp_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/ntp_info_module.rst new file mode 100644 index 000000000..3afae3bb7 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/ntp_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.ntp_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.ntp_info -- Get NTP information
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.ntp_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get NTP information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: NTP test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get ntp information"
+ kaytus.ksmanage.ntp_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/onboard_disk_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/onboard_disk_info_module.rst new file mode 100644 index 000000000..d1b0492f4 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/onboard_disk_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.onboard_disk_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.onboard_disk_info -- Get onboard disks information
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.onboard_disk_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get onboard disks information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Onboard test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get onboard disks information"
+ kaytus.ksmanage.onboard_disk_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/pcie_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/pcie_info_module.rst new file mode 100644 index 000000000..703295de1 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/pcie_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.pcie_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.pcie_info -- Get PCIE information
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.pcie_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get PCIE information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: PCIE test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get PCIE information"
+ kaytus.ksmanage.pcie_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/pdisk_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/pdisk_info_module.rst new file mode 100644 index 000000000..833e99678 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/pdisk_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.pdisk_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.pdisk_info -- Get physical disks information
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.pdisk_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get physical disks information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Pdisk test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get physical disks information"
+ kaytus.ksmanage.pdisk_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/power_budget_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/power_budget_info_module.rst new file mode 100644 index 000000000..f5b67925a --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/power_budget_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.power_budget_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.power_budget_info -- Get power budget information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.power_budget_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get power budget information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Power budget test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get power budget information"
+ kaytus.ksmanage.power_budget_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/power_consumption_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/power_consumption_info_module.rst new file mode 100644 index 000000000..93100b023 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/power_consumption_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.power_consumption_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.power_consumption_info -- Get power consumption information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.power_consumption_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get power consumption information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Power consumption test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get power consumption information"
+ kaytus.ksmanage.power_consumption_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/power_restore_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/power_restore_info_module.rst new file mode 100644 index 000000000..4e2cef249 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/power_restore_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.power_restore_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.power_restore_info -- Get power restore information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.power_restore_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get power restore information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Power restore test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get power restore information"
+ kaytus.ksmanage.power_restore_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/power_status_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/power_status_info_module.rst new file mode 100644 index 000000000..ca0ada784 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/power_status_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.power_status_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.power_status_info -- Get power status information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.power_status_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get power status information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Power status test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get power status information"
+ kaytus.ksmanage.power_status_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/preserve_config_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/preserve_config_info_module.rst new file mode 100644 index 000000000..4355044d9 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/preserve_config_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.preserve_config_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.preserve_config_info -- Get preserve config information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.preserve_config_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get preserve config information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Preserve test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get preserve config information"
+ kaytus.ksmanage.preserve_config_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/psu_config_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/psu_config_info_module.rst new file mode 100644 index 000000000..edd7f62d1 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/psu_config_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.psu_config_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.psu_config_info -- Get psu config information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.psu_config_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get psu config information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Psu config test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get psu config information"
+ kaytus.ksmanage.psu_config_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/psu_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/psu_info_module.rst new file mode 100644 index 000000000..e38da43b9 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/psu_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.psu_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.psu_info -- Get psu information
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.psu_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get psu information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Psu test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get psu information"
+ kaytus.ksmanage.psu_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/psu_peak_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/psu_peak_info_module.rst new file mode 100644 index 000000000..01872cdb8 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/psu_peak_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.psu_peak_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.psu_peak_info -- Get psu peak information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.psu_peak_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get psu peak information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Psu peak test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get psu peak information"
+ kaytus.ksmanage.psu_peak_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/raid_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/raid_info_module.rst new file mode 100644 index 000000000..83dc91897 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/raid_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.raid_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.raid_info -- Get RAID/HBA card and controller information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.raid_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get RAID/HBA card and controller information information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Raid test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get raid information"
+ kaytus.ksmanage.raid_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/reset_bmc_module.rst b/ansible_collections/kaytus/ksmanage/docs/reset_bmc_module.rst new file mode 100644 index 000000000..538de2f47 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/reset_bmc_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.reset_bmc_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.reset_bmc -- BMC reset
+++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.reset_bmc`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- BMC reset on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Reset bmc test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Reset bmc"
+ kaytus.ksmanage.reset_bmc:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/reset_kvm_module.rst b/ansible_collections/kaytus/ksmanage/docs/reset_kvm_module.rst new file mode 100644 index 000000000..5feacf138 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/reset_kvm_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.reset_kvm_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.reset_kvm -- KVM reset
+++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.reset_kvm`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- KVM reset on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Reset kvm test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Reset kvm"
+ kaytus.ksmanage.reset_kvm:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/restore_module.rst b/ansible_collections/kaytus/ksmanage/docs/restore_module.rst new file mode 100644 index 000000000..126a6ee82 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/restore_module.rst @@ -0,0 +1,348 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.restore_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.restore -- Restore server settings
+++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.restore`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Restore server settings on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-bak_file"></div>
+ <b>bak_file</b>
+ <a class="ansibleOptionLink" href="#parameter-bak_file" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Select backup file or bak folder.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-item"></div>
+ <b>item</b>
+ <a class="ansibleOptionLink" href="#parameter-item" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>all</li>
+ <li>network</li>
+ <li>dns</li>
+ <li>service</li>
+ <li>ntp</li>
+ <li>smtp</li>
+ <li>snmptrap</li>
+ <li>ad</li>
+ <li>ldap</li>
+ <li>user</li>
+ <li>bios</li>
+ </ul>
+ </td>
+ <td>
+ <div>Select export item.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Restore test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Restore server settings"
+ kaytus.ksmanage.restore:
+ bak_file: "/home/wbs/backfile"
+ item: "all"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/self_test_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/self_test_info_module.rst new file mode 100644 index 000000000..1d862de9b --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/self_test_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.self_test_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.self_test_info -- Get self test information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.self_test_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get self test information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Self test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get self test information"
+ kaytus.ksmanage.self_test_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/sensor_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/sensor_info_module.rst new file mode 100644 index 000000000..23e916893 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/sensor_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.sensor_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.sensor_info -- Get sensor information
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.sensor_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get sensor information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Sensor test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get sensor information"
+ kaytus.ksmanage.sensor_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/server_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/server_info_module.rst new file mode 100644 index 000000000..00af7471a --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/server_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.server_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.server_info -- Get server status information
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.server_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get server status information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Server test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get server status information"
+ kaytus.ksmanage.server_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/service_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/service_info_module.rst new file mode 100644 index 000000000..044882ccb --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/service_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.service_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.service_info -- Get service information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.service_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get service information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Service info test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get service information"
+ kaytus.ksmanage.service_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/session_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/session_info_module.rst new file mode 100644 index 000000000..bbbfc7b83 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/session_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.session_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.session_info -- Get online session information
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.session_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get online session information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Session test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get session information"
+ kaytus.ksmanage.session_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/smtp_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/smtp_info_module.rst new file mode 100644 index 000000000..e60b7590d --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/smtp_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.smtp_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.smtp_info -- Get SMTP information
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.smtp_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get SMTP information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Smtp test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get smtp information"
+ kaytus.ksmanage.smtp_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/snmp_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/snmp_info_module.rst new file mode 100644 index 000000000..10fdfeebc --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/snmp_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.snmp_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.snmp_info -- Get snmp get/set information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.snmp_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get snmp get/set information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Snmp test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get snmp get/set information"
+ kaytus.ksmanage.snmp_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/snmp_trap_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/snmp_trap_info_module.rst new file mode 100644 index 000000000..b20b0c406 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/snmp_trap_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.snmp_trap_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.snmp_trap_info -- Get snmp trap information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.snmp_trap_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get snmp trap information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Trap test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get snmp trap information"
+ kaytus.ksmanage.snmp_trap_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/support_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/support_info_module.rst new file mode 100644 index 000000000..48f5b4e19 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/support_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.support_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.support_info -- Get support information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.support_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get the kaytus Server support list information.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Support list test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get support information"
+ kaytus.ksmanage.support_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/system_log_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/system_log_info_module.rst new file mode 100644 index 000000000..f32d734bd --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/system_log_info_module.rst @@ -0,0 +1,384 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.system_log_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.system_log_info -- Get BMC system log information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.system_log_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get BMC system log information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-count"></div>
+ <b>count</b>
+ <a class="ansibleOptionLink" href="#parameter-count" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Get the most recent log of a specified number.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-level"></div>
+ <b>level</b>
+ <a class="ansibleOptionLink" href="#parameter-level" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li><div style="color: blue"><b>alert</b> ←</div></li>
+ <li>critical</li>
+ <li>error</li>
+ <li>notice</li>
+ <li>warning</li>
+ <li>debug</li>
+ <li>emergency</li>
+ <li>info</li>
+ </ul>
+ </td>
+ <td>
+ <div>Log level.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-log_time"></div>
+ <b>log_time</b>
+ <a class="ansibleOptionLink" href="#parameter-log_time" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-system_file"></div>
+ <b>system_file</b>
+ <a class="ansibleOptionLink" href="#parameter-system_file" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Store logs to a file.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Bmc system log info test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get bmc system log information"
+ kaytus.ksmanage.system_log_info:
+ level: "alert"
+ log_time: "2020-06-01T12:30+08:00"
+ provider: "{{ ksmanage }}"
+
+ - name: "Get bmc system log information"
+ kaytus.ksmanage.system_log_info:
+ count: 30
+ provider: "{{ ksmanage }}"
+
+ - name: "Get bmc system log information"
+ kaytus.ksmanage.system_log_info:
+ system_file: "/home/wbs/wbs.log"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/temp_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/temp_info_module.rst new file mode 100644 index 000000000..5e002df4f --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/temp_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.temp_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.temp_info -- Get temp information
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.temp_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get temp information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Temp test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get temp information"
+ kaytus.ksmanage.temp_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/threshold_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/threshold_info_module.rst new file mode 100644 index 000000000..0b8d36530 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/threshold_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.threshold_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.threshold_info -- Get threshold information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.threshold_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get threshold information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Threshold test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get threshold information"
+ kaytus.ksmanage.threshold_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/uid_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/uid_info_module.rst new file mode 100644 index 000000000..cdd209e86 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/uid_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.uid_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.uid_info -- Get UID information
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.uid_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get UID information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: UID test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get UID information"
+ kaytus.ksmanage.uid_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/update_cpld_module.rst b/ansible_collections/kaytus/ksmanage/docs/update_cpld_module.rst new file mode 100644 index 000000000..9bff7c976 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/update_cpld_module.rst @@ -0,0 +1,362 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.update_cpld_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.update_cpld -- Update CPLD
+++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.update_cpld`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Update CPLD on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-file_url"></div>
+ <b>file_url</b>
+ <a class="ansibleOptionLink" href="#parameter-file_url" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>CPLD image file path.</div>
+ <div>Required when <em>list=False</em>.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-id"></div>
+ <b>id</b>
+ <a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>CPLD id.</div>
+ <div>Required when <em>list=False</em>.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-list"></div>
+ <b>list</b>
+ <a class="ansibleOptionLink" href="#parameter-list" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li><div style="color: blue"><b>no</b> ←</div></li>
+ <li>yes</li>
+ </ul>
+ </td>
+ <td>
+ <div>Get cpld list.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: CPLD test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get cpld list"
+ kaytus.ksmanage.update_cpld:
+ list: True
+ provider: "{{ ksmanage }}"
+
+ - name: "Update cpld"
+ update_cpld:
+ id: 1
+ file_url: "home/wbs/raw.bin"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/update_fw_module.rst b/ansible_collections/kaytus/ksmanage/docs/update_fw_module.rst new file mode 100644 index 000000000..be678438f --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/update_fw_module.rst @@ -0,0 +1,426 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.update_fw_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.update_fw -- Update firmware
+++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.update_fw`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Update firmware on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-dual_image"></div>
+ <b>dual_image</b>
+ <a class="ansibleOptionLink" href="#parameter-dual_image" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>single</li>
+ <li><div style="color: blue"><b>dual</b> ←</div></li>
+ </ul>
+ </td>
+ <td>
+ <div>Update dual image(default) or not.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-has_me"></div>
+ <b>has_me</b>
+ <a class="ansibleOptionLink" href="#parameter-has_me" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ </ul>
+ <b>Default:</b><br/><div style="color: blue">1</div>
+ </td>
+ <td>
+ <div>Update me or not when update bios, only work in INTEL platform, 0-no, 1-yes.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-mode"></div>
+ <b>mode</b>
+ <a class="ansibleOptionLink" href="#parameter-mode" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li><div style="color: blue"><b>Auto</b> ←</div></li>
+ <li>Manual</li>
+ </ul>
+ </td>
+ <td>
+ <div>Active mode, Manual or Auto(default).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-over_ride"></div>
+ <b>over_ride</b>
+ <a class="ansibleOptionLink" href="#parameter-over_ride" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>0</li>
+ <li>1</li>
+ </ul>
+ <b>Default:</b><br/><div style="color: blue">0</div>
+ </td>
+ <td>
+ <div>Reserve Configurations, 0-reserve, 1-override.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-type"></div>
+ <b>type</b>
+ <a class="ansibleOptionLink" href="#parameter-type" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>BMC</li>
+ <li>BIOS</li>
+ </ul>
+ </td>
+ <td>
+ <div>Firmware type.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-url"></div>
+ <b>url</b>
+ <a class="ansibleOptionLink" href="#parameter-url" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Firmware image url.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Update fw test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "update bios"
+ kaytus.ksmanage.update_fw:
+ url: "/home/wbs/SA5112M5_BIOS_4.1.8_Standard_20200117.bin"
+ type: "BIOS"
+ provider: "{{ ksmanage }}"
+
+ - name: "update bmc"
+ kaytus.ksmanage.update_fw:
+ url: "/home/wbs/SA5112M5_BMC_4.17.7_Standard_20200430"
+ mode: "Auto"
+ type: "BMC"
+ dual_image: "dual"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/update_psu_module.rst b/ansible_collections/kaytus/ksmanage/docs/update_psu_module.rst new file mode 100644 index 000000000..401f33041 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/update_psu_module.rst @@ -0,0 +1,338 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.update_psu_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.update_psu -- Update PSU
+++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.update_psu`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Update psu on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-mode"></div>
+ <b>mode</b>
+ <a class="ansibleOptionLink" href="#parameter-mode" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li><div style="color: blue"><b>Auto</b> ←</div></li>
+ <li>Manual</li>
+ </ul>
+ </td>
+ <td>
+ <div>Server Auto Reset Option, Manual or Auto(default).</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-url"></div>
+ <b>url</b>
+ <a class="ansibleOptionLink" href="#parameter-url" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Firmware image url.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Update psu test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "update psu"
+ kaytus.ksmanage.update_psu:
+ url: "/home/wbs/CRPS1300D2W_00.01.04_BootLoader_Pri_Sec.hpm"
+ mode: "Auto"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/user_group_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/user_group_info_module.rst new file mode 100644 index 000000000..3272be892 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/user_group_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.user_group_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.user_group_info -- Get user group information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.user_group_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get user group information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: User group test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get user group information"
+ kaytus.ksmanage.user_group_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/user_group_module.rst b/ansible_collections/kaytus/ksmanage/docs/user_group_module.rst new file mode 100644 index 000000000..e92cf95bd --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/user_group_module.rst @@ -0,0 +1,532 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.user_group_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.user_group -- Manage user group
++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.user_group`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Manage user group on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-debug"></div>
+ <b>debug</b>
+ <a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Debug diagnose privilege.</div>
+ <div>Required when <em>state=present</em>.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-general"></div>
+ <b>general</b>
+ <a class="ansibleOptionLink" href="#parameter-general" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>General configuration privilege.</div>
+ <div>Required when <em>state=present</em>.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-kvm"></div>
+ <b>kvm</b>
+ <a class="ansibleOptionLink" href="#parameter-kvm" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Remote KVM configuration privilege.</div>
+ <div>Required when <em>state=present</em>.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-media"></div>
+ <b>media</b>
+ <a class="ansibleOptionLink" href="#parameter-media" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Remote media configuration privilege.</div>
+ <div>Required when <em>state=present</em>.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-name"></div>
+ <b>name</b>
+ <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ / <span style="color: red">required</span> </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Group name.</div>
+ <div>The range of group name for M6 model is OEM1, OEM2, OEM3, OEM4.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-power"></div>
+ <b>power</b>
+ <a class="ansibleOptionLink" href="#parameter-power" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Power control privilege.</div>
+ <div>Required when <em>state=present</em>.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-pri"></div>
+ <b>pri</b>
+ <a class="ansibleOptionLink" href="#parameter-pri" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>administrator</li>
+ <li>operator</li>
+ <li>user</li>
+ <li>oem</li>
+ <li>none</li>
+ </ul>
+ </td>
+ <td>
+ <div>Group privilege.</div>
+ <div>Required when <em>state=present</em>.</div>
+ <div>Only the M5 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-security"></div>
+ <b>security</b>
+ <a class="ansibleOptionLink" href="#parameter-security" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Security configuration privilege.</div>
+ <div>Required when <em>state=present</em>.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-self"></div>
+ <b>self</b>
+ <a class="ansibleOptionLink" href="#parameter-self" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>Itself configuration privilege.</div>
+ <div>Required when <em>state=present</em>.</div>
+ <div>Only the M6 model supports this parameter.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li><div style="color: blue"><b>present</b> ←</div></li>
+ <li>absent</li>
+ </ul>
+ </td>
+ <td>
+ <div>Whether the user group should exist or not, taking action if the state is different from what is stated.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: User group test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Add user group"
+ kaytus.ksmanage.user_group:
+ state: "present"
+ name: "test"
+ pri: "administrator"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set user group"
+ kaytus.ksmanage.user_group:
+ state: "present"
+ name: "test"
+ pri: "user"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set m6 user group"
+ kaytus.ksmanage.user_group:
+ state: "present"
+ name: "OEM1"
+ general: "enable"
+ kvm: "enable"
+ provider: "{{ ksmanage }}"
+
+ - name: "Delete user group"
+ kaytus.ksmanage.user_group:
+ state: "absent"
+ name: "test"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/user_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/user_info_module.rst new file mode 100644 index 000000000..747573924 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/user_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.user_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.user_info -- Get user information
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.user_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get user information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: User test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get user information"
+ kaytus.ksmanage.user_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/user_module.rst b/ansible_collections/kaytus/ksmanage/docs/user_module.rst new file mode 100644 index 000000000..9b0fd6d77 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/user_module.rst @@ -0,0 +1,454 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.user_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.user -- Manage user
++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.user`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Manage user on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-access"></div>
+ <b>access</b>
+ <a class="ansibleOptionLink" href="#parameter-access" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>enable</li>
+ <li>disable</li>
+ </ul>
+ </td>
+ <td>
+ <div>User access.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-email"></div>
+ <b>email</b>
+ <a class="ansibleOptionLink" href="#parameter-email" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>User email.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-priv"></div>
+ <b>priv</b>
+ <a class="ansibleOptionLink" href="#parameter-priv" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">list</span>
+ / <span style="color: purple">elements=string</span> </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>kvm</li>
+ <li>vmm</li>
+ <li>sol</li>
+ <li>none</li>
+ </ul>
+ </td>
+ <td>
+ <div>Other user permissions, select one or more from None/KVM/VMM/SOL.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-role_id"></div>
+ <b>role_id</b>
+ <a class="ansibleOptionLink" href="#parameter-role_id" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>User group.</div>
+ <div>Default user group 'Administrator', 'Operator', 'User'.</div>
+ <div>Use command <code>user_group_info</code> can get all group information.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li><div style="color: blue"><b>present</b> ←</div></li>
+ <li>absent</li>
+ </ul>
+ </td>
+ <td>
+ <div>Whether the user should exist or not, taking action if the state is different from what is stated.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-uid"></div>
+ <b>uid</b>
+ <a class="ansibleOptionLink" href="#parameter-uid" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>User id, The range is 1 to 16.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-uname"></div>
+ <b>uname</b>
+ <a class="ansibleOptionLink" href="#parameter-uname" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>User name, Required when uid is None.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-upass"></div>
+ <b>upass</b>
+ <a class="ansibleOptionLink" href="#parameter-upass" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>User password.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Does not support ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: User test
+ hosts: ksmanage
+ no_log: true
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Add user"
+ kaytus.ksmanage.user:
+ state: "present"
+ uname: "wbs"
+ upass: "admin"
+ role_id: "Administrator"
+ priv: "kvm, sol"
+ email: "wbs@ieisystem.com"
+ provider: "{{ ksmanage }}"
+
+ - name: "Set user"
+ kaytus.ksmanage.user:
+ state: "present"
+ uname: "wbs"
+ upass: "12345678"
+ role_id: "user"
+ priv: "kvm, sol"
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/virtual_media_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/virtual_media_info_module.rst new file mode 100644 index 000000000..5042af089 --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/virtual_media_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.virtual_media_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.virtual_media_info -- Get Virtual Media information
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.virtual_media_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get Virtual Media information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Media test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get Virtual Media information"
+ kaytus.ksmanage.virtual_media_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
diff --git a/ansible_collections/kaytus/ksmanage/docs/volt_info_module.rst b/ansible_collections/kaytus/ksmanage/docs/volt_info_module.rst new file mode 100644 index 000000000..59f5139be --- /dev/null +++ b/ansible_collections/kaytus/ksmanage/docs/volt_info_module.rst @@ -0,0 +1,302 @@ +.. Document meta
+
+:orphan:
+
+.. Anchors
+
+.. _ansible_collections.kaytus.ksmanage.volt_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Anchors: aliases
+
+
+
+.. Title
+
+kaytus.ksmanage.volt_info -- Get volt information
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This plugin is part of the `kaytus.ksmanage collection <https://galaxy.ansible.com/kaytus/ksmanage>`_.
+
+ To install it use: :code:`ansible-galaxy collection install kaytus.ksmanage`.
+
+ To use it in a playbook, specify: :code:`kaytus.ksmanage.volt_info`.
+
+.. version_added
+
+.. versionadded:: 1.0.0 of kaytus.ksmanage
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get volt information on kaytus Server.
+
+
+.. Aliases
+
+
+.. Requirements
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- Python 3.7+
+- inManage
+
+
+.. Options
+
+Parameters
+----------
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="2">Parameter</th>
+ <th>Choices/<font color="blue">Defaults</font></th>
+ <th width="100%">Comments</th>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-provider"></div>
+ <b>provider</b>
+ <a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">dictionary</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>A dict object containing connection details.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/host"></div>
+ <b>host</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/host" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/password"></div>
+ <b>password</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/password" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_PASSWORD</code> will be used instead.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-provider/username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-provider/username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td colspan="2">
+ <div class="ansibleOptionAnchor" id="parameter-username"></div>
+ <b>username</b>
+ <a class="ansibleOptionLink" href="#parameter-username" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable <code>ANSIBLE_NET_USERNAME</code> will be used instead.</div>
+ </td>
+ </tr>
+ </table>
+ <br/>
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Supports ``check_mode``.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Volt test
+ hosts: ksmanage
+ connection: local
+ gather_facts: false
+ vars:
+ ksmanage:
+ host: "{{ ansible_ssh_host }}"
+ username: "{{ username }}"
+ password: "{{ password }}"
+
+ tasks:
+
+ - name: "Get volt information"
+ kaytus.ksmanage.volt_info:
+ provider: "{{ ksmanage }}"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
+
+.. raw:: html
+
+ <table border=0 cellpadding=0 class="documentation-table">
+ <tr>
+ <th colspan="1">Key</th>
+ <th>Returned</th>
+ <th width="100%">Description</th>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-changed"></div>
+ <b>changed</b>
+ <a class="ansibleOptionLink" href="#return-changed" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">boolean</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Check to see if a change was made on the device.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-message"></div>
+ <b>message</b>
+ <a class="ansibleOptionLink" href="#return-message" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Messages returned after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="return-state"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#return-state" title="Permalink to this return value"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>always</td>
+ <td>
+ <div>Status after module execution.</div>
+ <br/>
+ </td>
+ </tr>
+ </table>
+ <br/><br/>
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- WangBaoshan (@ieisystem)
+
+
+
+.. Parsing errors
+
|