Модуль community.digitalocean.digital_ocean_tag — Создание и удаление тегов для ресурсов DigitalOcean.

Примечание

Этот модуль входит в коллекцию community.digitalocean (версия 1.27.0).

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

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

Чтобы использовать его в книге задач, укажите: community.digitalocean.digital_ocean_tag.

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

Описание

Создание и удаление тегов для ресурса DigitalOcean.

Требования

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

python >= 2.6

Параметры

Параметр	Комментарии
baseurl строка	Базовый URL API DigitalOcean. По умолчанию: `"https://api.digitalocean.com/v2"`
name строка / обязательно	Имя тега. Допустимые символы для имен включают алфавитно-цифровые символы, дефисы и подчеркивания.
oauth_token алиасы: api_token строка	Токен DigitalOcean OAuth. Существуют и другие переменные среды, которые могут использоваться для предоставления этого значения. Например, - `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` и `OAUTH_TOKEN`.
resource_id алиасы: droplet_id строка	Идентификатор ресурса для выполнения операции. Тип данных resource_id изменен со значения целого числа на строку с Ansible 2.5.
resource_type строка	Тип ресурса для выполнения операции. В настоящее время поддерживается только присвоение тегов каплям. Варианты: `"droplet"` ← (по умолчанию)
state строка	Указывает, должен ли тег присутствовать или отсутствовать на ресурсе. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число	Таймаут в секундах, используемый для опроса API DigitalOcean. По умолчанию: `30`
validate_certs логическое	Если установлено в `no`, сертификаты SSL не будут проверены. Это должно быть установлено в `no` только для сайтов, контролируемых лично, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Можно использовать две переменные среды: DO_API_KEY и DO_API_TOKEN. Обе они относятся к токену v2.
Начиная с Ansible 2.0, используется версия 2 API DigitalOcean.

Примеры

- name: Create a tag
  community.digitalocean.digital_ocean_tag:
    name: production
    state: present

- name: Tag a resource; creating the tag if it does not exist
  community.digitalocean.digital_ocean_tag:
    name: "{{ item }}"
    resource_id: "73333005"
    state: present
  loop:
    - staging
    - dbserver

- name: Untag a resource
  community.digitalocean.digital_ocean_tag:
    name: staging
    resource_id: "73333005"
    state: absent

# Deleting a tag also untags all the resources that have previously been
# tagged with it
- name: Remove a tag
  community.digitalocean.digital_ocean_tag:
    name: dbserver
    state: absent

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

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

Ключ	Описание
data словарь	Ресурс DigitalOcean Tag Возвращается: при успехе и отсутствии ограничений по ресурсам Пример: `{"tag": {"name": "awesome", "resources": {"droplets": {"count": 0, "last_tagged": null}}}}`

Авторы

Victor Volle (@kontrafiktion)

Ссылки на коллекцию

© 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/community/digitalocean/digital_ocean_tag_module.html