Модуль ngine_io.cloudstack.ip_address — управление ассоциациями публичных IP-адресов в облаках на базе Apache CloudStack.
Примечание
Этот модуль входит в коллекцию ngine_io.cloudstack (версия 3.0.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install ngine_io.cloudstack. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: ngine_io.cloudstack.ip_address.
Добавлено в ngine_io.cloudstack 0.1.0
Краткое описание
- Получает публичный IP-адрес и связывает его с учётной записью или проектом.
- Из-за ограничений API этот вызов не является идемпотентным, поэтому вызывайте его условно только при state=present.
- Добавление тегов к IP-адресу также может сделать вызов идемпотентным.
Псевдонимы: cs_ip_address
Требования
Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.9.0
Параметры
Параметр | Описание |
|---|---|
account string | Учётная запись, с которой связан IP-адрес. |
api_http_method string | Метод HTTP, используемый для запроса к конечной точке API. Если не задан, используется переменная среды Варианты:
|
api_key string / обязательный | Ключ API CloudStack. Если не задан, используется переменная среды |
api_secret string / обязательный | Секретный ключ API CloudStack. Если не задан, используется переменная среды |
api_timeout integer | Тайм-аут HTTP в секундах. Если не задан, используется переменная среды По умолчанию: |
api_url string / обязательный | URL API CloudStack, например https://cloud.example.com/client/api. Если не задан, используется переменная среды |
api_verify_ssl_cert string | Проверять файл сертификата центра сертификации. Если не задан, используется переменная среды |
domain string | Домен, с которым связан IP-адрес. |
ip_address string | Публичный IP-адрес. Обязателен, если state=absent и tags не заданы. |
network string | Сеть, с которой связан IP-адрес. Не может использоваться одновременно с vpc. |
poll_async boolean | Ожидать завершения асинхронных заданий, опрашивая их состояние. Варианты:
|
project string | Имя проекта, с которым связан IP-адрес. |
state string | Состояние IP-адреса. Варианты:
|
tags псевдонимы: tag list / элементы=dictionary | Список тегов. Теги представляют собой список словарей с ключами key и value. Теги можно использовать как уникальный идентификатор IP-адресов. В этом случае по крайней мере один из них должен быть уникальным, чтобы обеспечить идемпотентность. |
validate_certs boolean добавлено в ngine_io.cloudstack 2.4.0 | Если Если не задан, используется переменная среды Этот параметр следует использовать только на контролируемых вами сайтах с самоподписанными сертификатами. Варианты:
|
vpc string | VPC, с которой связан IP-адрес. Не может использоваться одновременно с network. |
zone string / обязательный | Имя зоны, в которой находится IP-адрес. |
Примечания
Примечание
- Подробное руководство по модулям CloudStack см. в руководстве по облаку CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
- name: Associate an IP address conditionally
ngine_io.cloudstack.ip_address:
network: My Network
zone: zone01
register: ip_address
when: instance.public_ip is undefined
- name: Disassociate an IP address
ngine_io.cloudstack.ip_address:
ip_address: 1.2.3.4
zone: zone01
state: absent
- name: Associate an IP address with tags
ngine_io.cloudstack.ip_address:
network: My Network
zone: zone01
tags:
- key: myCustomID
value: 5510c31a-416e-11e8-9013-02000a6b00bf
register: ip_address
- name: Disassociate an IP address with tags
ngine_io.cloudstack.ip_address:
state: absent
zone: zone01
tags:
- key: myCustomID
value: 5510c31a-416e-11e8-9013-02000a6b00bf
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
account string | Учётная запись, с которой связан IP-адрес. Возвращается: при успехе Пример: |
domain string | Домен, с которым связан IP-адрес. Возвращается: при успехе Пример: |
id string | UUID публичного IP-адреса. Возвращается: при успехе Пример: |
ip_address string | Публичный IP-адрес. Возвращается: при успехе Пример: |
project string | Имя проекта, с которым связан IP-адрес. Возвращается: при успехе Пример: |
tags dictionary | Список тегов ресурса, связанных с IP-адресом. Возвращается: при успехе Пример: |
zone string | Имя зоны, с которой связан IP-адрес. Возвращается: при успехе Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ngine_io/cloudstack/ip_address_module.html