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

Новая версия с 2.0.

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

Описание

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

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account -		Учетная запись, к которой относится IP-адрес.
api_http_method -	Варианты: get post	HTTP-метод, используемый для запроса конечной точки API. Если не задано, используется переменная среды `CLOUDSTACK_METHOD`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию - `get`, если не указано.
api_key -		Ключ API CloudStack API. Если не задано, используется переменная среды `CLOUDSTACK_KEY`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_region -	Значение по умолчанию: "cloudstack"	Имя раздела ini в файле `cloustack.ini`. Если не задано, используется переменная среды `CLOUDSTACK_REGION`.
api_secret -		Секретный ключ CloudStack API. Если не задано, используется переменная среды `CLOUDSTACK_SECRET`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_timeout -		Таймаут HTTP в секундах. Если не задано, используется переменная среды `CLOUDSTACK_TIMEOUT`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию - 10 секунд, если не указано.
api_url -		URL CloudStack API, например, https://cloud.example.com/client/api. Если не задано, используется переменная среды `CLOUDSTACK_ENDPOINT`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
domain -		Домен, к которому относится IP-адрес.
ip_address -		Публичный IP-адрес. Обязательно, если `state=absent` и `tags` не заданы.
network -		Сеть, к которой относится IP-адрес.
poll_async boolean	Варианты: нет да ←	Ожидать завершения асинхронных задач.
project -		Имя проекта, к которому относится IP-адрес.
state -	Варианты: наличие ← отсутствует	Состояние IP-адреса.
tags - добавлен в 2.6		Список тегов. Теги представляют собой список словарей с ключами `key` и `value`. Теги могут использоваться в качестве уникального идентификатора для 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. Файл 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

- name: Associate an IP address with tags
  local_action:
    module: cs_ip_address
    network: My Network
    tags:
      - key: myCustomID
      - value: 5510c31a-416e-11e8-9013-02000a6b00bf
  register: ip_address

- name: Disassociate an IP address with tags
  local_action:
    module: cs_ip_address
    state: absent
    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 словарь добавлен в 2.6	успех	Список тегов ресурсов, связанных с IP-адресом. Пример: [ { "key": "myCustomID", "value": "5510c31a-416e-11e8-9013-02000a6b00bf" } ]
zone строка	успех	Имя зоны, к которой относится IP-адрес. Пример: ch-gva-2

Статус

Гарантируется, что у этого модуля не будет несовместимых изменений интерфейса в будущем. [stableinterface]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.7/modules/cs_ip_address_module.html