Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин является частью коллекции community.digitalocean (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.digitalocean.

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

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

Обзор

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

Требования

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

  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
name
строка / обязательно
Имя тега. Поддерживаемые символы в имени включают буквенно-цифровые символы, дефисы и символы подчеркивания.
oauth_token
строка
Токен OAuth DigitalOcean.
Существуют несколько других переменных среды, которые можно использовать для предоставления этого значения.
Например, - 'DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN' и 'OAUTH_TOKEN'

псевдонимы: api_token
resource_id
строка
Идентификатор ресурса для обработки.
Тип данных resource_id изменен со значения целого числа на строку с версии Ansible 2.5.

псевдонимы: droplet_id
resource_type
строка
    Варианты:
  • droplet ←
Тип ресурса для обработки. В настоящее время поддерживается только присвоение тегов каплям.
state
строка
    Варианты:
  • present ←
  • absent
Указывает, должен ли тег присутствовать или отсутствовать на ресурсе.
timeout
целое число
Значение по умолчанию:
30
Таймаут в секундах для опроса API DigitalOcean.
validate_certs
логическое значение
    Варианты:
  • no
  • yes ←
Если установлено в no, сертификаты SSL не будут проверены.
Это следует устанавливать только в no на сайтах, управляемых лично, с использованием самозаверяющих сертификатов.

Примечания

Примечание

  • Можно использовать две переменные среды, 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': None}}}}


Авторы

  • Victor Volle (@kontrafiktion)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/digitalocean/digital_ocean_tag_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API