Модуль openstack.cloud.networks_info — получение информации об одной или нескольких сетях OpenStack.

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.networks_info.

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

Краткое описание

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

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout integer	Как долго уровень сокетов должен ждать ответа, прежде чем прервать вызовы API по тайм-ауту. Если параметр не задан, библиотеке requests ничего не передаётся.
auth dictionary	Словарь с данными аутентификации, необходимыми для стратегии плагина аутентификации облака. Для стандартного плагина password в нём должны быть указаны auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов в параметре необходимо указать все значения, требуемые соответствующим плагином аутентификации. Этот параметр не требуется, если указано именованное облако или заданы переменные среды OpenStack OS_*.
auth_type string	Имя используемого плагина аутентификации. Если облако использует не парольную аутентификацию, здесь следует указать имя плагина и соответствующим образом заполнить параметр auth.
ca_cert псевдонимы: cacert string	Путь к пакету сертификатов центра сертификации, используемому для проверки SSL-запросов API.
client_cert псевдонимы: cert string	Путь к сертификату клиента, используемому при SSL-обмене данными.
client_key псевдонимы: key string	Путь к ключу клиента, используемому при SSL-обмене данными.
cloud any	Именованное облако или конфигурация облака, с которыми выполняются операции. Если cloud — строка, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Задаёт значения по умолчанию для auth и auth_type. Этот параметр не требуется, если задан auth или присутствуют переменные среды OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, аналогичную конфигурации в разделе файла clouds.yaml.
filters dictionary	Словарь метаданных для дополнительной фильтрации. Элементы этого словаря могут быть дополнительными словарями.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, получаемый из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name string	Имя или идентификатор сети
region_name string	Имя региона.
sdk_log_level string	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если значение не задано, журнал не ведётся.
timeout integer	Как долго Ansible должен ждать запрошенный ресурс. По умолчанию: `180`
validate_certs псевдонимы: verify boolean	Следует ли проверять SSL-запросы API. До Ansible 2.3 значение по умолчанию было `true`. Варианты: `false` `true`
wait boolean	Должен ли Ansible ждать завершения подготовки запрошенного ресурса. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Вместо явного указания значений можно использовать стандартные переменные среды 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.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.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.networks }}"

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

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

Ключ	Описание
networks list / элементы=dictionary	содержит все сведения OpenStack о сетях Возвращается: всегда, но список может быть пустым
availability_zone_hints string	Подсказки по зонам доступности Возвращается: при успешном выполнении
availability_zones string	Зоны доступности Возвращается: при успешном выполнении
created_at string	Метка времени создания Возвращается: при успешном выполнении
description string	Описание Возвращается: при успешном выполнении
dns_domain string	Домен DNS Возвращается: при успешном выполнении
id string	Идентификатор Возвращается: при успешном выполнении
ipv4_address_scope_id string	Идентификатор области адресов IPv4 Возвращается: при успешном выполнении
ipv6_address_scope_id string	Идентификатор области адресов IPv6 Возвращается: при успешном выполнении
is_admin_state_up string	Включено ли состояние администратора Возвращается: при успешном выполнении
is_default string	Является ли сетью по умолчанию Возвращается: при успешном выполнении
is_port_security_enabled string	Включена ли защита портов Возвращается: при успешном выполнении
is_router_external string	Является ли сеть внешней для маршрутизатора Возвращается: при успешном выполнении
is_shared string	Является ли сеть общей Возвращается: при успешном выполнении
is_vlan_transparent string	Является ли VLAN прозрачным Возвращается: при успешном выполнении
mtu string	MTU Возвращается: при успешном выполнении
name string	Имя Возвращается: при успешном выполнении
project_id string	Идентификатор проекта Возвращается: при успешном выполнении
provider_network_type string	Тип сети провайдера Возвращается: при успешном выполнении
provider_physical_network string	Физическая сеть провайдера Возвращается: при успешном выполнении
provider_segmentation_id string	Идентификатор сегментации провайдера Возвращается: при успешном выполнении
qos_policy_id string	Идентификатор политики QoS Возвращается: при успешном выполнении
revision_number string	Номер редакции Возвращается: при успешном выполнении
segments string	Сегменты Возвращается: при успешном выполнении
status string	Состояние Возвращается: при успешном выполнении
subnet_ids string	Идентификаторы подсетей Возвращается: при успешном выполнении
tags string	Теги Возвращается: при успешном выполнении
updated_at string	Метка времени обновления Возвращается: при успешном выполнении

Авторы

OpenStack Ansible SIG

Ссылки на коллекцию

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