os_floating_ip – Добавление/удаление плавающего IP-адреса к экземпляру
Новое в версии 2.0.
Описание
- Добавление или удаление плавающего IP-адреса к экземпляру
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должно ждать слои сокета, прежде чем истечёт время ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку requests. | |
| 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 Cert, который можно использовать при проверке запросов API SSL. псевдонимы: 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 строка добавлен в 2.3 |
| Тип URL конечной точки для получения из каталога сервисов. псевдонимы: endpoint_type |
| nat_destination - добавлен в 2.3 | Имя или идентификатор частной сети neutron, на которой находится фиксированный IP-адрес для подключения плавающего IP-адреса псевдонимы: fixed_network, internal_network | |
| network - | Имя или идентификатор внешней сети neutron или имя пула nova. | |
| purge логическое значение добавлен в 2.1 |
| Когда state отсутствует, указывает, следует ли удалить плавающий IP-адрес полностью или только отсоединить его от сервера. По умолчанию выполняется только отключение. |
| region_name строка | Имя региона. | |
| reuse логическое значение |
| Когда state присутствует, и floating_ip_address отсутствует, этот параметр можно использовать для указания, следует ли пытаться повторно использовать плавающий IP-адрес, уже выделенный проекту. |
| server - / обязательно | Имя или идентификатор экземпляра, которому должен быть назначен IP-адрес. | |
| state - |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout целое число | По умолчанию: 60 | Время ожидания появления IP-адреса как присоединённого. См. wait. |
| validate_certs логическое значение |
| Проверять ли запросы API SSL. Перед Ansible 2.3 по умолчанию было yes. псевдонимы: verify |
| wait логическое значение |
| При подключении плавающего 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.8/modules/os_floating_ip_module.html
