openstack.cloud.os_routers_info – Получение информации об одном или нескольких маршрутизаторах OpenStack.
Примечание
Этот плагин входит в состав коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в playbook, укажите: openstack.cloud.os_routers_info.
Обзор
- Получение информации об одном или нескольких маршрутизаторах из OpenStack.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_timeout целое число | Сколько времени должно ожидать уровень сокета, прежде чем истечет время ожидания для вызовов API. Если это значение опущено, оно не будет передано библиотеке requests. | ||
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать любые требуемые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | ||
| auth_type строка | Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя подключаемого модуля следует указать здесь, и содержимое параметра auth следует соответствующим образом обновить. | ||
| availability_zone строка | Игнорируется. Присутствует для обратной совместимости | ||
| ca_cert строка | Путь к пакету CA-сертификатов, который можно использовать для проверки запросов SSL API. псевдонимы: cacert | ||
| client_cert строка | Путь к клиенту сертификат для использования в рамках транзакции SSL. псевдонимы: cert | ||
| client_key строка | Путь к ключу клиента для использования в рамках транзакции SSL. псевдонимы: key | ||
| cloud сырой | Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные среды OpenStack OS_* . Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | ||
| filters словарь | Словарь метаданных для дальнейшего фильтрации. Элементы этого словаря могут быть дополнительными словарями. | ||
| admin_state_up булево |
| Фильтр результатов списка по административному состоянию ресурса, которое равно включено (true) или выключено (false). | |
| description строка | Фильтр результатов списка по описанию ресурса, читаемому человеком. | ||
| name строка | Фильтр результатов списка по имени ресурса, читаемому человеком. | ||
| project_id строка | Фильтр результатов списка по идентификатору проекта, которому принадлежит ресурс. псевдонимы: tenant_id | ||
| revision_number целое число | Фильтр результатов списка по номеру ревизии ресурса. | ||
| tags список / элементы=строка | Список тегов для фильтрации результатов списка. Будут возвращены ресурсы, соответствующие всем тегам в этом списке. | ||
| interface строка |
| Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type | |
| name строка | Имя или идентификатор маршрутизатора | ||
| region_name строка | Имя региона. | ||
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должен ждать запрошенного ресурса. | |
| validate_certs булево |
| Требуется ли проверка запросов SSL API. До Ansible 2.3 это значение по умолчанию было yes.псевдонимы: verify | |
| wait булево |
| Ansible должен ждать завершения запрошенного ресурса. | |
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в playbooks. Более подробную информацию можно найти на странице https://docs.openstack.org/openstacksdk/
Примеры
- name: Gather information about routers
openstack.cloud.routers_info:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
register: result
- name: Show openstack routers
debug:
msg: "{{ result.openstack_routers }}"
- name: Gather information about a router by name
openstack.cloud.routers_info:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
name: router1
register: result
- name: Show openstack routers
debug:
msg: "{{ result.openstack_routers }}"
- name: Gather information about a router with filter
openstack.cloud.routers_info:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
filters:
tenant_id: bc3ea709c96849d6b81f54640400a19f
register: result
- name: Show openstack routers
debug:
msg: "{{ result.openstack_routers }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| openstack_routers сложный | всегда, но может быть пустым | содержит всю информацию OpenStack о маршрутизаторах | |
| distributed булево | успех | Указывает на распределенный маршрутизатор. | |
| external_gateway_info словарь | успех | Информация о внешнем шлюзе маршрутизатора. | |
| ha булево | успех | Указывает на высокодоступный маршрутизатор. | |
| id строка | успех | Уникальный UUID. | |
| interfaces_info список / элементы=строка | успех | Список подключенных интерфейсов. | |
| name строка | успех | Имя, присвоенное маршрутизатору. | |
| project_id строка | успех | Идентификатор проекта, связанный с этим маршрутизатором. | |
| routes список / элементы=строка | успех | Дополнительная конфигурация маршрутов для L3-маршрутизатора. | |
| status строка | успех | Статус маршрутизатора. | |
Авторы
- OpenStack Ansible SIG
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/os_routers_info_module.html
