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, который может быть использован для проверки запросов API SSL.
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		Имя или ID сети
region_name		Имя региона.
timeout	По умолчанию: 180	Сколько времени Ansible должно ждать запрошенного ресурса.
verify bool	Варианты: нет да	Нужно ли проверять запросы API SSL. До версии 2.3 это было по умолчанию True. псевдонимы: validate_certs
wait bool	Варианты: нет да ←	Должен ли 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 сложный		всегда, но может быть пустым	содержит все данные OpenStack о сетях
	id строка	успех	Уникальный UUID.
	name строка	успех	Имя, заданное сети.
	status строка	успех	Статус сети.
	subnets список строк	успех	Подсеть(и), включённые в эту сеть.
	tenant_id строка	успех	Идентификатор клиента, связанный с этой сетью.
	shared булево	успех	Флаг совместного использования сети.

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Поддержка модулей и техническое обслуживание для получения дополнительной информации.

Список других модулей, также поддерживаемых сообществом 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.6/modules/os_networks_facts_module.html