openstack.cloud.os_floating_ip – Добавление/удаление плавающего IP-адреса из экземпляра

Примечание

Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Чтобы использовать его в книге задач, укажите: openstack.cloud.os_floating_ip.

Обзор
Требования
Параметры
Примечания
Примеры

Обзор

Добавить или удалить плавающий IP-адрес для экземпляра.
Возвращает плавающий IP-адрес при присоединении только если wait=true.

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должно ждать сокетное подключение перед тем, как истечёт время ожидания для вызовов API. Если это значение опущено, ничего не будет передано в библиотеку запросов.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он должен содержать auth_url, username, password, project_name и любые сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, необходимые данному плагину авторизации. Этот параметр не нужен, если задан параметр cloud или присутствуют переменные окружения OpenStack OS_*.
auth_type строка		Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме парольной авторизации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone строка		Игнорируется. Присутствует для обратной совместимости
ca_cert строка		Путь к пакету сертификатов CA, который может быть использован в качестве части проверки запросов SSL к API. алиасы: cacert
client_cert строка		Путь к клиенту сертификат для использования в рамках транзакции SSL. алиасы: cert
client_key строка		Путь к ключу клиента для использования в рамках транзакции SSL. алиасы: key
cloud необработанные данные		Наименованное облако или конфигурация облака для работы с ним. Если cloud — строка, она ссылается на конфигурацию облака с именем, определённую в файле OpenStack clouds.yaml. Обеспечивает значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен параметр auth или присутствуют переменные окружения OpenStack OS_* . Если cloud — словарь, он содержит полную конфигурацию облака, как это было бы в разделе clouds.yaml.
fixed_address строка		К какому фиксированному IP-адресу сервера должен быть привязан плавающий IP-адрес.
floating_ip_address строка		Плавающий IP-адрес для присоединения или отсоединения. Требуется только если state отсутствует. Когда state присутствует, может быть использован для указания IP-адреса для присоединения.
interface строка	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога служб. алиасы: endpoint_type
nat_destination строка		Имя или ID частной сети neutron, на которой находится фиксированный IP-адрес для присоединения плавающего IP-адреса алиасы: fixed_network, internal_network
network строка		Имя или идентификатор внешней сети neutron или имя пула nova.
purge булево	Варианты: нет ← да	Когда state отсутствует, указывает, следует ли удалить плавающий IP-адрес полностью или только отсоединить его от сервера. По умолчанию отсоединяется только.
region_name строка		Имя региона.
reuse булево	Варианты: нет ← да	Когда state присутствует, и floating_ip_address отсутствует, этот параметр можно использовать для указания, следует ли пытаться повторно использовать плавающий IP-адрес, уже выделенный проекту.
server строка / обязательный		Имя или идентификатор экземпляра, которому должен быть назначен IP-адрес.
state строка	Варианты: присутствует ← отсутствует	Должен ли ресурс присутствовать или отсутствовать.
timeout целое число	Значение по умолчанию: 60	Время ожидания появления прикреплённого IP-адреса. См. wait.
validate_certs булево	Варианты: нет ← да	Следует ли проверять запросы SSL API. До версии Ansible 2.3 по умолчанию было `yes`. алиасы: verify
wait булево	Варианты: нет ← да	При присоединении плавающего IP-адреса укажите, следует ли ожидать его появления в качестве прикрепленного. Должно быть установлено значение `yes` для возврата значения плавающего IP-адреса модулем.

Примечания

Примечание

Стандартные переменные окружения 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 instance 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: yes
     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 instance 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

Авторы

Группа разработчиков Ansible OpenStack

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/os_floating_ip_module.html