community.digitalocean.digital_ocean_vpc 模块 – 创建和删除 DigitalOcean VPC

注意

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

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

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

要在 playbook 中使用它,请指定:community.digitalocean.digital_ocean_vpc

community.digitalocean 1.7.0 中的新增功能

概要

  • 此模块可用于创建和删除 DigitalOcean VPC。

参数

参数

注释

baseurl

字符串

DigitalOcean API 基本 URL。

默认值: "https://api.digitalocean.com/v2"

default

布尔值

一个布尔值,指示 VPC 是否为该区域的默认网络。

除非在创建过程中另有指定,否则所有适用资源都将放置在默认 VPC 网络中。

default 字段无法从 true 取消设置。

如果要设置新的默认 VPC 网络,请更新同一区域中另一个 VPC 网络的 default 字段。

当定义新的默认 VPC 时,先前网络的 default 字段将设置为 false

选项

  • false ← (默认)

  • true

description

字符串

用于描述 VPC 目的的自由格式文本字段。

最多可包含 255 个字符。

ip_range

字符串

以 CIDR 表示法表示的 VPC 请求的 IP 地址范围。

网络范围不能与同一帐户中的其他网络重叠,并且必须在 RFC1918 中定义的私有地址范围内。

它不能小于 /24,也不能大于 /16。

如果未指定 IP 范围,则会生成一个 /20 网络范围,该范围不会与您帐户中的其他 VPC 网络冲突。

name

字符串 / 必填

VPC 的名称。

必须唯一,并且只能包含字母数字字符、破折号和句点。

oauth_token

别名:api_token

字符串

DigitalOcean OAuth 令牌。

可以使用其他几个环境变量来提供此值。

例如,- DO_API_TOKENDO_API_KEYDO_OAUTH_TOKENOAUTH_TOKEN

region

字符串

将创建 VPC 的区域的标识符。

state

字符串

VPC 是否应存在(已创建)或不存在(已删除)。

选项

  • "present" ← (默认)

  • "absent"

timeout

整数

用于轮询 DigitalOcean API 的超时时间(以秒为单位)。

默认值: 30

validate_certs

布尔值

如果设置为 no,则不会验证 SSL 证书。

仅当在使用自签名证书的个人控制站点上使用时,才应将其设置为 no

选项

  • false

  • true ← (默认)

示例

- name: Create a VPC
  community.digitalocean.digital_ocean_vpc:
    state: present
    name: myvpc1
    region: nyc1

- name: Create a VPC (choose IP range)
  community.digitalocean.digital_ocean_vpc:
    state: present
    name: myvpc1
    region: nyc1
    ip_range: 192.168.192.0/24

- name: Update a VPC (make it default)
  community.digitalocean.digital_ocean_vpc:
    state: present
    name: myvpc1
    region: nyc1
    default: true

- name: Update a VPC (change description)
  community.digitalocean.digital_ocean_vpc:
    state: present
    name: myvpc1
    region: nyc1
    description: myvpc

- name: Delete a VPC
  community.digitalocean.digital_ocean_vpc:
    state: absent
    name: myvpc1

返回值

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

描述

data

字典

一个 DigitalOcean VPC。

返回: 成功

示例: {"msg": "在 nyc1 中创建了 VPC myvpc1", "vpc": {"created_at": "2021-06-17T11:43:12.12121565Z", "default": false, "description": "", "id": "a3b72d97-192f-4984-9d71-08a5faf2e0c7", "ip_range": "10.116.16.0/20", "name": "testvpc1", "region": "nyc1", "urn": "do:vpc:a3b72d97-192f-4984-9d71-08a5faf2e0c7"}}

作者

  • Mark Mercado (@mamercad)