community.general.oneandone_private_network 模块 – 配置 1&1 私有网络

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.general。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

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

概要

  • 创建、删除、重新配置、更新私有网络。此模块依赖于 1and1 >= 1.0。

要求

以下是执行此模块的主机所需的条件。

  • 1and1

参数

参数

注释

add_members

列表 / 元素=字符串

要添加到私有网络的服务器标识符（名称或 ID）列表。

默认值： []

api_url

字符串

自定义 API URL。覆盖 ONEANDONE_API_URL 环境变量。

auth_token

字符串

1&1 提供的身份验证 API 令牌。

datacenter

字符串

将创建私有网络的数据中心的标识符

选项

  • "US"

  • "ES"

  • "DE"

  • "GB"

description

字符串

为网络设置描述。

name

字符串

与 present 状态一起使用的私有网络名称。与 absent 状态一起使用时用作标识符（ID 或名称）。

network_address

字符串

设置私有网络空间，例如 192.168.1.0

private_network

字符串

与 update 状态一起使用的网络标识符（ID 或名称）。

remove_members

列表 / 元素=字符串

要从私有网络中删除的服务器标识符（名称或 ID）列表。

默认值： []

state

字符串

定义网络的状态以创建、删除或更新。

选项

  • "present" ← (默认)

  • "absent"

  • "update"

subnet_mask

字符串

设置私有网络的网络掩码，例如 255.255.255.0

wait

布尔值

等待实例处于“运行”状态后再返回

选项

  • false

  • true ← (默认)

wait_interval

整数

定义使用 _wait_for 方法时要等待的秒数

默认值： 5

wait_timeout

整数

等待放弃之前的时长（秒）

默认值： 600

属性

属性

支持

描述

check_mode

支持：完全支持

可以在 check_mode 下运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持：不支持

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

示例

- name: Create a private network
  community.general.oneandone_private_network:
    auth_token: oneandone_private_api_key
    name: backup_network
    description: Testing creation of a private network with ansible
    network_address: 70.35.193.100
    subnet_mask: 255.0.0.0
    datacenter: US

- name: Destroy a private network
  community.general.oneandone_private_network:
    auth_token: oneandone_private_api_key
    state: absent
    name: backup_network

- name: Modify the private network
  community.general.oneandone_private_network:
    auth_token: oneandone_private_api_key
    state: update
    private_network: backup_network
    network_address: 192.168.2.0
    subnet_mask: 255.255.255.0

- name: Add members to the private network
  community.general.oneandone_private_network:
    auth_token: oneandone_private_api_key
    state: update
    private_network: backup_network
    add_members:
     - server identifier (id or name)

- name: Remove members from the private network
  community.general.oneandone_private_network:
    auth_token: oneandone_private_api_key
    state: update
    private_network: backup_network
    remove_members:
     - server identifier (id or name)

返回值

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

键

描述

private_network

字典

有关私有网络的信息。

返回：始终返回

示例： {"id": "55726DEDA20C99CF6F2AF8F18CAC9963", "name": "backup_network"}

作者

  • Amel Ajdinovic (@aajdinov)

  • Ethan Devenport (@edevenport)