cs_ip_address — Управляет ассоциациями публичных IP-адресов в облаках на базе Apache CloudStack.
Новое в версии 2.0.
Описание
- Получает и связывает публичный IP-адрес с учетной записью или проектом.
- Из-за ограничений API это не идемпотентный вызов, поэтому убедитесь, что вызываете его только условно, когда
state=present
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account | Учетная запись, к которой относится IP-адрес. | |
| api_http_method |
|
HTTP-метод, используемый для запроса API-пункта.
Если не указано, используется значение переменной среды CLOUDSTACK_METHOD.
В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
Значение по умолчанию —
get, если не указано. |
| api_key | Ключ API API CloudStack.
Если не указано, используется значение переменной среды CLOUDSTACK_KEY.
В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
|
|
| api_region | По умолчанию: cloudstack |
Имя раздела в файле конфигурации cloustack.ini.
Если не указано, используется значение переменной среды CLOUDSTACK_REGION.
|
| api_secret | Секретный ключ API CloudStack.
Если не задано, используется значение переменной среды CLOUDSTACK_SECRET.
В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
|
|
| api_timeout | Таймаут HTTP в секундах.
Если не указано, используется значение переменной среды CLOUDSTACK_TIMEOUT.
В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
Значение по умолчанию — 10 секунд, если не указано.
|
|
| api_url | URL API CloudStack, например, https://cloud.example.com/client/api.
Если не указано, используется значение переменной среды CLOUDSTACK_ENDPOINT.
В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
|
|
| domain | Домен, к которому относится IP-адрес. | |
| ip_address | Публичный IP-адрес.
Требуется, если
state=absent
|
|
| network | Сеть, к которой относится IP-адрес. | |
| poll_async |
|
Обрабатывать асинхронные задачи до завершения. |
| project | Имя проекта, к которому относится IP-адрес. | |
| state |
|
Состояние IP-адреса. |
| vpc (добавлено в 2.2) |
VPC, к которому относится IP-адрес. | |
| zone | Имя зоны, в которой находится IP-адрес.
Если не задано, используется зона по умолчанию.
|
Примечания
Примечание
- Ansible использует метод конфигурации библиотеки
cs, если учетные данные не предоставлены аргументамиapi_url,api_key,api_secret. Конфигурация читается из нескольких мест в следующем порядке.CLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETиCLOUDSTACK_METHOD.CLOUDSTACK_TIMEOUTпеременные среды. Переменная средыCLOUDSTACK_CONFIG, указывающая на файл.ini. Файлcloudstack.iniв текущем рабочем каталоге. Файл.cloudstack.iniв домашнем каталоге пользователя. Допускается указание нескольких учетных данных и конечных точек с помощью разделов ini вcloudstack.ini. Используйте аргументapi_regionдля выбора имени раздела, раздел по умолчанию —cloudstack. Более подробная информация доступна на https://github.com/exoscale/cs. - Подробное руководство по модулям cloudstack можно найти в руководстве по облаку CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
- name: Associate an IP address conditonally
local_action:
module: cs_ip_address
network: My Network
register: ip_address
when: instance.public_ip is undefined
- name: Disassociate an IP address
local_action:
module: cs_ip_address
ip_address: 1.2.3.4
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в разделе. Следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| account строка |
успех | Учетная запись, к которой относится IP-адрес. Пример:
примерная учетная запись
|
| domain строка |
успех | Домен, к которому относится IP-адрес. Пример:
примерный домен
|
| id строка |
успех | UUID публичного IP-адреса. Пример:
a6f7a5fc-43f8-11e5-a151-feff819cdc9f
|
| ip_address строка |
успех | Публичный IP-адрес. Пример:
1.2.3.4
|
| project строка |
успех | Имя проекта, к которому относится IP-адрес. Пример:
Производство
|
| zone строка |
успех | Имя зоны, к которой относится IP-адрес. Пример:
ch-gva-2
|
Статус
Этот модуль помечен как stableinterface, что означает, что поддерживающие его разработчики гарантируют, что в интерфейсе не будет обратной совместимости.
Автор
- Darren Worrall (@dazworrall)
- René Moser (@resmo)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/cs_ip_address_module.html