ngine_io.cloudstack.cs_user 模块 – 管理基于 Apache CloudStack 的云上的用户。

注意

此模块是 ngine_io.cloudstack 集合（版本 2.5.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install ngine_io.cloudstack。您需要进一步的要求才能使用此模块，有关详细信息，请参见 要求。

要在 playbook 中使用它，请指定：ngine_io.cloudstack.cs_user。

ngine_io.cloudstack 0.1.0 中的新功能

概要

• 创建、更新、禁用、锁定、启用和删除用户。

要求

执行此模块的主机需要以下要求。

• python >= 2.6

• cs >= 0.9.0

参数

参数	注释
account 字符串	将在其下创建用户的帐户。 在 state=present 时是必需的。
api_http_method 字符串	用于查询 API 端点的 HTTP 方法。 如果未给出，则会考虑 CLOUDSTACK_METHOD 环境变量。 选择 "get" ←（默认） "post"
api_key 字符串 / 必需	CloudStack API 的 API 密钥。 如果未给出，则会考虑 CLOUDSTACK_KEY 环境变量。
api_secret 字符串 / 必需	CloudStack API 的密钥。 如果未设置，则会考虑 CLOUDSTACK_SECRET 环境变量。
api_timeout 整数	HTTP 超时时间（以秒为单位）。 如果未给出，则会考虑 CLOUDSTACK_TIMEOUT 环境变量。 默认值： 10
api_url 字符串 / 必需	CloudStack API 的 URL，例如 https://cloud.example.com/client/api。 如果未给出，则会考虑 CLOUDSTACK_ENDPOINT 环境变量。
api_verify_ssl_cert 字符串	验证 CA 授权证书文件。 如果未给出，则会考虑 CLOUDSTACK_VERIFY 环境变量。
domain 字符串	用户所属的域。 默认值： "ROOT"
email 字符串	用户的电子邮件。 在 state=present 时是必需的。
first_name 字符串	用户的名字。 在 state=present 时是必需的。
keys_registered 布尔值	是否应生成用户的 API 密钥。 注意：密钥无法通过 API 再次删除。 选择 false ←（默认） true
last_name 字符串	用户的姓氏。 在 state=present 时是必需的。
password 字符串	要创建的用户的密码。 在 state=present 时是必需的。 仅在创建时考虑，如果用户存在则不会更新。
poll_async 布尔值	轮询异步作业，直到作业完成。 选择 false true ←（默认）
state 字符串	用户的状态。 unlocked 是 enabled 的别名。 选择 "present" ←（默认） "absent" "enabled" "disabled" "locked" "unlocked"
timezone 字符串	用户的时区。
username 字符串 / 必需	用户的用户名。
validate_certs 布尔值 在 ngine_io.cloudstack 2.4.0 中添加	如果 false，则不会验证 SSL 证书。 如果未给出，则会考虑 CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY 环境变量。 这应该仅在个人控制的站点上使用自签名证书。 选择 false true ←（默认）

注释

注意

• 有关 cloudstack 模块的详细指南可以在 CloudStack 云指南中找到。

• 此模块支持检查模式。

示例

- name: Create an user in domain 'CUSTOMERS'
  ngine_io.cloudstack.cs_user:
    account: developers
    username: johndoe
    password: S3Cur3
    last_name: Doe
    first_name: John
    email: john.doe@example.com
    domain: CUSTOMERS

- name: Lock an existing user in domain 'CUSTOMERS'
  ngine_io.cloudstack.cs_user:
    username: johndoe
    domain: CUSTOMERS
    state: locked

- name: Disable an existing user in domain 'CUSTOMERS'
  ngine_io.cloudstack.cs_user:
    username: johndoe
    domain: CUSTOMERS
    state: disabled

- name: Enable/unlock an existing user in domain 'CUSTOMERS'
  ngine_io.cloudstack.cs_user:
    username: johndoe
    domain: CUSTOMERS
    state: enabled

- name: Remove an user in domain 'CUSTOMERS'
  ngine_io.cloudstack.cs_user:
    name: customer_xy
    domain: CUSTOMERS
    state: absent

返回值

常见的返回值记录在这里，以下是此模块特有的字段

Key	描述
account 字符串	用户的账户名称。 Returned: 成功 示例: "developers"
account_type 字符串	账户类型。 Returned: 成功 示例: "user"
created 字符串	用户创建的日期。 Returned: 成功 示例: "Doe"
domain 字符串	用户相关的域。 Returned: 成功 示例: "ROOT"
email 字符串	用户的电子邮件。 Returned: 成功 示例: "john.doe@example.com"
fist_name 字符串	用户的名字。 Returned: 成功 示例: "John"
id 字符串	用户的UUID。 Returned: 成功 示例: "87b1e0ce-4e01-11e4-bb66-0050569e64b8"
last_name 字符串	用户的姓氏。 Returned: 成功 示例: "Doe"
state 字符串	用户的状态。 Returned: 成功 示例: "enabled"
timezone 字符串	用户的时区。 Returned: 成功 示例: "enabled"
user_api_key 字符串	用户的API密钥。 Returned: 成功 示例: "JLhcg8VWi8DoFqL2sSLZMXmGojcLnFrOBTipvBHJjySODcV4mCOo29W2duzPv5cALaZnXj5QxDx3xQfaQt3DKg"
user_api_secret 字符串	用户的API秘钥。 Returned: 成功 示例: "FUELo3LB9fa1UopjTLPdqLv_6OXQMJZv9g9N4B_Ao3HFz8d6IGFCV9MbPFNM8mwz00wbMevja1DoUNDvI8C9-g"
username 字符串	用户的用户名。 Returned: 成功 示例: "johndoe"

作者

• René Moser (@resmo)

集合链接

• 问题追踪器
• 存储库（源代码）