os_floating_ip - Добавление/удаление плавающего IP-адреса на экземпляр
Новое в версии 2.0.
Обзор
- Добавление или удаление плавающего IP-адреса на экземпляр
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени должна ожидать сокетная часть перед истечением времени ожидания для API-запросов. Если этот параметр отсутствует, ничего не будет передано в библиотеку requests. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для стандартного плагина password, он должен содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые этому плагину авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type | Имя плагина авторизации для использования. Если облако использует что-то другое, кроме аутентификации по паролю, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к пакету сертификатов CA, который может использоваться в рамках проверки SSL-API-запросов. | |
| cert | Путь к клиенту сертификат для использования в рамках SSL-транзакции. | |
| 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 (добавлен в 2.3) |
| Тип URL конечной точки для извлечения из каталога сервиса. псевдонимы: endpoint_type |
| key | Путь к ключу клиента для использования в рамках SSL-транзакции. | |
| nat_destination (добавлен в 2.3) | Имя или идентификатор частной сети neutron, на которой находится статический IP-адрес для прикрепления плавающего IP. псевдонимы: fixed_network, internal_network | |
| network | Имя или ID внешней сети neutron или имя пула nova. | |
| purge bool (добавлен в 2.1) |
| Когда state отсутствует, указывает, нужно ли полностью удалить плавающий IP-адрес или только отсоединить его от сервера. По умолчанию — только отсоединить. |
| region_name | Имя региона. | |
| reuse bool |
| Когда state присутствует, а floating_ip_address нет, этот параметр может быть использован для указания того, следует ли пытаться повторно использовать плавающий IP-адрес, уже выделенный проекту. |
| server требуется | Имя или идентификатор экземпляра, которому должен быть назначен IP-адрес. | |
| state |
| Ресурс должен присутствовать или отсутствовать. |
| timeout | По умолчанию: 60 | Время ожидания появления IP-адреса как прикрепленного. См. wait. |
| verify bool |
| Проверка SSL-API-запросов. До версии 2.3 по умолчанию True. псевдонимы: validate_certs |
| wait bool |
| При прикреплении плавающего IP-адреса укажите, следует ли ждать его появления как прикрепленного. |
Примечания
Примечание
- Могут использоваться стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла yaml конфигурации в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, а в последнюю очередь из явных параметров в play. Более подробную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config
Примеры
# 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. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Davide Guerri <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.6/modules/os_floating_ip_module.html
