openstack.cloud.os_network – Создаёт/удаляет сети из OpenStack

Примечание

Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).

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

Для использования в книге задач укажите: openstack.cloud.os_network.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Добавление или удаление сети из OpenStack.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
admin_state_up boolean	Варианты: no да ←	Указывает, должно ли состояние быть помечено как активное или неактивное.
api_timeout integer		Время ожидания сокетом перед истечением срока действия для вызовов API. Если это значение опущено, библиотеке requests ничего не будет передано.
auth dictionary		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля «пароль» он будет содержать «auth_url», «username», «password», «project_name» и любую информацию о доменах (например, «user_domain_name» или «project_domain_name»), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать параметры, необходимые этому подключаемому модулю. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type string		Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме аутентификации по паролю, здесь должно быть указано имя подключаемого модуля, а содержимое параметра «auth» должно быть соответствующим образом обновлено.
availability_zone string		Игнорируется. Присутствует для обратной совместимости
ca_cert string		Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. алиасы: cacert
client_cert string		Путь к клиенту сертификату для использования в рамках транзакции SSL. алиасы: cert
client_key string		Путь к ключу клиента для использования в рамках транзакции SSL. алиасы: key
cloud raw		Наименованное облако или конфигурация облака для работы. Если «cloud» — строка, она ссылается на конфигурацию облака с именем, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для «auth» и «auth_type». Этот параметр не нужен, если указан параметр «auth» или присутствуют переменные окружения OpenStack OS_*. Если «cloud» — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
dns_domain string		Значение DNS-домена для установки. Требуется openstacksdk>=0.29. Сеть будет использовать значения по умолчанию Openstack, если этот параметр не задан.
external boolean	Варианты: нет ← да	Указывает, доступна ли эта сеть извне.
interface string	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога служб. алиасы: endpoint_type
mtu_size integer		Значение максимального размера блока передачи (MTU) для адресования фрагментации. Сеть будет использовать значения по умолчанию OpenStack, если этот параметр не указан. Требуется openstacksdk>=0.18. алиасы: mtu
name string / required		Имя, которое будет назначено сети.
port_security_enabled boolean	Варианты: no yes	Включена ли защита портов для сети или нет. Сеть будет использовать значения по умолчанию OpenStack, если этот параметр не используется. Требуется openstacksdk>=0.18.
project string		Имя или идентификатор проекта, содержащего сеть (только для администратора)
provider_network_type string		Тип физической сети, сопоставленной с этим ресурсом сети.
provider_physical_network string		Физическая сеть, в которой реализован этот объект сети.
provider_segmentation_id integer		Изолированный сегмент в физической сети. Атрибут «network_type» определяет модель сегментации. Например, если значение «network_type» — vlan, этот идентификатор — идентификатор vlan. Если значение «network_type» — gre, этот идентификатор — ключ gre.
region_name string		Имя региона.
shared boolean	Варианты: нет ← да	Указывает, является ли эта сеть общей.
state string	Варианты: present ← absent	Указывает желаемое состояние ресурса.
timeout integer	По умолчанию: 180	Сколько времени Ansible должен ждать запрашиваемого ресурса.
validate_certs boolean	Варианты: нет ← да	Подтверждать ли запросы API SSL. До Ansible 2.3 это значение по умолчанию было `yes`. алиасы: verify
wait boolean	Варианты: нет да ←	Должен ли Ansible ждать завершения запрашиваемого ресурса.

Примечания

Примечание

Можно использовать стандартные переменные окружения OpenStack, такие как OS_USERNAME, вместо явного указания значений.
Информация об авторизации обрабатывается openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в задачах. Более подробную информацию можно найти на https://docs.openstack.org/openstacksdk/

Примеры

# Create an externally accessible network named 'ext_network'.
- openstack.cloud.network:
    cloud: mycloud
    state: present
    name: ext_network
    external: true

Значения возврата

Общие значения возврата описаны в этом разделе, следующие поля уникальны для этого модуля:

Ключ		Возвращаемое значение	Описание
network complex		При успехе, когда состояние равно 'present'.	Словарь, описывающий сеть.
	admin_state_up boolean	успех	Административное состояние сети. Пример: True
	dns_domain string	успех	Домен DNS ресурса сети. Пример: sample.openstack.org.
	id string	успех	Идентификатор сети. Пример: 4bb4f9a5-3bd2-4562-bf6a-d17a6341bb56
	mtu integer	успех	MTU ресурса сети.
	name string	успех	Имя сети. Пример: ext_network
	port_security_enabled boolean	успех	Статус защиты портов Пример: True
	provider:network_type string	успех	Тип физической сети, которая сопоставляется с этим ресурсом сети. Пример: vlan
	provider:physical_network string	успех	Физическая сеть, в которой реализован этот объект сети. Пример: my_vlan_net
	provider:segmentation_id string	успех	Изолированный сегмент в физической сети. Пример: 101
	router:external boolean	успех	Указывает, доступна ли эта сеть извне. Пример: True
	shared boolean	успех	Указывает, используется ли эта сеть всеми арендаторами.
	status string	успех	Статус сети. Пример: ACTIVE
	subnets list / elements=string	успех	Связанные подсети.
	tenant_id string	успех	Идентификатор арендатора. Пример: 06820f94b9f54b119636be2728d216fc

Авторы

OpenStack Ansible SIG

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/os_network_module.html