community.general.dimensiondata_vlan 模块 – 在云控制网络域中管理 VLAN

注意

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

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

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

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

概要

  • 在云控制网络域中管理 VLAN。

参数

参数

注释

allow_expand

boolean

如果模块参数指定的网络大于 VLAN 当前拥有的网络，则允许扩展目标 VLAN 的网络。

如果 false，则在这些条件下模块将失败。

这是为了防止意外扩展 VLAN 的网络（因为此操作不可逆）。

选项

  • false ← (默认)

  • true

description

string

VLAN 的描述。

默认： ""

location

string / 必选

目标数据中心。

mcp_password

string

用于向 CloudControl API 进行身份验证的密码。

如果未指定，将回退到环境变量 MCP_PASSWORD 或 ~/.dimensiondata。

如果指定了 mcp_user，则为必选。

mcp_user

string

用于向 CloudControl API 进行身份验证的用户名。

如果未指定，将回退到环境变量 MCP_USER 或 ~/.dimensiondata。

name

string / 必选

目标 VLAN 的名称。

network_domain

string / 必选

目标网络域的 ID 或名称。

private_ipv4_base_address

string

VLAN 的 IPv4 网络的基本地址（例如 192.168.1.0）。

默认： ""

private_ipv4_prefix_size

integer

IPv4 地址空间的大小，例如 24。

如果指定了 private_ipv4_base_address，则为必选。

默认： 0

region

string

目标区域。

区域在 Apache libcloud 项目 [libcloud/common/dimensiondata.py] 中定义。

它们也列在 https://libcloud.readthedocs.io/en/latest/compute/drivers/dimensiondata.html 中。

请注意，默认值 na 表示“北美”。

模块会将 dd- 前缀添加到区域选择中。

默认： "na"

state

string

目标 VLAN 的所需状态。

readonly 确保状态仅被读取，而不被修改（如果资源不存在，模块将失败）。

选项

  • "present" ← (默认)

  • "absent"

  • "readonly"

validate_certs

boolean

如果 false，则不会验证 SSL 证书。

这仅应在 CloudControl API 的使用自签名证书的私有实例上使用。

选项

  • false

  • true ← (默认)

wait

boolean

是否应在完成任务后才进行下一个任务。

选项

  • false ← (默认)

  • true

wait_poll_interval

integer

检查任务完成情况之间等待的时间（以秒为单位）。

仅当 wait=true 时适用。

默认： 2

wait_time

integer

等待任务完成的最大时间（以秒为单位）。

仅当 wait=true 时适用。

默认值: 600

属性

属性

支持

描述

check_mode

支持: 无

可以在 check_mode 模式下运行，并返回变更状态预测，而无需修改目标。

diff_mode

支持: 无

当处于差异模式时，将返回已更改的详细信息（或可能需要在 check_mode 中进行更改的详细信息）。

示例

- name: Add or update VLAN
  community.general.dimensiondata_vlan:
    region: na
    location: NA5
    network_domain: test_network
    name: my_vlan1
    description: A test VLAN
    private_ipv4_base_address: 192.168.23.0
    private_ipv4_prefix_size: 24
    state: present
    wait: true

- name: Read / get VLAN details
  community.general.dimensiondata_vlan:
    region: na
    location: NA5
    network_domain: test_network
    name: my_vlan1
    state: readonly
    wait: true

- name: Delete a VLAN
  community.general.dimensiondata_vlan:
    region: na
    location: NA5
    network_domain: test_network
    name: my_vlan_1
    state: absent
    wait: true

返回值

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

键

描述

vlan

复杂

描述 VLAN 的字典。

返回: 当 state=present 成功时返回

description

string

VLAN 描述。

返回: 成功

示例: "我的 VLAN 描述"

id

string

VLAN ID。

返回: 成功

示例: "aaaaa000-a000-4050-a215-2808934ccccc"

location

string

数据中心位置。

返回: 成功

示例: "NA3"

name

string

VLAN 名称。

返回: 成功

示例: "我的 VLAN"

private_ipv4_base_address

string

VLAN 的私有 IPV4 网络的基本地址。

返回: 成功

示例: "192.168.23.0"

private_ipv4_gateway_address

string

VLAN 的私有 IPV4 网络的网关地址。

返回: 成功

示例: "192.168.23.1"

private_ipv4_prefix_size

integer

VLAN 的私有 IPV4 网络的前缀大小。

返回: 成功

示例: 24

private_ipv6_base_address

string

VLAN 的 IPV6 网络的基本地址。

返回: 成功

示例: "2402:9900:111:1195:0:0:0:0"

private_ipv6_gateway_address

string

VLAN 的 IPV6 网络的网关地址。

返回: 成功

示例: "2402:9900:111:1195:0:0:0:1"

private_ipv6_prefix_size

integer

VLAN 的 IPV6 网络的前缀大小。

返回: 成功

示例: 64

status

string

VLAN 状态。

返回: 成功

示例: "正常"

作者

  • Adam Friedman (@tintoy)