os_networks_facts – Получение фактов о одной или нескольких сетях OpenStack
Новая в версии 2.0.
Обзор
- Получение фактов о одной или нескольких сетях из OpenStack.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
- sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должно ждать подключение сокета перед истечением времени ожидания для API-вызовов. Если этот параметр опущен, ничего не будет передано в библиотеку запросов. | |
| auth словарь | Словарь, содержащий информацию об аутентификации, необходимую стратегии плагина аутентификации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_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 - | Словарь метаданных для дальнейшей фильтрации. Элементы этого словаря могут быть дополнительными словарями. | |
| interface строка добавлен в 2.3 |
| Тип 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, затем из стандартных переменных окружения, а затем, наконец, из явных параметров в задачах. Более подробную информацию можно найти на странице https://docs.openstack.org/openstacksdk/
Примеры
- name: Gather facts about previously created networks
os_networks_facts:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
- name: Show openstack networks
debug:
var: openstack_networks
- name: Gather facts about a previously created network by name
os_networks_facts:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
name: network1
- name: Show openstack networks
debug:
var: openstack_networks
- name: Gather facts about a previously created network with filter
# Note: name and filters parameters are Not mutually exclusive
os_networks_facts:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
filters:
tenant_id: 55e2ce24b2a245b09f181bf025724cbe
subnets:
- 057d4bdf-6d4d-4728-bb0f-5ac45a6f7400
- 443d4dc0-91d4-4998-b21c-357d10433483
- name: Show openstack networks
debug:
var: openstack_networks
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| openstack_networks сложный | всегда, но может быть null | содержит все данные OpenStack о сетях | |
| id строка | успех | Уникальный UUID. | |
| name строка | успех | Имя, заданное сети. | |
| shared логический | успех | Флаг совместного использования сети. | |
| status строка | успех | Статус сети. | |
| subnets список строк | успех | Подсети, включённые в данную сеть. | |
| tenant_id строка | успех | ID арендатора, связанный с данной сетью. | |
Статус
- Этот модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Davide Agnello (@dagnello)
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/os_networks_facts_module.html
