From bcc66b63e6320746f18caf97f63144429b70ad02 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Fri, 7 Jun 2024 07:34:06 +0200 Subject: Adding upstream version 10.0.1+dfsg. Signed-off-by: Daniel Baumann --- .../kaytus/ksmanage/docs/user_module.rst | 908 ++++++++++----------- 1 file changed, 454 insertions(+), 454 deletions(-) (limited to 'ansible_collections/kaytus/ksmanage/docs/user_module.rst') diff --git a/ansible_collections/kaytus/ksmanage/docs/user_module.rst b/ansible_collections/kaytus/ksmanage/docs/user_module.rst index 9b0fd6d77..ac0e3ba4c 100644 --- a/ansible_collections/kaytus/ksmanage/docs/user_module.rst +++ b/ansible_collections/kaytus/ksmanage/docs/user_module.rst @@ -1,454 +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 `_. - - 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- access - -
- string -
- 		-
    Choices: -
  • enable
    • -
  • disable
    • -
- 		-
User access.
-
-
- email - -
- string -
- 		- -
User email.
-
-
- host - -
- string -
- 		- -
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
-
-
- password - -
- string -
- 		- -
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
-
-
- priv - -
- list - / elements=string
- 		-
    Choices: -
  • kvm
    • -
  • vmm
    • -
  • sol
    • -
  • none
    • -
- 		-
Other user permissions, select one or more from None/KVM/VMM/SOL.
-
-
- provider - -
- dictionary -
- 		- -
A dict object containing connection details.
-
-
- host - -
- string -
- 		- -
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
-
-
- password - -
- string -
- 		- -
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
-
-
- username - -
- string -
- 		- -
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
-
-
- role_id - -
- string -
- 		- -
User group.
-
Default user group 'Administrator', 'Operator', 'User'.
-
Use command user_group_info can get all group information.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Whether the user should exist or not, taking action if the state is different from what is stated.
-
-
- uid - -
- integer -
- 		- -
User id, The range is 1 to 16.
-
-
- uname - -
- string -
- 		- -
User name, Required when uid is None.
-
-
- upass - -
- string -
- 		- -
User password.
-
-
- username - -
- string -
- 		- -
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
-
-
- -.. 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 `, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- changed - -
- boolean -
- 		always -
Check to see if a change was made on the device.
-
-
-
- message - -
- string -
- 		always -
Messages returned after module execution.
-
-
-
- state - -
- string -
- 		always -
Status after module execution.
-
-
-

- -.. Status (Presently only deprecated) - - -.. Authors - -Authors -~~~~~~~ - -- WangBaoshan (@ieisystem) - - - -.. Parsing errors - +.. 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 `_. + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ access + +
+ string +
+ 		+
    Choices: +
  • enable
    • +
  • disable
    • +
+ 		+
User access.
+
+
+ email + +
+ string +
+ 		+ +
User email.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ priv + +
+ list + / elements=string
+ 		+
    Choices: +
  • kvm
    • +
  • vmm
    • +
  • sol
    • +
  • none
    • +
+ 		+
Other user permissions, select one or more from None/KVM/VMM/SOL.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ role_id + +
+ string +
+ 		+ +
User group.
+
Default user group 'Administrator', 'Operator', 'User'.
+
Use command user_group_info can get all group information.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Whether the user should exist or not, taking action if the state is different from what is stated.
+
+
+ uid + +
+ integer +
+ 		+ +
User id, The range is 1 to 16.
+
+
+ uname + +
+ string +
+ 		+ +
User name, Required when uid is None.
+
+
+ upass + +
+ string +
+ 		+ +
User password.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. 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 `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + -- cgit v1.2.3