Spec-Zone.ru › Ansible 2.5

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

Новое в версии 2.2.

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

Обзор

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

Требования

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

  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_token
Токен API DigitalOcean.
name
обязательно
Имя тега. Допустимые символы для имен включают алфавитно-цифровые символы, дефисы и подчёркивания.
resource_id
Идентификатор ресурса, с которым нужно взаимодействовать.
Тип данных resource_id изменён со строкового на целочисленный в версии 2.5.

псевдонимы: droplet_id
resource_type
    Варианты:
  • droplet ←
Тип ресурса, с которым нужно взаимодействовать. В настоящее время поддерживается только присвоение тегов дроплетам.
state
    Варианты:
  • present ←
  • absent
Указывает, должен ли тег присутствовать или отсутствовать у ресурса.

Примечания

Примечание

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

Примеры

- name: create a tag
  digital_ocean_tag:
    name: production
    state: present

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

- name: untag a resource
  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
  digital_ocean_tag:
    name: dbserver
    state: absent

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

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

Ключ Возвращаемое значение Описание
data
словарь
успешно и без ограничений по ресурсам
ресурс тега DigitalOcean

Пример:
{'tag': {'name': 'отлично', 'resources': {'droplets': {'count': 0, 'last_tagged': None}}}}


Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Автор

  • Виктор Волле (@kontrafiktion)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете редактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/digital_ocean_tag_module.html

Spec-Zone.ru

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