community.general.online_user_info 模块 – 收集在线用户信息

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定：community.general.online_user_info。

概要 

收集有关用户的信息。

参数 

参数	注释
api_timeout 别名：timeout 整数	在线 API 的 HTTP 超时时间（以秒为单位）。默认值： `30`
api_token 别名：oauth_token 字符串 / 必需	在线 OAuth 令牌。
api_url 别名：base_url 字符串	在线 API URL。默认值： `"https://api.online.net"`
validate_certs 布尔值	验证在线 API 的 SSL 证书。选项 `false` `true` ←（默认）

属性 

属性	支持	描述
check_mode	支持：完整此操作不会修改状态。	可以在 `check_mode` 中运行，并返回已更改的状态预测，而无需修改目标。
diff_mode	支持：不适用此操作不会修改状态。	在 diff 模式下，当在 `check_mode` 中时，将返回有关已更改的内容（或可能需要更改的内容）的详细信息。

备注 

注意

另请参阅 https://console.online.net/en/api/ 上的 API 文档。
如果未在模块中设置 api_token，则可以使用以下环境变量，优先级从高到低依次为 ONLINE_TOKEN、 ONLINE_API_KEY、 ONLINE_OAUTH_TOKEN 和 ONLINE_API_TOKEN。
如果要使用不同的 api_url，还可以设置 ONLINE_API_URL 环境变量。

示例 

- name: Gather Online user info
  community.general.online_user_info:
  register: result

- ansible.builtin.debug:
    msg: "{{ result.online_user_info }}"

返回值 

通用返回值已在此处记录 here，以下是此模块独有的字段

键	描述
online_user_info 字典	来自在线 API 的响应。有关更多详细信息，请参阅：https://console.online.net/en/api/。已返回：成功示例: `{"online_user_info": {"company": "foobar LLC", "email": "[email protected]", "first_name": "foo", "id": 42, "last_name": "bar", "login": "foobar"}}`

作者

Remy Leone (@remyleone)