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 строка | Токен DigitalOcean OAuth. Существуют и другие переменные окружения, которые можно использовать для предоставления этого значения. Например, - 'DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN' и 'OAUTH_TOKEN' псевдонимы: api_token | |
| resource_id строка | Идентификатор ресурса, для которого будут выполняться операции. Тип данных resource_id изменен со значения целого числа на строку начиная с Ansible 2.5. псевдонимы: droplet_id | |
| resource_type строка |
| Тип ресурса, для которого будут выполняться операции. В настоящее время поддерживается только добавление тегов к каплям. |
| state строка |
| Указывает, должен ли тег присутствовать или отсутствовать на ресурсе. |
| timeout целое число | Значение по умолчанию: 30 | Таймаут в секундах для опроса API DigitalOcean. |
| validate_certs булево |
| Если установлено в значение 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': {'name': 'awesome', 'resources': {'droplets': {'count': 0, 'last_tagged': None}}}} |
Авторы
- Victor Volle (@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.10/collections/community/digitalocean/digital_ocean_tag_module.html