os_networks_facts - Получение фактов о одной или нескольких сетях OpenStack.

Новое в версии 2.0.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

Получение фактов о одной или нескольких сетях из OpenStack.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

python >= 2.6
python >= 2.7
shade

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout		Сколько времени должно ожидать уровень сокета перед истечением времени ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов.
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)	Варианты: public ← internal admin	Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type
key		Путь к ключу клиента, который будет использоваться в рамках транзакции SSL.
name		Имя или ID сети
region_name		Имя региона.
timeout	Значение по умолчанию: 180	Сколько времени ansible должно ждать запрашиваемый ресурс.
verify	Варианты: no yes	Нужно ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs
wait	Варианты: no yes ←	Должен ли 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 сложное		всегда, но может быть null	содержит все факты OpenStack о сетях
	status строка	успех	Статус сети.
	subnets список строк	успех	Подсети, включённые в эту сеть.
	name строка	успех	Имя, заданное сети.
	shared логическое	успех	Флаг общего доступа к сети.
	tenant_id строка	успех	Идентификатор клиента, связанный с этой сетью.
	id строка	успех	Уникальный UUID.

Статус

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

Автор

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.5/modules/os_networks_facts_module.html