Модуль openstack.cloud.floating_ip_info — Получение информации о виртуальных IP-адресах
Примечание
Этот модуль является частью коллекции openstack.cloud (версия 2.2.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. Если этот параметр опущен, ничего не будет передано в библиотеку запросов. |
auth dictionary | Словарь, содержащий информацию об аутентификации, необходимую стратегии плагина аутентификации облака. Для плагина password по умолчанию это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен будет содержать все параметры, требуемые этим плагином аутентификации. Этот параметр не нужен, если предоставлено именованное облако или присутствуют переменные окружения OpenStack OS_*. |
auth_type string | Имя используемого плагина аутентификации. Если облако использует что-то другое, кроме парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть обновлено соответствующим образом. |
ca_cert aliases: cacert string | Путь к пакету сертификатов CA, который может использоваться в качестве части проверки запросов SSL API. |
client_cert aliases: cert string | Путь к клиентскому сертификату, используемому как часть транзакции SSL. |
client_key aliases: 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 | Имя или ID сети, связанной с плавающим IP. |
interface aliases: endpoint_type string | Тип URL конечной точки для извлечения из каталога служб. Варианты:
|
port string | Имя или ID порта, с которым связан плавающий IP. |
project aliases: project_id string | Имя или ID проекта, с которым связан плавающий IP. |
region_name string | Имя региона. |
router string | Имя или ID связанного маршрутизатора. |
sdk_log_level string | Уровень логирования OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается |
status string | Статус плавающего IP. Варианты:
|
timeout integer | Как долго ansible должен ждать запрашиваемый ресурс. По умолчанию: |
validate_certs aliases: verify boolean | Является ли проверка SSL-API-запросов необходимой. До 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/floating_ip_info_module.html
