Модуль ngine_io.cloudstack.cs_ip_address – Управление ассоциациями публичных IP-адресов в облаках на базе Apache CloudStack.

Примечание

Этот модуль входит в коллекцию ngine_io.cloudstack (версия 2.5.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install ngine_io.cloudstack. Для использования этого модуля требуются дополнительные зависимости, см. Требования для деталей.

Для использования в плейбуке укажите: ngine_io.cloudstack.cs_ip_address.

Добавлен в ngine_io.cloudstack 0.1.0

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Получает и ассоциирует публичный IP-адрес с учетной записью или проектом.
Из-за ограничений API это не идемпотентный вызов, поэтому убедитесь, что вы вызываете его только при state=present.
Использование тегов для IP-адреса также может сделать вызов идемпотентным.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Комментарии
account string	Учётная запись, к которой относится IP-адрес.
api_http_method string	HTTP-метод, используемый для запроса к конечной точке API. Если не указано, используется переменная окружения `CLOUDSTACK_METHOD`. Варианты: `"get"` ← (default) `"post"`
api_key string / required	Ключ API CloudStack API. Если не указано, используется переменная окружения `CLOUDSTACK_KEY`.
api_secret string / required	Секретный ключ CloudStack API. Если не указано, используется переменная окружения `CLOUDSTACK_SECRET`.
api_timeout integer	Таймаут HTTP в секундах. Если не указано, используется переменная окружения `CLOUDSTACK_TIMEOUT`. По умолчанию: `10`
api_url string / required	URL CloudStack API, например https://cloud.example.com/client/api. Если не указано, используется переменная окружения `CLOUDSTACK_ENDPOINT`.
api_verify_ssl_cert string	Проверить файл сертификата центра сертификации. Если не указано, используется переменная окружения `CLOUDSTACK_VERIFY`.
domain string	Домен, к которому относится IP-адрес.
ip_address string	Публичный IP-адрес. Обязательно, если state=absent и tags не установлен.
network string	Сеть, к которой относится IP-адрес. Взаимоисключающе с vpc.
poll_async boolean	Опрашивать асинхронные задания до их завершения. Варианты: `false` `true` ← (default)
project string	Имя проекта, к которому относится IP-адрес.
state string	Состояние IP-адреса. Варианты: `"present"` ← (default) `"absent"`
tags aliases: tag list / elements=dictionary	Список тегов. Теги представляют собой список словарей с ключами key и value. Теги могут использоваться в качестве уникального идентификатора для IP-адресов. В этом случае, по крайней мере, один из них должен быть уникальным для обеспечения идемпотентности.
validate_certs boolean added in ngine_io.cloudstack 2.4.0	Если `false`, SSL-сертификаты проверяться не будут. Если не указано, используется переменная окружения `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY`. Это следует использовать только на лично контролируемых сайтах, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (default)
vpc string	VPC, к которому относится IP-адрес. Взаимоисключающе с network.
zone string / required	Имя зоны, в которой находится IP-адрес.

Примечания

Примечание

Подробное руководство по модулям cloudstack можно найти в CloudStack Cloud Guide.
Этот модуль поддерживает режим проверки.

Примеры

- 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-адрес. Возвращаемое значение: успех Пример: `"example account"`
domain строка	Домен, к которому относится IP-адрес. Возвращаемое значение: успех Пример: `"example domain"`
id строка	UUID публичного IP-адреса. Возвращаемое значение: успех Пример: `"a6f7a5fc-43f8-11e5-a151-feff819cdc9f"`
ip_address строка	Публичный IP-адрес. Возвращаемое значение: успех Пример: `"1.2.3.4"`
project строка	Название проекта, к которому относится IP-адрес. Возвращаемое значение: успех Пример: `"Production"`
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_ip_address_module.html