community.general.scaleway_private_network 模块 – Scaleway 私有网络管理

注意

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

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

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

要在 playbook 中使用它，请指定：community.general.scaleway_private_network。

community.general 4.5.0 中的新增功能

概要 

此模块管理 Scaleway 帐户上的私有网络 (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"`
name 字符串	VPC 的名称。
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"`
tags 列表 / 元素=字符串	要应用于实例的标签列表。默认值: `[]`
validate_certs 布尔值	验证 Scaleway API 的 SSL 证书。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持: 完全	可以在 `check_mode` 中运行并返回已更改的状态预测，而无需修改目标。
diff_mode	支持: 无	当处于差异模式时，将返回有关已更改（或可能需要在 `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 private network
  community.general.scaleway_vpc:
    project: '{{ scw_project }}'
    name: 'vpc_one'
    state: present
    region: par1
  register: vpc_creation_task

- name: Make sure private network with name 'foo' is deleted in region par1
  community.general.scaleway_vpc:
    name: 'foo'
    state: absent
    region: par1

返回值 

常见的返回值记录在这里，以下是此模块特有的字段

键

描述

scaleway_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)