Модуль openstack.cloud.floating_ip — управление плавающими IP-адресами серверов OpenStack

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.floating_ip.

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

Краткое описание

Добавляет плавающий IP-адрес к серверу OpenStack или удаляет его с сервера.
При подключении возвращает плавающий IP-адрес, только если параметр wait имеет значение true.
После отключения плавающего IP-адреса может пройти некоторое время, прежде чем сервер перестанет отображать этот 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	Путь к пакету сертификатов центра сертификации, который можно использовать для проверки SSL-запросов API.
client_cert псевдонимы: cert string	Путь к сертификату клиента, используемому в SSL-сеансе.
client_key псевдонимы: key string	Путь к ключу клиента, используемому в SSL-сеансе.
cloud any	Именованное облако или конфигурация облака, с которыми следует работать. Если cloud — строка, она указывает на именованную конфигурацию облака, определённую в файле clouds.yaml OpenStack. Задаёт значения по умолчанию для auth и auth_type. Этот параметр не требуется, если задан auth или присутствуют переменные среды OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml.
fixed_address string	Фиксированный IP-адрес сервера, к которому следует подключить плавающий IP-адрес.
floating_ip_address string	Плавающий IP-адрес, который нужно подключить или отключить. Если указан параметр state, его можно использовать для задания IP-адреса для подключения. Для параметра floating_ip_address необходимо задать network.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, который следует получить из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
nat_destination псевдонимы: fixed_network, internal_network string	Имя или идентификатор частной сети neutron, в которой находится фиксированный IP-адрес для подключения плавающего IP-адреса.
network string	Имя или идентификатор внешней сети neutron либо имя пула nova.
purge boolean	Если параметр state не указан, определяет, следует ли полностью удалить плавающий IP-адрес или только отключить его от сервера. По умолчанию выполняется только отключение. Варианты: `false` ← (по умолчанию) `true`
region_name string	Название региона.
reuse boolean	Если параметр state указан, а floating_ip_address не указан, этот параметр позволяет определить, следует ли попытаться повторно использовать плавающий IP-адрес, уже выделенный проекту. Если reuse имеет значение `true`, задан параметр network, а floating_ip_address не определён, то параметры `nat_destination` и `fixed_address` игнорируются. Варианты: `false` ← (по умолчанию) `true`
sdk_log_level string	Уровень ведения журнала OpenStackSDK. Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если путь не указан, журнал не ведётся.
server string / обязательный	Имя или идентификатор сервера, которому следует назначить IP-адрес.
state string	Должен ли ресурс присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Время ожидания Ansible запрошенного ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify boolean	Следует ли проверять SSL-запросы API. До Ansible 2.3 значение по умолчанию было `true`. Варианты: `false` `true`
wait boolean	Должен ли 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/

Примеры

# Assign a floating IP to the first interface of `cattle001` from an existing
# external network or nova pool. A new floating IP from the first available
# external network is allocated to the project.
- openstack.cloud.floating_ip:
     cloud: dguerri
     server: cattle001

# Assign a new floating IP to the server fixed ip `192.0.2.3` of
# `cattle001`. If a free floating IP is already allocated to the project, it is
# reused; if not, a new one is created.
- openstack.cloud.floating_ip:
     cloud: dguerri
     state: present
     reuse: true
     server: cattle001
     network: ext_net
     fixed_address: 192.0.2.3
     wait: true
     timeout: 180

# Assign a new floating IP from the network `ext_net` to the server fixed
# ip in network `private_net` of `cattle001`.
- openstack.cloud.floating_ip:
     cloud: dguerri
     state: present
     server: cattle001
     network: ext_net
     nat_destination: private_net
     wait: true
     timeout: 180

# Detach a floating IP address from a server
- openstack.cloud.floating_ip:
     cloud: dguerri
     state: absent
     floating_ip_address: 203.0.113.2
     server: cattle001

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

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

Ключ	Описание
floating_ip 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-адрес. Присутствует, если загружено расширение `fip-port-details`. Возвращается: при успешном выполнении
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 / элементы=string	Список тегов. Возвращается: при успешном выполнении
updated_at string	Метка времени последнего обновления плавающего IP-адреса. Возвращается: при успешном выполнении

Авторы

Специальная группа OpenStack Ansible

Ссылки на коллекцию

© 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_module.html