diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-05 16:18:34 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-05 16:18:34 +0000 |
| commit | 3667197efb7b18ec842efd504785965911f8ac4b (patch) | |
| tree | 0b986a4bc6879d080b100666a97cdabbc9ca1f28 /ansible_collections/kaytus/ksmanage/docs/edit_auto_capture_module.rst | |
| parent | Adding upstream version 9.5.1+dfsg. (diff) | |
| download | ansible-3667197efb7b18ec842efd504785965911f8ac4b.tar.xz ansible-3667197efb7b18ec842efd504785965911f8ac4b.zip | |
Adding upstream version 10.0.0+dfsg.upstream/10.0.0+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/kaytus/ksmanage/docs/edit_auto_capture_module.rst')
| -rw-r--r-- | ansible_collections/kaytus/ksmanage/docs/edit_auto_capture_module.rst | 322 |
1 files changed, 322 insertions, 0 deletions
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
+
|