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

Примечание

Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Для использования в плейбуке укажите: openstack.cloud.os_networks_info.

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

Обзор

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

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должен ожидать уровень сокета перед истечением времени ожидания для API-вызовов. Если это опущено, ничего не будет передано библиотеке requests.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для стандартного плагина password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые для плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка		Имя плагина авторизации для использования. Если облако использует что-то помимо парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть обновлено соответствующим образом.
availability_zone строка		Игнорируется. Присутствует для обратной совместимости
ca_cert строка		Путь к пакету CA Cert, который может использоваться для проверки 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 строка	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type
name строка		Имя или ID сети
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 information about previously created networks
  openstack.cloud.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
  openstack.cloud.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
  openstack.cloud.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 строка	успешно	Идентификатор клиента, связанный с этой сетью.

Авторы

OpenStack Ansible SIG

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/os_networks_info_module.html