digital_ocean_tag — Создание и удаление тегов для ресурсов DigitalOcean.
Новая версия с 2.2.
Обзор
- Создание и удаление тегов для ресурсов DigitalOcean.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
|
name
обязательно
|
Имя тега. Допускаются символы латинского алфавита, цифры, дефисы и символы подчеркивания.
|
|
| oauth_token |
Токен DigitalOcean OAuth.
Можно использовать несколько переменных среды для указания этого значения.
Например, - 'DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN' и 'OAUTH_TOKEN'
алиасы: api_token |
|
| resource_id |
Идентификатор ресурса, к которому применяется действие.
Тип данных resource_id изменен со целого на строковый, начиная с версии 2.5.
алиасы: droplet_id |
|
| resource_type |
|
Тип ресурса, к которому применяется действие. В настоящее время поддерживается только маркировка капель.
|
| state |
|
Указывает, должен ли тег присутствовать или отсутствовать на ресурсе.
|
| timeout | Значение по умолчанию: 30 |
Время ожидания в секундах для опроса API DigitalOcean.
|
| validate_certs
bool
|
|
Если установлено значение
no, сертификаты SSL не будут проверены.Это значение должно быть установлено в
no только при использовании на контролируемых вами сайтах с самозаверяющими сертификатами. |
Примечания
Примечание
- Можно использовать две переменные среды: 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
dict
|
успешно и без ограничений на ресурс |
Ресурс тега DigitalOcean
Пример:
{'tag': {'name': 'отлично', 'resources': {'droplets': {'count': 0, 'last_tagged': None}}}}
|
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительная информация о техническом обслуживании модулей см. в Документации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Виктор Волле (@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.6/modules/digital_ocean_tag_module.html
