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

注意

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

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

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

要在剧本中使用它，请指定：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

支持： N/A

此操作不会修改状态。

在差异模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改）的详细信息。

备注

注意

示例

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

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

返回值

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

键

描述

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)