os_router - Создание или удаление маршрутизаторов из OpenStack
Новая версия 2.0.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Значения возврата
- Примечания
Обзор
- Создание или удаление маршрутизаторов из OpenStack. Хотя Neutron позволяет маршрутизаторам использовать одинаковые имена, этот модуль обеспечивает уникальность имен для удобства пользователя.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- shade
Параметры
| параметр | обязательно | по умолчанию | выбор | примечания |
|---|---|---|---|---|
| admin_state_up | нет | True | Желаемое административное состояние созданного или существующего маршрутизатора. | |
| api_timeout | нет | None | Сколько времени должна ждать транспортная сокета, прежде чем произойдёт таймаут вызовов API. Если это значение опущено, оно не будет передано библиотеке requests. | |
| 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_*. | ||
| enable_snat | нет | True | Включить атрибут Source NAT (SNAT). | |
| endpoint_type | нет | public |
| Тип URL конечной точки для извлечения из каталога служб. |
| external_fixed_ips | нет | None | Параметры IP-адреса для внешней сетевой шлюз. Каждый - это словарь с именем или идентификатором подсети (subnet) и IP-адресом для назначения в подсети (ip). Если IP не указан, он автоматически назначается из этой подсети. | |
| interfaces | нет | None | Список подсетей для подключения к внутренней интерфейсу маршрутизатора. | |
| key | нет | None | Путь к клиенту ключу для использования в процессе SSL. | |
| name | да | Имя, которое нужно дать маршрутизатору | ||
| network | нет | None | Уникальное имя или ID внешней сетевой шлюз. обязательно, если предоставлены interfaces или enable_snat. | |
| project (добавлено в 2.2)
| нет | None | Уникальное имя или ID проекта. | |
| region_name | нет | Имя региона. | ||
| state | нет | present |
| Укажите желаемое состояние ресурса |
| timeout | нет | 180 | Сколько времени Ansible должен ждать запрошенного ресурса. | |
| validate_certs | нет | Проверять ли запросы SSL API. До версии 2.3 по умолчанию True. алиасы: verify | ||
| wait | нет | да |
| Должен ли Ansible дождаться завершения запрошенного ресурса. |
Примеры
# Create a simple router, not attached to a gateway or subnets.
- os_router:
cloud: mycloud
state: present
name: simple_router
# Create a simple router, not attached to a gateway or subnets for a given project.
- os_router:
cloud: mycloud
state: present
name: simple_router
project: myproj
# Creates a router attached to ext_network1 on an IPv4 subnet and one
# internal subnet interface.
- os_router:
cloud: mycloud
state: present
name: router1
network: ext_network1
external_fixed_ips:
- subnet: public-subnet
ip: 172.24.4.2
interfaces:
- private-subnet
# Update existing router1 external gateway to include the IPv6 subnet.
# Note that since 'interfaces' is not provided, any existing internal
# interfaces on an existing router will be left intact.
- os_router:
cloud: mycloud
state: present
name: router1
network: ext_network1
external_fixed_ips:
- subnet: public-subnet
ip: 172.24.4.2
- subnet: ipv6-public-subnet
ip: 2001:db8::3
# Delete router1
- os_router:
cloud: mycloud
state: absent
name: router1
Значения возврата
Общие значения возврата описаны здесь Значения возврата, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| router | Словарь, описывающий маршрутизатор. | При успехе, когда 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
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь с Информация о сообществе и участие, Тестирование 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_router_module.html
