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

Примечание

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

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

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

Для использования в книге задач укажите: openstack.cloud.subnets_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 псевдонимы: subnet строка	Имя или ID подсети. Псевдоним ‘subnet’ добавлен в версии 2.8.
region_name строка	Имя региона.
sdk_log_level строка	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к лог-файлу OpenStackSDK. Если пусто, журнал не записывается
timeout целое число	Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify логическое	Проверять или нет запросы SSL API. До 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, затем из стандартных переменных окружения, и, наконец, из явных параметров в playbook. Более подробная информация доступна по адресу https://docs.openstack.org/openstacksdk/

Примеры

- name: Gather information about previously created subnets
  openstack.cloud.subnets_info:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
  register: result

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

- name: Gather information about a previously created subnet by name
  openstack.cloud.subnets_info:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
    name: subnet1
  register: result

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

- name: Gather information about a previously created subnet with filter
  # Note: name and filters parameters are not mutually exclusive
  openstack.cloud.subnets_info:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
    filters:
      project_id: 55e2ce24b2a245b09f181bf025724cbe
  register: result

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

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

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

Ключ	Описание
subnets list / elements=dictionary	содержит всю информацию OpenStack о подсетях Возвращается: всегда, но может быть пустым списком
allocation_pools list / elements=dictionary	Пулы выделения, связанные с этой подсетью. Возвращается: при успехе
cidr string	CIDR подсети. Возвращается: при успехе
created_at string	Дата и время создания ресурса. Возвращается: при успехе
description string	Описание подсети. Возвращается: при успехе
dns_nameservers list / elements=string	DNS-серверы для этой подсети. Возвращается: при успехе
dns_publish_fixed_ip string	Публиковать ли DNS-записи для IP-адресов из этой подсети. Возвращается: при успехе
gateway_ip string	Шлюз подсети. Возвращается: при успехе
host_routes list / elements=dictionary	Дополнительные маршруты для подсети. Возвращается: при успехе
id string	ID подсети. Возвращается: при успехе
ip_version integer	Версия IP для этой подсети. Возвращается: при успехе
ipv6_address_mode string	Режим адресации IPv6 определяет механизмы назначения IP-адресов. Возвращается: при успехе
ipv6_ra_mode string	Реклама маршрутизатора IPv6 указывает, должна ли служба сети передавать пакеты ICMPv6 для подсети. Возвращается: при успехе
is_dhcp_enabled boolean	Включен ли DHCP. Возвращается: при успехе
name string	Имя, данное подсети. Возвращается: при успехе
network_id string	ID сети, к которой принадлежит эта подсеть. Возвращается: при успехе
prefix_length string	Длина префикса для выделения подсети из пула подсетей. Возвращается: при успехе
project_id string	ID проекта. Возвращается: при успехе
revision_number string	Номер ревизии ресурса. Возвращается: при успехе
segment_id string	ID сегмента сети, с которым связана подсеть. Возвращается: при успехе
service_types list / elements=string	Типы служб, связанные с подсетью. Возвращается: при успехе
subnet_pool_id string	ID пула подсетей, связанного с подсетью. Возвращается: при успехе

метки список / элементы=строка	Список меток ресурса. Возвращается: успешно
updated_at строка	Дата и время обновления ресурса. Возвращается: успешно
use_default_subnet_pool логическое	Использовать ли стандартный пул подсетей для получения CIDR. Возвращается: успешно

Авторы

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/subnets_info_module.html