os_network — Создаёт/удаляет сети из OpenStack
Новая в версии 2.0.
Обзор
- Добавление или удаление сети из OpenStack.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| admin_state_up bool |
| Указывает, должно ли состояние быть отмечено как активное или неактивное. |
| api_timeout | Сколько времени должен ждать уровень сокета перед истечением времени ожидания для вызовов API. Если это значение опущено, оно не будет передано библиотеке requests. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password это будет содержать auth_url, username, password, project_name и любую информацию о домене, если облако её поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры подключаемого модуля авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | |
| auth_type | Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме парольной авторизации, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к пакету сертификатов CA, который может быть использован в процессе проверки SSL-запросов API. | |
| cert | Путь к клиенту сертификат для использования в рамках транзакции SSL. | |
| cloud | Имя облака или конфигурация облака для работы. Если cloud является строкой, она ссылается на конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные среды OpenStack OS_* . Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| external bool |
| Указывает, доступна ли эта сеть извне. |
| interface (добавлен в 2.3) |
| Тип URL-адреса конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| key | Путь к ключу клиента для использования в рамках транзакции SSL. | |
| name обязательно | Имя, которое будет назначено сети. | |
| project (добавлен в 2.1) | Имя или идентификатор проекта, содержащего сеть (только для администратора) | |
| provider_network_type (добавлен в 2.1) | Тип физической сети, который сопоставляется с этим ресурсом сети. | |
| provider_physical_network (добавлен в 2.1) | Физическая сеть, в которой реализован этот объект сети. | |
| provider_segmentation_id (добавлен в 2.1) | Изолированный сегмент на физической сети. Атрибут network_type определяет модель сегментации. Например, если значение network_type равно vlan, этот идентификатор является идентификатором vlan. Если значение network_type равно gre, этот идентификатор является ключом gre. | |
| region_name | Имя региона. | |
| shared bool |
| Указывает, является ли эта сеть общей или нет. |
| state |
| Указывает желаемое состояние ресурса. |
| timeout | По умолчанию: 180 | Сколько времени Ansible должен ждать запрашиваемый ресурс. |
| verify bool |
| Указывает, должны ли быть проверены SSL-запросы API. До версии 2.3 это значение по умолчанию было True. псевдонимы: validate_certs |
| wait bool |
| Должен ли Ansible ждать завершения запрашиваемого ресурса. |
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в задачах. Дополнительную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config
Примеры
# Create an externally accessible network named 'ext_network'.
- os_network:
cloud: mycloud
state: present
name: ext_network
external: true
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| network сложный | При успехе, когда state равно 'present'. | Словарь, описывающий сеть. | |
| id строка | Идентификатор сети. Пример: 4bb4f9a5-3bd2-4562-bf6a-d17a6341bb56 | ||
| name строка | Имя сети. Пример: ext_network | ||
| shared булево | Указывает, является ли эта сеть общей для всех арендаторов. | ||
| status строка | Состояние сети. Пример: ACTIVE | ||
| mtu целое число | MTU ресурса сети. | ||
| admin_state_up булево | Административное состояние сети. Пример: True | ||
| port_security_enabled булево | Состояние безопасности портов Пример: True | ||
| router:external булево | Указывает, доступна ли эта сеть извне. Пример: True | ||
| tenant_id строка | Идентификатор арендатора. Пример: 06820f94b9f54b119636be2728d216fc | ||
| subnets список | Связанные подсети. | ||
| provider:physical_network строка | Физическая сеть, где реализован этот объект сети. Пример: my_vlan_net | ||
| provider:network_type строка | Тип физической сети, которая сопоставляется с этим ресурсом сети. Пример: vlan | ||
| provider:segmentation_id строка | Изолированный сегмент в физической сети. Пример: 101 | ||
Состояние
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом 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.6/modules/os_network_module.html
