community.general.scaleway_ip 模块 – Scaleway IP 管理模块

注意

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

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

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

要在剧本中使用它，请指定： community.general.scaleway_ip。

概要 

此模块管理 Scaleway 账户上的 IP https://developer.scaleway.com

参数 

参数	注释
api_timeout 别名：timeout 整数	到 Scaleway API 的 HTTP 超时时间（秒）。默认值： `30`
api_token 别名：oauth_token 字符串 / 必需	Scaleway OAuth 令牌。
api_url 别名：base_url 字符串	Scaleway API URL。默认值： `"https://api.scaleway.com"`
id 字符串	Scaleway IP 的 ID（UUID）
organization 字符串 / 必需	Scaleway 组织标识符
query_parameters 字典	传递到查询字符串的参数列表。默认值： `{}`
region 字符串 / 必需	要使用的 Scaleway 区域（例如 par1）。选项 `"ams1"` `"EMEA-NL-EVS"` `"par1"` `"EMEA-FR-PAR1"` `"par2"` `"EMEA-FR-PAR2"` `"waw1"` `"EMEA-PL-WAW1"`
reverse 字符串	要分配给 IP 的反向
server 字符串	要将 IP 附加到的服务器的 ID。要分离 IP，请不要指定此选项
state 字符串	指示 IP 的所需状态。选项 `"present"` ← (默认) `"absent"`
validate_certs 布尔值	验证 Scaleway API 的 SSL 证书。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持：完全支持	可以在 `check_mode` 下运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：不支持	在 diff 模式下，将返回有关已更改内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

备注 

注意

另请参见 https://developer.scaleway.com/ 上的 API 文档。
如果模块中未设置 api_token，则可以使用以下环境变量，优先级递减：SCW_TOKEN、SCW_API_KEY、SCW_OAUTH_TOKEN 或 SCW_API_TOKEN。
如果要使用不同的 api_url，还可以设置 SCW_API_URL 环境变量。

示例 

- name: Create an IP
  community.general.scaleway_ip:
    organization: '{{ scw_org }}'
    state: present
    region: par1
  register: ip_creation_task

- name: Make sure IP deleted
  community.general.scaleway_ip:
    id: '{{ ip_creation_task.scaleway_ip.id }}'
    state: absent
    region: par1

返回值 

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

键	描述
数据字典	只有在`state=present`时才会出现。返回：当`state=present`时示例： `{"ips": [{"address": "212.47.232.136", "id": "dd9e8df6-6775-4863-b517-e0b0ee3d7477", "organization": "951df375-e094-4d26-97c1-ba548eeb9c42", "reverse": null, "server": {"id": "3f1568ca-b1a2-4e98-b6f7-31a0588157f1", "name": "ansible_tuto-1"}}]}`

作者

Remy Leone (@remyleone)