Spec-Zone.ru › Ansible 2.4

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

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

  • Описание
  • Требования (к хосту, выполняющему модуль)
  • Параметры
  • Примеры
  • Значения возврата
  • Примечания
    • Статус

Описание

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

Требования (к хосту, выполняющему модуль)

  • python >= 2.6

Параметры

параметр обязательно по умолчанию варианты комментарии
api_token
нет
Токен API DigitalOcean.
name
да
Имя тега. Допустимые символы для имён включают буквы, цифры, дефисы и символы нижнего подчеркивания.
resource_id
нет
Идентификатор ресурса для обработки.
Тип данных resource_id изменен со значения integer на string с версии 2.5.
resource_type
нет droplet
  • droplet
Тип ресурса для обработки. В настоящее время поддерживается только маркировка дроплетов.
state
нет present
  • present
  • absent
Указывает, должен ли тег быть присутствующим или отсутствующим на ресурсе.

Примеры

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

- name: tag a resource; creating the tag if it does not exists
  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
при успехе и без ограничений на ресурс dict {'tag': {'name': 'отлично', 'resources': {'droplets': {'count': 0, 'last_tagged': None}}}}

Примечания

Примечание

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

Статус

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

Для помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочитайте Информацию о сообществе и вклад, Тестирование Ansible и Разработка модулей.

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

Spec-Zone.ru

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