community.general.scaleway_compute_private_network 模块 – Scaleway 计算 - 私有网络管理

注意

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

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

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

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

community.general 5.2.0 中的新增功能

概要 

此模块将私有网络添加到计算实例或从计算实例中删除私有网络 (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"`
compute_id 字符串 / 必需	计算实例的 ID（请参阅 community.general.scaleway_compute）。
private_network_id 字符串 / 必需	私有网络的 ID（请参阅 community.general.scaleway_private_network）。
project 字符串 / 必需	项目标识符。
query_parameters 字典	传递到查询字符串的参数列表。默认值： `{}`
region 字符串 / 必需	要使用的 Scaleway 区域（例如 `par1`）。选项 `"ams1"` `"EMEA-NL-EVS"` `"par1"` `"EMEA-FR-PAR1"` `"par2"` `"EMEA-FR-PAR2"` `"waw1"` `"EMEA-PL-WAW1"`
state 字符串	指示 VPC 的所需状态。选项 `"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: Plug a VM to a private network
  community.general.scaleway_compute_private_network:
    project: '{{ scw_project }}'
    state: present
    region: par1
    compute_id: "12345678-f1e6-40ec-83e5-12345d67ed89"
    private_network_id: "22345678-f1e6-40ec-83e5-12345d67ed89"
  register: nicsvpc_creation_task

- name: Unplug a VM from a private network
  community.general.scaleway_compute_private_network:
    project: '{{ scw_project }}'
    state: absent
    region: par1
    compute_id: "12345678-f1e6-40ec-83e5-12345d67ed89"
    private_network_id: "22345678-f1e6-40ec-83e5-12345d67ed89"

返回值 

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

键

描述

scaleway_compute_private_network

字典

有关 VPC 的信息。

返回：当 state=present 时成功

示例: {"created_at": "2022-01-15T11:11:12.676445Z", "id": "12345678-f1e6-40ec-83e5-12345d67ed89", "name": "network", "organization_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90", "project_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90", "tags": ["tag1", "tag2", "tag3", "tag4", "tag5"], "updated_at": "2022-01-15T11:12:04.624837Z", "zone": "fr-par-2"}

作者

Pascal MANGIN (@pastral)