os_floating_ip - Добавление/удаление плавающего IP-адреса на экземпляр
Новое в версии 2.0.
Описание
- Добавление или удаление плавающего IP-адреса на экземпляр
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- shade
Параметры
| параметр | обязателен | по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| api_timeout | нет | None | Сколько времени должен ждать слой сокетов перед истечением времени ожидания для вызовов API. Если этот параметр опущен, ничего не будет передано библиотеке requests. | |
| auth | нет | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать требуемые параметры подключаемого модуля авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | ||
| auth_type | нет | password | Имя подключаемого модуля авторизации для использования. Если облако использует что-то другое, кроме аутентификации по паролю, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | нет | Игнорируется. Присутствует для обратной совместимости | ||
| cacert | нет | None | Путь к пакету сертификатов CA, который можно использовать для проверки запросов SSL API. | |
| cert | нет | None | Путь к клиенту сертификата для использования в рамках транзакции SSL. | |
| cloud | нет | Имя облака для работы. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан параметр auth или присутствуют переменные окружения OpenStack OS_*. | ||
| endpoint_type | нет | public |
| Тип URL-адреса конечной точки для извлечения из каталога служб. |
| fixed_address | нет | К какому фиксированному IP-адресу сервера должен быть прикреплен плавающий IP-адрес. | ||
| floating_ip_address | нет | Плавающий IP-адрес для прикрепления или открепления. Требуется только если state отсутствует. Если state присутствует, можно использовать для указания IP-адреса для прикрепления. | ||
| key | нет | None | Путь к ключу клиента для использования в рамках транзакции SSL. | |
| nat_destination (добавлено в 2.3)
| нет | None | Имя или идентификатор частной сети neutron, на которой находится фиксированный IP-адрес для прикрепления плавающего IP-адреса. псевдонимы: fixed_network, internal_network | |
| network | нет | Имя или ID внешней сети neutron или имя пула nova. | ||
| purge (добавлено в 2.1)
| нет | Когда state отсутствует, указывает, следует ли полностью удалить плавающий IP-адрес или только отсоединить его от сервера. По умолчанию отсоединяется только. | ||
| region_name | нет | Имя региона. | ||
| reuse | нет | Когда state присутствует, а floating_ip_address отсутствует, этот параметр можно использовать для указания, следует ли пытаться повторно использовать уже выделенный плавающий IP-адрес проекта. | ||
| server | да | Имя или идентификатор экземпляра, которому должен быть назначен IP-адрес. | ||
| state | нет | present |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout | нет | 60 | Время ожидания появления IP-адреса, прикрепленного. Смотрите wait. | |
| validate_certs | нет | Следует ли проверять запросы SSL API. До версии 2.3 по умолчанию значение было True. псевдонимы: verify | ||
| wait | нет | При присоединении плавающего IP-адреса укажите, следует ли ожидать его появления в качестве прикрепленного. |
Примеры
# 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
Примечания
Примечание
- Можно использовать стандартные переменные окружения 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
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для помощи в разработке модулей, если вы так решите, прочитайте Справочную информацию по сообществу и участию в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_floating_ip_module.html