cs_ip_address - Управляет ассоциациями публичных IP-адресов в облаках на основе Apache CloudStack.
Новая версия с 2.0.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Получает и связывает публичный IP-адрес с учётной записью или проектом. Из-за ограничений API это не идемпотентный вызов, поэтому следует вызывать его только условно, когда
state=present
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- cs >= 0.6.10
Параметры
| параметр | обязательно | по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| account | нет | Учётная запись, к которой относится IP-адрес. | ||
| api_http_method | нет | get |
| Используемый HTTP-метод. |
| api_key | нет | API-ключ API CloudStack. | ||
| api_region | нет | cloudstack | Имя раздела ini в файле cloustack.ini. | |
| api_secret | нет | Секретный ключ API CloudStack. | ||
| api_timeout | нет | 10 | Таймаут HTTP. | |
| api_url | нет | URL API CloudStack, например https://cloud.example.com/client/api. | ||
| domain | нет | Домен, к которому относится IP-адрес. | ||
| ip_address | нет | Публичный IP-адрес. Требуется, если state=absent
| ||
| network | нет | Сеть, к которой относится IP-адрес. | ||
| poll_async | нет | True | Опрашивать асинхронные задачи до завершения. | |
| project | нет | Имя проекта, к которому относится IP-адрес. | ||
| vpc (добавлено в 2.2)
| нет | VPC, к которому относится IP-адрес. | ||
| zone | нет | Имя зоны, в которой находится IP-адрес. Если не задано, используется зона по умолчанию. |
Примеры
# Associate an IP address conditonally
- local_action:
module: cs_ip_address
network: My Network
register: ip_address
when: instance.public_ip is undefined
# 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 |
Примечания
Примечание
- 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 можно найти на http://docs.ansible.com/ansible/guide_cloudstack.html
- Этот модуль поддерживает режим проверки.
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будет вноситься обратной несовместимой изменений интерфейса.
Для получения помощи в разработке модулей, если вы захотите, пожалуйста, прочитайте Информация о сообществе и вклад, Тестирование 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/cs_ip_address_module.html
