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-ключ API CloudStack. Если не задано, используется значение переменной среды `CLOUDSTACK_KEY`. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания.
api_region строка	Значение по умолчанию: "cloudstack"	Имя раздела ini в файле `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 и tags не задано.
network строка		Сеть, к которой относится IP-адрес. Взаимоисключительно с vpc.
poll_async булево	Варианты: нет да ←	Ожидать завершения асинхронных задач.
project строка		Имя проекта, к которому относится IP-адрес.
state строка	Варианты: наличие ← отсутствие	Состояние IP-адреса.
tags список добавлен в 2.6		Список тегов. Теги — список словарей с ключами key и value. Теги могут использоваться в качестве уникального идентификатора для IP-адресов. В этом случае хотя бы один из них должен быть уникальным для обеспечения идемпотентности. псевдонимы: тег
vpc строка добавлен в 2.2		VPC, к которому относится IP-адрес. Взаимоисключительно с network.
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 conditionally
  cs_ip_address:
    network: My Network
  register: ip_address
  when: instance.public_ip is undefined
  delegate_to: localhost

- name: Disassociate an IP address
  cs_ip_address:
    ip_address: 1.2.3.4
    state: absent
  delegate_to: localhost

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

- name: Disassociate an IP address with tags
  cs_ip_address:
    state: absent
    tags:
      - key: myCustomID
      - value: 5510c31a-416e-11e8-9013-02000a6b00bf
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны в Здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
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]

Авторы

Дэррен Уорролл (@dazworrall)
Рене Мозер (@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.8/modules/cs_ip_address_module.html