community.general.online_server_info 模块 – 收集关于 Online 服务器的信息
注意
此模块是 community.general 集合(版本 10.1.0)的一部分。
如果您正在使用 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install community.general
。
要在 Playbook 中使用它,请指定:community.general.online_server_info
。
概要
收集关于服务器的信息。
参数
参数 |
注释 |
---|---|
连接 Online API 的 HTTP 超时时间(以秒为单位)。 默认值: |
|
Online OAuth 令牌。 |
|
Online API URL。 默认值: |
|
验证 Online API 的 SSL 证书。 选项
|
属性
属性 |
支持 |
描述 |
---|---|---|
支持:完全 此操作不会修改状态。 |
可以在 |
|
支持: 不适用 此操作不会修改状态。 |
在 diff 模式下运行时,将返回已更改(或可能需要在 |
注释
注意
另请参阅 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 server information
community.general.online_server_info:
api_token: '0d1627e8-bbf0-44c5-a46f-5c4d3aef033f'
register: result
- ansible.builtin.debug:
msg: "{{ result.online_server_info }}"
返回值
常见的返回值记录在此处,以下是此模块独有的字段
键 |
描述 |
---|---|
来自 Online API 的响应。 有关更多详细信息,请参阅:https://console.online.net/en/api/。 已返回:成功 示例: |