os_network – Создаёт/удаляет сети из OpenStack
Описание
- Добавление или удаление сети из OpenStack.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| admin_state_up логическое значение |
| Указывает, должно ли состояние быть отмечено как активное или неактивное. |
| api_timeout целое число | Время ожидания сокета при таймауте вызовов API. Если этот параметр опущен, он не будет передан библиотеке requests. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password, он должен содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры подключаемого модуля авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type строка | Имя подключаемого модуля авторизации для использования. Если облако использует аутентификацию, отличную от парольной, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone - | Игнорируется. Присутствует для обратной совместимости | |
| ca_cert строка | Путь к пакету CA-сертификатов, который может использоваться для проверки запросов SSL API. псевдонимы: cacert | |
| client_cert строка | Путь к клиенту-сертификату для использования в рамках SSL-транзакции. псевдонимы: cert | |
| client_key строка | Путь к ключу клиента для использования в рамках SSL-транзакции. псевдонимы: key | |
| cloud необработанный | Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в секции clouds.yaml. | |
| dns_domain - добавлен в 2.9 | Значение DNS-домена для установки. Сеть будет использовать значения по умолчанию OpenStack, если этот параметр не указан. | |
| external логическое значение |
| Указывает, доступна ли эта сеть извне. |
| interface строка |
| Тип URL-адреса конечной точки для получения из каталога служб. псевдонимы: endpoint_type |
| mtu целое число добавлен в 2.9 | Значение максимального размера транспортного блока (MTU) для предотвращения фрагментации. Сеть будет использовать значения по умолчанию OpenStack, если этот параметр не указан. Требуется openstacksdk>=0.18. | |
| name - / обязательно | Имя, которое будет присвоено сети. | |
| port_security_enabled логическое значение добавлен в 2.8 |
| Включена ли защита портов в сети. Сеть будет использовать значения по умолчанию OpenStack, если этот параметр не используется. Требуется openstacksdk>=0.18. |
| project - | Имя или ID проекта, содержащего сеть (только для администратора) | |
| provider_network_type - | Тип физической сети, который сопоставляется с этим ресурсом сети. | |
| provider_physical_network - | Физическая сеть, в которой реализован этот объект сети. | |
| provider_segmentation_id - | Изолированный сегмент на физической сети. Атрибут network_type определяет модель сегментации. Например, если значение network_type — vlan, этот идентификатор — идентификатор vlan. Если значение network_type — gre, этот идентификатор — ключ gre. | |
| region_name строка | Имя региона. | |
| shared логическое значение |
| Указывает, является ли эта сеть общей. |
| state - |
| Указывает желаемое состояние ресурса. |
| timeout целое число | Значение по умолчанию: 180 | Время ожидания Ansible для запрошенного ресурса. |
| validate_certs логическое значение |
| Указывает, должны ли проверяться запросы SSL API. До Ansible 2.3 это значение по умолчанию было yes. псевдонимы: verify |
| wait логическое значение |
| Должен ли Ansible ждать завершения запрошенного ресурса. |
Примечания
Примечание
- Стандартные переменные среды OpenStack, такие как
OS_USERNAME, могут быть использованы вместо явных значений. - Информация об аутентификации управляется openstacksdk, что означает, что значения могут поступать из файла yaml-конфигурации в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и наконец, явных параметров в playbooks. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
# Create an externally accessible network named 'ext_network'.
- os_network:
cloud: mycloud
state: present
name: ext_network
external: true
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| network сложный | При успехе, когда state имеет значение 'present'. | Словарь, описывающий сеть. | |
| admin_state_up булево | Административное состояние сети. Пример: True | ||
| dns_domain строка | Домен DNS ресурса сети. Требуется openstacksdk>=0.29. Пример: sample.openstack.org. | ||
| id строка | Идентификатор сети. Пример: 4bb4f9a5-3bd2-4562-bf6a-d17a6341bb56 | ||
| mtu целое число | MTU ресурса сети. | ||
| name строка | Имя сети. Пример: ext_network | ||
| port_security_enabled булево | Статус безопасности портов Пример: True | ||
| provider:network_type строка | Тип физической сети, которая отображается на этом сетевом ресурсе. Пример: vlan | ||
| provider:physical_network строка | Физическая сеть, в которой реализован этот сетевой объект. Пример: my_vlan_net | ||
| provider:segmentation_id строка | Изолированный сегмент в физической сети. Пример: 101 | ||
| router:external булево | Указывает, доступна ли эта сеть извне. Пример: True | ||
| shared булево | Указывает, используется ли эта сеть всеми арендаторами. | ||
| status строка | Статус сети. Пример: ACTIVE | ||
| subnets список | Связанные подсети. | ||
| tenant_id строка | Идентификатор арендатора. Пример: 06820f94b9f54b119636be2728d216fc | ||
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Monty Taylor (@emonty)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/os_network_module.html
