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

Примечание

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

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

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

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

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

Описание

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

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

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

Авторы

OpenStack Ansible SIG

Ссылки на сборку

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