os_networks_facts – Получение фактов о одной или нескольких сетях OpenStack.
Новое в версии 2.0.
Краткое описание
- Получение фактов о одной или нескольких сетях из OpenStack.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
- sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout - | Сколько времени должна ждать сокетная прослойка, прежде чем истечет время ожидания для вызовов API. Если этот параметр опущен, он не будет передан в библиотеку requests. | |
| 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_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| filters - | Словарь метаданных для дальнейшей фильтрации. Элементы этого словаря могут быть дополнительными словарями. | |
| interface - добавлено в 2.3 |
| Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| key - | Путь к ключу клиента для использования в рамках SSL транзакции. | |
| name - | Имя или идентификатор сети | |
| region_name - | Имя региона. | |
| timeout - | По умолчанию: 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. |
| verify boolean |
| Должны ли выполняться проверки запросов SSL API. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait boolean |
| Должен ли 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
Примеры
- 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 complex | всегда, но может быть null | содержит все факты OpenStack о сетях | |
| id string | успех | Уникальный UUID. | |
| name string | успех | Имя, заданное для сети. | |
| shared boolean | успех | Флаг совместной сети. | |
| status string | успех | Статус сети. | |
| subnets список строк | успех | Подсети, включенные в эту сеть. | |
| tenant_id string | успех | Идентификатор арендатора, связанный с этой сетью. | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/os_networks_facts_module.html