os_network - Создание/удаление сетей из OpenStack
Новая в версии 2.0.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Добавление или удаление сети из OpenStack.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- shade
Параметры
| параметр | обязателен | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| admin_state_up | нет | True | Указать, должно ли состояние быть установлено как активное или неактивное. | |
| api_timeout | нет | None | Сколько времени должна ждать транспортная обёртка (socket layer), прежде чем истечёт таймаут для API-запросов. Если этот параметр опущен, то в библиотеку запросов ничего не передастся. | |
| auth | нет | Словарь, содержащий информацию об авторизации, необходимую стратегии подключения облака. Для стандартного плагина password он должен содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | ||
| auth_type | нет | password | Имя плагина авторизации, используемого для подключения. Если облако использует что-то кроме аутентификации по паролю, имя плагина следует указать здесь, а содержимое параметра auth следует обновить соответственно. | |
| availability_zone | нет | Игнорируется. Присутствует для обратной совместимости | ||
| cacert | нет | None | Путь к сертификату CA, который можно использовать для проверки SSL-API-запросов. | |
| cert | нет | None | Путь к клиенту сертификату, который следует использовать в рамках SSL-транзакции. | |
| cloud | нет | Имя облака для работы. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или если присутствуют переменные среды OpenStack OS_*. | ||
| endpoint_type | нет | public |
| Тип URL-адреса конечной точки, который нужно извлечь из каталога сервисов. |
| external | нет | Доступна ли эта сеть извне. | ||
| key | нет | None | Путь к ключу клиента, который следует использовать в рамках SSL-транзакции. | |
| name | да | Имя, которое нужно присвоить сети. | ||
| project (добавлено в 2.1)
| нет | None | Имя или ID проекта, содержащего сеть (только для администраторов) | |
| 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 | нет | present |
| Указать желаемое состояние ресурса. |
| timeout | нет | 180 | Сколько времени Ansible ожидает запрашиваемый ресурс. | |
| validate_certs | нет | Следует ли проверять SSL-API-запросы. До версии 2.3 по умолчанию было True. алиасы: verify | ||
| wait | нет | yes |
| Должен ли Ansible ждать завершения запрошенного ресурса. |
Примеры
# Create an externally accessible network named 'ext_network'.
- os_network:
cloud: mycloud
state: present
name: ext_network
external: true
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| network | Словарь, описывающий сеть. | При успехе, когда I(state) равно 'present'. | сложный | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| содержит: |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Примечания
Примечание
- Стандартные переменные среды 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
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Для получения помощи в разработке модулей, если вас это интересует, пожалуйста, прочитайте Документация сообщества и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_network_module.html
