Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new modules system_lock_mode_info, edit_system_lock_mode #27

Merged
merged 1 commit into from
Sep 27, 2024
Merged

Add new modules system_lock_mode_info, edit_system_lock_mode #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Thes modules require the following to be installed on the control node:

* Python 3.7 or later
* [Ansible](http://www.ansible.com) 2.10 or later
* [ieisystem support] [inManage](https://github.com/ieisystem/inManage) 1.1.0 or later
* [ieisystem support] [inManage](https://github.com/ieisystem/inManage) 1.2.0 or later

## Included content

Expand Down
2 changes: 2 additions & 0 deletions changelogs/fragments/27-edit_add_lock_mode.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
major_changes:
- "Add new modules system_lock_mode_info, edit_system_lock_mode(https://github.com/ieisystem/kaytus.ksmanage/pull/27)."
327 changes: 327 additions & 0 deletions docs/edit_system_lock_mode_module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,327 @@
.. Document meta

:orphan:

.. Anchors

.. _ansible_collections.kaytus.ksmanage.edit_system_lock_mode_module:

.. Anchors: short name for ansible.builtin

.. Anchors: aliases



.. Title

kaytus.ksmanage.edit_system_lock_mode -- Set system lock mode 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_system_lock_mode`.

.. version_added

.. versionadded:: 2.0.0 of kaytus.ksmanage

.. contents::
:local:
:depth: 1

.. Deprecated


Synopsis
--------

.. Description

- Set system lock mode 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-lock_status"></div>
<b>lock_status</b>
<a class="ansibleOptionLink" href="#parameter-lock_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>close</li>
<li>open</li>
</ul>
</td>
<td>
<div>System lock mode status.</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: System lock mode test
hosts: ksmanage
connection: local
gather_facts: false
vars:
ksmanage:
host: "{{ ansible_ssh_host }}"
username: "{{ username }}"
password: "{{ password }}"

tasks:

- name: "Set system lock mode to close"
kaytus.ksmanage.edit_system_lock_mode:
lock_status: "close"
provider: "{{ ksmanage }}"

- name: "Set system lock mode to open"
kaytus.ksmanage.edit_system_lock_mode:
lock_status: "open"
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

2 changes: 1 addition & 1 deletion galaxy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace: kaytus
name: ksmanage

# The version of the collection. Must be compatible with semantic versioning
version: 1.2.2
version: 2.0.0

# The path to the Markdown (.md) readme file. This path is relative to the root of the collection
readme: README.md
Expand Down
Loading
Loading