os_floating_ip – Добавление/удаление плавающего IP-адреса на экземпляр
Обзор
- Добавление или удаление плавающего IP-адреса на экземпляр.
- Возвращает плавающий IP-адрес при добавлении только если wait=true.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать сокетная прослойка перед истечением времени ожидания для API-вызовов. Если этот параметр опущен, он не будет передан в библиотеку запросов. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного плагина password он будет содержать auth_url, username, password, project_name и любую информацию о доменных областях (например, os_user_domain_name или os_project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые этому плагину авторизации. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения 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 строка |
| Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| nat_destination - | Имя или идентификатор частной сети Neutron, на которой находится фиксированный IP-адрес для подключения плавающего IP-адреса. псевдонимы: fixed_network, internal_network | |
| network - | Имя или идентификатор внешней сети Neutron или имя пула Nova. | |
| purge булево |
| Если state отсутствует, указывает, нужно ли полностью удалить плавающий IP-адрес или только отсоединить его от сервера. По умолчанию отсоединить только. |
| region_name строка | Имя региона. | |
| reuse булево |
| Когда state присутствует, а floating_ip_address отсутствует, этот параметр можно использовать для указания, нужно ли попытаться повторно использовать плавающий IP-адрес, уже выделенный проекту. |
| server - / обязательно | Имя или идентификатор экземпляра, которому должен быть назначен IP-адрес. | |
| state - |
| Ресурс должен быть present или absent. |
| 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 fist interface of `cattle001` from an exiting
# external network or nova pool. A new floating IP from the first available
# external network is allocated to the project.
- os_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.
- os_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`.
- os_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
- os_floating_ip:
cloud: dguerri
state: absent
floating_ip_address: 203.0.113.2
server: cattle001
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Davide Guerri (@dguerri) <davide.guerri@hp.com>
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/os_floating_ip_module.html
