community.general.scaleway_ip_info 模块 – 收集关于可用的 Scaleway IP 的信息

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.general

要在 playbook 中使用它,请指定:community.general.scaleway_ip_info

概要

  • 收集关于可用的 Scaleway IP 的信息。

参数

参数

注释

api_timeout

别名:timeout

整数

连接 Scaleway API 的 HTTP 超时时间,以秒为单位。

默认值: 30

api_token

别名:oauth_token

字符串 / 必需

Scaleway OAuth 令牌。

api_url

别名:base_url

字符串

Scaleway API URL。

默认值: "https://api.scaleway.com"

query_parameters

字典

传递到查询字符串的参数列表。

默认值: {}

region

字符串 / 必需

要使用的 Scaleway 区域(例如 par1)。

选项

  • "ams1"

  • "EMEA-NL-EVS"

  • "par1"

  • "EMEA-FR-PAR1"

  • "par2"

  • "EMEA-FR-PAR2"

  • "waw1"

  • "EMEA-PL-WAW1"

validate_certs

布尔值

验证 Scaleway API 的 SSL 证书。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持: 完整

此操作不会修改状态。

可以在 check_mode 中运行并返回已更改的状态预测,而无需修改目标。

diff_mode

支持: N/A

此操作不会修改状态。

当处于 diff 模式时,将返回有关已更改的内容(或可能需要在 check_mode 中更改的内容)的详细信息。

备注

注意

示例

- name: Gather Scaleway ips information
  community.general.scaleway_ip_info:
    region: par1
  register: result

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

返回值

通用返回值在此处文档化:此处,以下是此模块特有的字段

描述

scaleway_ip_info

列表 / 元素=字典

来自 Scaleway API 的响应。

更多详细信息请参考:https://developers.scaleway.com/en/products/instance/api/

返回: 成功

示例: {"scaleway_ip_info": [{"address": "163.172.170.243", "id": "ea081794-a581-8899-8451-386ddaf0a451", "organization": "3f709602-5e6c-4619-b80c-e324324324af", "reverse": null, "server": {"id": "12f19bc7-109c-4517-954c-e6b3d0311363", "name": "scw-e0d158"}}]}

作者

  • Yanis Guenane (@Spredzy)

  • Remy Leone (@remyleone)