os_router - Создание или удаление маршрутизаторов из OpenStack
Новая версия 2.0.
Описание
- Создание или удаление маршрутизаторов из OpenStack. Хотя Neutron позволяет маршрутизаторам использовать одинаковые имена, этот модуль обеспечивает уникальность имён для лучшей работы с пользователем.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| admin_state_up | Значение по умолчанию: да | Желаемое административное состояние созданного или существующего маршрутизатора. |
| api_timeout | Время ожидания сокетом перед истечением времени ожидания для вызовов API. Если это опущено, ничего не будет передано библиотеке запросов. | |
| 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_*. | |
| enable_snat |
| Включить атрибут Source NAT (SNAT). |
| external_fixed_ips | Значение по умолчанию: None | Параметры IP-адреса для внешней сети шлюза. Каждый — словарь с именем или ID подсети (subnet) и IP-адресом для назначения в подсети (ip). Если IP не указан, он автоматически назначается из этой подсети. |
| interface (добавлено в 2.3) |
| Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| interfaces | Значение по умолчанию: None | Список подсетей для подключения к внутреннему интерфейсу маршрутизатора. Внешний шлюз, связанный с подсетью, будет автоматически подключен к внутреннему интерфейсу маршрутизатора. Чтобы указать IP-адрес, отличный от шлюза по умолчанию, передаются параметры в виде словаря с ключами как имя или ID сети (net), имя или ID подсети (subnet) и IP порта (portip) из сети. Пользовательский portip часто требуется, когда несколько маршрутизаторов должны быть подключены к одной подсети, для которой уже был использован шлюз по умолчанию. |
| key | Путь к ключу клиента для использования в рамках транзакции SSL. | |
| name обязательно | Имя для маршрутизатора | |
| network | Значение по умолчанию: None | Уникальное имя или ID внешней сети шлюза. требуется, если указаны interfaces или enable_snat. |
| project (добавлено в 2.2) | Значение по умолчанию: None | Уникальное имя или ID проекта. |
| region_name | Имя региона. | |
| state |
| Указывает желаемое состояние ресурса |
| timeout | Значение по умолчанию: 180 | Сколько времени Ansible будет ждать запрашиваемого ресурса. |
| verify |
| Нужно ли проверять запросы SSL API. До версии 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 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
# Create another router with two internal subnet interfaces.One with user defined port
# ip and another with default gateway.
- os_router:
cloud: mycloud
state: present
name: router2
network: ext_network1
interfaces:
- net: private-net
subnet: private-subnet
portip: 10.1.1.10
- project-subnet
# Create another router with two internal subnet interface.One with user defined port
# ip and and another with default gateway.
- os_router:
cloud: mycloud
state: present
name: router2
network: ext_network1
interfaces:
- net: private-net
subnet: private-subnet
portip: 10.1.1.10
- project-subnet
# Create another router with two internal subnet interface. one with user defined port
# ip and and another with default gateway.
- os_router:
cloud: mycloud
state: present
name: router2
network: ext_network1
interfaces:
- net: private-net
subnet: private-subnet
portip: 10.1.1.10
- project-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 сложный | При успехе, когда state равен 'present' | Словарь, описывающий маршрутизатор. | |
| status строка | Статус маршрутизатора. Пример: АКТИВЕН | ||
| external_gateway_info словарь | Параметры внешнего шлюза. Пример: {'enable_snat': True, 'external_fixed_ips': [{'subnet_id': '4272cb52-a456-4c20-8f3c-c26024ecfa81', 'ip_address': '10.6.6.99'}]} | ||
| name строка | Имя маршрутизатора. Пример: router1 | ||
| admin_state_up булево | Административное состояние маршрутизатора. Пример: True | ||
| routes список | Конфигурация дополнительных маршрутов для L3 маршрутизатора. | ||
| tenant_id строка | Идентификатор арендатора. Пример: 861174b82b43463c9edc5202aadc60ef | ||
| id строка | Идентификатор маршрутизатора. Пример: 474acfe5-be34-494c-b339-50f06aa143e4 | ||
Статус
Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- David Shrewsbury (@Shrews)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_router_module.html