openstack.cloud.network – Создаёт/удаляет сети из OpenStack
Примечание
Этот плагин является частью коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в плейбуке укажите: openstack.cloud.network.
Описание
- Добавление или удаление сети из OpenStack.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| admin_state_up boolean |
| Указывает, должно ли состояние сети быть отмечено как активное или неактивное. |
| api_timeout integer | Сколько времени сокет-слой должен ждать перед истечением времени ожидания для вызовов API. Если этот параметр опущен, библиотека requests не получит его. | |
| auth dictionary | Словарь, содержащий информацию об авторизации, необходимую стратегии подключения облака. Для стандартного плагина password он будет содержать 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, который может быть использован при проверке SSL-запросов к API. псевдонимы: 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 |
| Тип URL-адреса конечной точки для получения из каталога служб. псевдонимы: endpoint_type |
| mtu_size integer | Значение максимального размера передачи (MTU) для устранения фрагментации. Сеть будет использовать значения по умолчанию OpenStack, если этот параметр не предоставлен. Требуется openstacksdk>=0.18. псевдонимы: mtu | |
| name string / required | Имя, которое будет присвоено сети. | |
| port_security_enabled boolean |
| Указывает, включена ли безопасность портов в сети. Сеть будет использовать значения по умолчанию OpenStack, если этот параметр не используется. Требуется openstacksdk>=0.18. |
| project string | Имя или ID проекта, содержащего сеть (только для администраторов). | |
| 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 |
| Указывает желаемое состояние ресурса. |
| timeout integer | Значение по умолчанию: 180 | Сколько времени Ansible должен ждать требуемого ресурса. |
| validate_certs boolean |
| Указывает, должны ли быть проверены SSL-запросы к API. До 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/openstack/cloud/network_module.html
