Модуль openstack.cloud.floating_ip_info — получение информации о плавающих IP-адресах
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.floating_ip_info.
Краткое описание
- Получение генератора плавающих IP-адресов.
Требования
На узле, на котором выполняется этот модуль, должны быть установлены следующие компоненты.
- 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. |
description string | Описание плавающего IP-адреса. |
fixed_ip_address string | Фиксированный IP-адрес, связанный с плавающим IP-адресом. |
floating_ip_address string | IP-адрес плавающего IP-адреса. |
floating_network string | Имя или идентификатор сети, связанной с плавающим IP-адресом. |
interface псевдонимы: endpoint_type string | Тип URL конечной точки, получаемой из каталога служб. Варианты:
|
port string | Имя или идентификатор порта, с которым связан плавающий IP-адрес. |
project псевдонимы: project_id string | Имя или идентификатор проекта, с которым связан плавающий IP-адрес. |
region_name string | Имя региона. |
router string | Имя или идентификатор связанного маршрутизатора. |
sdk_log_level string | Уровень журналирования OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведётся. |
status string | Состояние плавающего IP-адреса. Варианты:
|
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/
Примеры
# Getting all floating ips
- openstack.cloud.floating_ip_info:
register: fips
# Getting fip by associated fixed IP address.
- openstack.cloud.floating_ip_info:
fixed_ip_address: 192.168.10.8
register: fip
# Getting fip by associated router.
- openstack.cloud.floating_ip_info:
router: my-router
register: fip
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
floating_ips list / elements=dictionary | Список объектов плавающих IP-адресов. Возвращается: при успешном выполнении |
|
created_at string |
Время назначения плавающего IP-адреса. Возвращается: при успешном выполнении |
|
description string |
Описание плавающего IP-адреса. Возвращается: при успешном выполнении |
|
dns_domain string |
Домен DNS. Возвращается: при успешном выполнении |
|
dns_name string |
Имя DNS. Возвращается: при успешном выполнении |
|
fixed_ip_address string |
Фиксированный IP-адрес, связанный с плавающим IP-адресом. Возвращается: при успешном выполнении |
|
floating_ip_address string |
IP-адрес плавающего IP-адреса. Возвращается: при успешном выполнении |
|
floating_network_id string |
Идентификатор сети, связанной с плавающим IP-адресом. Возвращается: при успешном выполнении |
|
id string |
Идентификатор плавающего IP-адреса. Возвращается: при успешном выполнении |
|
name string |
Имя плавающего IP-адреса. Возвращается: при успешном выполнении |
|
port_details dictionary |
Сведения о порте, с которым связан этот плавающий IP-адрес. Присутствует, если загружено расширение Возвращается: при успешном выполнении |
|
port_id string |
Идентификатор порта, с которым связан плавающий IP-адрес. Возвращается: при успешном выполнении |
|
project_id string |
Идентификатор проекта, с которым связан этот плавающий IP-адрес. Возвращается: при успешном выполнении |
|
qos_policy_id string |
Идентификатор политики QoS, назначенной плавающему IP-адресу. Возвращается: при успешном выполнении |
|
revision_number string |
Номер ревизии. Возвращается: при успешном выполнении |
|
router_id string |
Идентификатор маршрутизатора, с которым связан плавающий IP-адрес. Возвращается: при успешном выполнении |
|
status string |
Состояние плавающего IP-адреса: «ACTIVE» или «DOWN». Возвращается: при успешном выполнении |
|
subnet_id string |
Идентификатор подсети, с которой связан плавающий IP-адрес. Возвращается: при успешном выполнении |
|
tags list / elements=string |
Список тегов. Возвращается: при успешном выполнении |
|
updated_at string |
Время последнего обновления плавающего IP-адреса. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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/floating_ip_info_module.html