openstack.cloud.routers_info – Получение информации об одном или нескольких маршрутизаторах OpenStack.
Примечание
Этот плагин входит в состав коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud
Чтобы использовать его в книге задач, укажите: openstack.cloud.routers_info
Обзор
- Получение информации об одном или нескольких маршрутизаторах из OpenStack.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором будет выполняться этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_timeout целое число | Сколько времени должен ждать уровень сокета перед истечением времени ожидания для вызовов API. Если этот параметр опущен, в библиотеку запросов ничего не будет передано. | ||
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все параметры, необходимые этому плагину авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | ||
| auth_type строка | Имя плагина авторизации, который следует использовать. Если облако использует что-то помимо аутентификации по паролю, имя плагина следует указать здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | ||
| availability_zone строка | Игнорируется. Присутствует для обратной совместимости | ||
| ca_cert строка | Путь к пакету сертификата CA, который может использоваться для проверки запросов API SSL. псевдонимы: 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 строка | Имя или ID маршрутизатора | ||
| region_name строка | Имя региона. | ||
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. | |
| validate_certs логическое значение |
| Необходимо ли проверять запросы API SSL. До Ansible 2.3 это имело значение по умолчанию yesпсевдонимы: verify | |
| wait логическое значение |
| Должен ли Ansible ожидать завершения запрошенного ресурса. | |
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо указания явных значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, а затем из стандартных переменных среды, и, наконец, из явных параметров в задачах. Дополнительную информацию можно найти по адресу 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 сложный тип | всегда, но может быть null | содержит всю информацию OpenStack о маршрутизаторах | |
| distributed логическое значение | успех | Указывает на распределенный маршрутизатор. | |
| external_gateway_info словарь | успех | Информация о внешнем шлюзе маршрутизатора. | |
| ha логическое значение | успех | Указывает на высокодоступный маршрутизатор. | |
| id строка | успех | Уникальный UUID. | |
| interfaces_info список / элементы=строка | успех | Список подключенных интерфейсов. | |
| name строка | успех | Имя, присвоенное маршрутизатору. | |
| project_id строка | успех | Идентификатор проекта, связанный с этим маршрутизатором. | |
| routes список / элементы=строка | успех | Дополнительная конфигурация маршрутов для L3 маршрутизатора. | |
| status строка | успех | Статус маршрутизатора. | |
Авторы
- OpenStack Ansible SIG
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/openstack/cloud/routers_info_module.html
