kaytus.ksmanage.user 模块 – 管理用户

注意

此模块是 kaytus.ksmanage 集合 (版本 2.0.0) 的一部分。

如果您使用的是 ansible 包,您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install kaytus.ksmanage。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。

要在 Playbook 中使用它,请指定:kaytus.ksmanage.user

kaytus.ksmanage 1.0.0 中的新增功能

概要

  • 管理 Kaytus 服务器上的用户。

要求

以下要求需要在执行此模块的主机上满足。

  • Python 3.7+

  • inManage

参数

参数

注释

access

字符串

用户访问权限。

选择

  • "enable"

  • "disable"

email

字符串

用户电子邮件。

host

字符串

指定用于通过指定传输连接到远程设备的 DNS 主机名或地址。host 的值用作传输的目标地址。

password

字符串

指定用于验证与远程设备的连接的密码。如果在任务中未指定该值,则将使用环境变量 ANSIBLE_NET_PASSWORD 的值代替。

priv

列表 / 元素=字符串

其他用户权限,从 None/KVM/VMM/SOL 中选择一个或多个。

选择

  • "kvm"

  • "vmm"

  • "sol"

  • "none"

provider

字典

包含连接详细信息的字典对象。

host

字符串

指定用于通过指定传输连接到远程设备的 DNS 主机名或地址。host 的值用作传输的目标地址。

password

字符串

指定用于验证与远程设备的连接的密码。如果在任务中未指定该值,则将使用环境变量 ANSIBLE_NET_PASSWORD 的值代替。

username

字符串

配置用于验证与远程设备的连接的用户名。如果在任务中未指定该值,则将使用环境变量 ANSIBLE_NET_USERNAME 的值代替。

role_id

字符串

用户组。

默认用户组 ‘Administrator’、‘Operator’、‘User’。

使用命令 user_group_info 可以获取所有组信息。

state

字符串

用户是否应该存在,如果状态与声明的不同,则采取措施。

选择

  • "present" ←(默认)

  • "absent"

uid

整数

用户 ID,范围是 1 到 16。

uname

字符串

用户名,当 uid 为 None 时是必需的。

upass

字符串

用户密码。

username

字符串

配置用于验证与远程设备的连接的用户名。如果在任务中未指定该值,则将使用环境变量 ANSIBLE_NET_USERNAME 的值代替。

注意

注意

  • 不支持 check_mode

示例

- 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: "[email protected]"
      provider: "{{ ksmanage }}"

  - name: "Set user"
    kaytus.ksmanage.user:
      state: "present"
      uname: "wbs"
      upass: "12345678"
      role_id: "user"
      priv: "kvm, sol"
      provider: "{{ ksmanage }}"

返回值

常见返回值已在此处记录 此处,以下是此模块特有的字段

描述

changed

布尔值

检查设备上是否进行了更改。

已返回: 始终

message

字符串

模块执行后返回的消息。

已返回: 始终

state

字符串

模块执行后的状态。

已返回: 始终

作者

  • WangBaoshan (@ieisystem)