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-вызовов. Если этот параметр опущен, он не будет передан в библиотеку 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 строка | Имя или 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/routers_info_module.html
