ngine_io.cloudstack.cs_ip_address – Управляет ассоциациями публичных IP-адресов в облаках на основе Apache CloudStack.
Примечание
Этот плагин входит в коллекцию ngine_io.cloudstack (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.cloudstack.
Чтобы использовать его в playbook, укажите: ngine_io.cloudstack.cs_ip_address.
Введено в версии 0.1.0: of ngine_io.cloudstack
Обзор
- Получает и связывает публичный IP-адрес с учетной записью или проектом.
- Из-за ограничений API это не идемпотентный вызов, поэтому обязательно вызывайте его только условно, когда state=present.
- Тегирование IP-адреса также может сделать вызов идемпотентным.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account строка | Учетная запись, к которой относится IP-адрес. | |
| api_http_method строка |
| HTTP-метод, используемый для запроса API-точки входа. Если не задано, используется переменная среды CLOUDSTACK_METHOD. |
| api_key строка / обязательно | Ключ API CloudStack API. Если не задано, используется переменная среды CLOUDSTACK_KEY. | |
| api_secret строка / обязательно | Секретный ключ CloudStack API. Если не задано, используется переменная среды CLOUDSTACK_SECRET. | |
| api_timeout целое число | По умолчанию: 10 | Таймаут HTTP в секундах. Если не задано, используется переменная среды CLOUDSTACK_TIMEOUT. |
| api_url строка / обязательно | URL CloudStack API, например, https://cloud.example.com/client/api. Если не задано, используется переменная среды CLOUDSTACK_ENDPOINT. | |
| api_verify_ssl_cert строка | Проверка сертификата CA. Если не задано, используется переменная среды CLOUDSTACK_VERIFY. | |
| domain строка | Домен, к которому относится IP-адрес. | |
| ip_address строка | Публичный IP-адрес. Обязательно, если state=absent и tags не задано. | |
| network строка | Сеть, к которой относится IP-адрес. Взаимоисключающие с vpc. | |
| poll_async логическое |
| Ожидать завершения асинхронных заданий. |
| project строка | Имя проекта, к которому относится IP-адрес. | |
| state строка |
| Состояние IP-адреса. |
| tags список / элементы=словарь | Список тегов. Теги — это список словарей, содержащих ключи key и value. Теги могут использоваться в качестве уникального идентификатора IP-адресов. В этом случае хотя бы один из них должен быть уникальным для обеспечения идемпотентности. псевдонимы: tag | |
| vpc строка | Виртуальная сеть (VPC), к которой относится IP-адрес. Взаимоисключающие с network. | |
| zone строка / обязательно | Имя зоны, в которой находится IP-адрес. |
Примечания
Примечание
- Подробное руководство по модулям cloudstack можно найти в руководстве по облаку CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
- name: Associate an IP address conditionally
ngine_io.cloudstack.cs_ip_address:
network: My Network
zone: zone01
register: ip_address
when: instance.public_ip is undefined
- name: Disassociate an IP address
ngine_io.cloudstack.cs_ip_address:
ip_address: 1.2.3.4
zone: zone01
state: absent
- name: Associate an IP address with tags
ngine_io.cloudstack.cs_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.cs_ip_address:
state: absent
zone: zone01
tags:
- key: myCustomID
value: 5510c31a-416e-11e8-9013-02000a6b00bf
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| account строка | успех | Учетная запись, к которой относится IP-адрес. Пример: пример учетной записи |
| domain строка | успех | Домен, к которому относится IP-адрес. Пример: пример домена |
| id строка | успех | UUID публичного IP-адреса. Пример: a6f7a5fc-43f8-11e5-a151-feff819cdc9f |
| ip_address строка | успех | Публичный IP-адрес. Пример: 1.2.3.4 |
| project строка | успех | Имя проекта, к которому относится IP-адрес. Пример: Производство |
| tags словарь | успех | Список тегов ресурсов, связанных с IP-адресом. Пример: [ { "key": "myCustomID", "value": "5510c31a-416e-11e8-9013-02000a6b00bf" } ] |
| zone строка | успех | Имя зоны, к которой относится IP-адрес. Пример: ch-gva-2 |
Авторы
- Darren Worrall (@dazworrall)
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/cloudstack/cs_ip_address_module.html