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