Модуль openstack.cloud.subnets_info — получение информации об одной или нескольких подсетях OpenStack.
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.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 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 | Путь к пакету сертификатов CA, который можно использовать для проверки запросов к API по SSL. |
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 конечной точки, получаемой из каталога служб. Варианты:
|
name псевдонимы: subnet string | Имя или ID подсети. Псевдоним «subnet» добавлен в версии 2.8. |
region_name string | Название региона. |
sdk_log_level string | Уровень журналирования OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается. |
timeout integer | Сколько времени Ansible должен ожидать запрошенный ресурс. По умолчанию: |
validate_certs псевдонимы: verify boolean | Нужно ли проверять запросы к API по SSL. До Ansible 2.3 значение по умолчанию было Варианты:
|
wait boolean | Должен ли 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 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 |
IP-адрес шлюза подсети. Возвращается: при успешном выполнении |
|
host_routes list / elements=dictionary |
Дополнительные маршруты для подсети. Возвращается: при успешном выполнении |
|
id string |
ID подсети. Возвращается: при успешном выполнении |
|
ip_version integer |
Версия IP для этой подсети. Возвращается: при успешном выполнении |
|
ipv6_address_mode string |
Режимы адресации IPv6 определяют механизмы назначения IP-адресов. Возвращается: при успешном выполнении |
|
ipv6_ra_mode string |
Параметр IPv6 router advertisement определяет, должна ли сетевая служба передавать пакеты 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 пула подсетей, связанного с подсетью. Возвращается: при успешном выполнении |
|
tags list / elements=string |
Список тегов ресурса. Возвращается: при успешном выполнении |
|
updated_at string |
Дата и время обновления ресурса. Возвращается: при успешном выполнении |
|
use_default_subnet_pool boolean |
Использовать ли пул подсетей по умолчанию для получения CIDR. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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/subnets_info_module.html
