community.general.dimensiondata_vlan – Управление VLAN в домене сети Cloud Control.
Примечание
Этот плагин входит в состав коллекции community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в playbook укажите: community.general.dimensiondata_vlan.
Обзор
- Управление VLAN в домене сети Cloud Control.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| allow_expand boolean |
| Разрешить расширение сети целевого VLAN, если параметры модуля задают сеть больше, чем та, которая у VLAN есть в настоящее время. Если False, модуль завершится неудачей в этих условиях.Это предназначено для предотвращения случайного расширения сети VLAN (поскольку эта операция необратима). |
| description строка | Описание VLAN. | |
| location строка / обязательно | Целевой дата-центр. | |
| mcp_password строка | Пароль, используемый для аутентификации в API CloudControl. Если не указан, вернётся к значению MCP_PASSWORD из переменной среды или ~/.dimensiondata.Требуется, если указан параметр mcp_user. | |
| mcp_user строка | Имя пользователя, используемый для аутентификации в API CloudControl. Если не указан, вернётся к значению MCP_USER из переменной среды или ~/.dimensiondata. | |
| name строка / обязательно | Имя целевого VLAN. | |
| network_domain строка / обязательно | Идентификатор или имя целевого домена сети. | |
| private_ipv4_base_address строка | Базовый адрес IPv4 сети VLAN (например, 192.168.1.0). | |
| private_ipv4_prefix_size целое число | Размер адресного пространства IPv4, например 24. Требуется, если указано private_ipv4_base_address. | |
| region строка | Значение по умолчанию: "na" | Целевой регион. Регионы определены в проекте Apache libcloud [libcloud/common/dimensiondata.py] Они также перечислены в https://libcloud.readthedocs.io/en/latest/compute/drivers/dimensiondata.html
Обратите внимание, что значение по умолчанию "na" означает "Северная Америка". Модуль добавляет префикс 'dd-' к выбору региона. |
| state строка |
| Желаемое состояние целевого VLAN. readonly гарантирует, что состояние только читается, а не изменяется (модуль завершится неудачей, если ресурс не существует). |
| validate_certs boolean |
| Если false, сертификаты SSL не будут проверены.Это следует использовать только с частными экземплярами API CloudControl, которые используют самозаверяющие сертификаты. |
| wait boolean |
| Нужно ли ожидать завершения задачи перед переходом к следующей? |
| wait_poll_interval целое число | Значение по умолчанию: 2 | Время ожидания (в секундах) между проверками завершения задачи. Применимо только если wait=true. |
| wait_time целое число | Значение по умолчанию: 600 | Максимальное время ожидания (в секундах) завершения задачи. Применимо только если wait=true. |
Примеры
- 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: yes
- name: Read / get VLAN details
community.general.dimensiondata_vlan:
region: na
location: NA5
network_domain: test_network
name: my_vlan1
state: readonly
wait: yes
- name: Delete a VLAN
community.general.dimensiondata_vlan:
region: na
location: NA5
network_domain: test_network
name: my_vlan_1
state: absent
wait: yes
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vlan сложный | При успехе, когда state равен 'наличие' | Словарь, описывающий VLAN. | |
| description строка | успех | Описание VLAN. Пример: Описание моего VLAN | |
| id строка | успех | Идентификатор VLAN. Пример: aaaaa000-a000-4050-a215-2808934ccccc | |
| location строка | успех | Расположение дата-центра. Пример: NA3 | |
| name строка | успех | Имя VLAN. Пример: Мой 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/dimensiondata_vlan_module.html
