os_networks_info – Получение информации об одной или нескольких сетях OpenStack

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

Описание

Получение информации об одной или нескольких сетях из OpenStack.
Этот модуль назывался os_networks_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль os_networks_info больше не возвращает ansible_facts!

Псевдонимы: os_networks_facts

Требования

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

openstacksdk >= 0.12.0
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, который можно использовать в качестве части проверки запросов API SSL. псевдонимы: 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 строка	Варианты: admin internal public ←	Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type
name -		Имя или ID сети
region_name строка		Имя региона.
timeout целое число	По умолчанию: 180	Сколько времени Ansible должен ждать запрошенного ресурса.
validate_certs булево	Варианты: no ← yes	Необходимо ли проверять запросы API SSL. До Ansible 2.3 это было установлено по умолчанию как `yes`. псевдонимы: verify
wait булево	Варианты: no yes ←	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 previously created networks
  os_networks_info:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
  register: result

- name: Show openstack networks
  debug:
    msg: "{{ result.openstack_networks }}"

- name: Gather information about a previously created network by name
  os_networks_info:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
    name:  network1
  register: result

- name: Show openstack networks
  debug:
    msg: "{{ result.openstack_networks }}"

- name: Gather information about a previously created network with filter
  # Note: name and filters parameters are Not mutually exclusive
  os_networks_info:
    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
  register: result

- name: Show openstack networks
  debug:
    msg: "{{ result.openstack_networks }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:

Ключ		Возвращаемое значение	Описание
openstack_networks сложное		всегда, но может быть null	содержит всю информацию OpenStack о сетях
	id строка	успех	Уникальный UUID.
	name строка	успех	Имя, присвоенное сети.
	shared булево	успех	Флаг общности сети.
	status строка	успех	Статус сети.
	subnets список строк	успех	Подсети, включенные в эту сеть.
	tenant_id строка	успех	ID арендатора, связанный с этой сетью.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [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.9/modules/os_networks_info_module.html