digital_ocean_tag – Создание и удаление тега(ов) для ресурса DigitalOcean
Описание
- Создание и удаление тега(ов) для ресурса 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 булево |
| Если установлено значение 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
loop:
- 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}}}} |
Статус
- Гарантия обратной совместимости этого модуля не предоставляется. [превью]
- Этот модуль поддерживается сообществом 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.9/modules/digital_ocean_tag_module.html
