Модуль community.general.dimensiondata_vlan – Управление VLAN в сетевом домене Cloud Control

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, запустите ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Для использования в playbook, укажите: community.general.dimensiondata_vlan.

Краткое описание
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Управление VLAN в сетевых доменах Cloud Control.

Параметры

Параметр	Комментарии
allow_expand boolean	Разрешить расширение сети целевого VLAN, если параметры модуля указывают на сеть большего размера, чем сеть, которой в настоящее время обладает VLAN. Если `false`, модуль завершится ошибкой в этих условиях. Это предназначено для предотвращения случайного расширения сети VLAN (поскольку эта операция необратима). Варианты: `false` ← (по умолчанию) `true`
description string	Описание VLAN. По умолчанию: `""`
location string / required	Целевой дата-центр.
mcp_password string	Пароль, используемый для аутентификации в CloudControl API. Если не указан, будет использоваться `MCP_PASSWORD` из переменной окружения или `~/.dimensiondata`. Обязательно, если указан `mcp_user`.
mcp_user string	Имя пользователя, используемое для аутентификации в CloudControl API. Если не указан, будет использоваться `MCP_USER` из переменной окружения или `~/.dimensiondata`.
name string / required	Имя целевого VLAN.
network_domain string / required	ID или имя целевого сетевого домена.
private_ipv4_base_address string	Базовый адрес для сети IPv4 VLAN (например, 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`), при использовании режима diff.

Примеры

- 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 строка	Описание VLAN. Возвращаемое значение: успех Пример: `"My VLAN description"`
id строка	ID VLAN. Возвращаемое значение: успех Пример: `"aaaaa000-a000-4050-a215-2808934ccccc"`
location строка	Расположение дата-центра. Возвращаемое значение: успех Пример: `"NA3"`
name строка	Имя VLAN. Возвращаемое значение: успех Пример: `"My VLAN"`
private_ipv4_base_address строка	Базовый адрес частной IPV4 сети VLAN. Возвращаемое значение: успех Пример: `"192.168.23.0"`
private_ipv4_gateway_address строка	Адрес шлюза частной IPV4 сети VLAN. Возвращаемое значение: успех Пример: `"192.168.23.1"`
private_ipv4_prefix_size целое число	Размер префикса частной IPV4 сети VLAN. Возвращаемое значение: успех Пример: `24`
private_ipv6_base_address строка	Базовый адрес IPV6 сети VLAN. Возвращаемое значение: успех Пример: `"2402:9900:111:1195:0:0:0:0"`
private_ipv6_gateway_address строка	Адрес шлюза IPV6 сети VLAN. Возвращаемое значение: успех Пример: `"2402:9900:111:1195:0:0:0:1"`
private_ipv6_prefix_size целое число	Размер префикса IPV6 сети VLAN. Возвращаемое значение: успех Пример: `64`
status строка	Статус VLAN. Возвращаемое значение: успех Пример: `"NORMAL"`

Авторы

Adam Friedman (@tintoy)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/dimensiondata_vlan_module.html