Модуль vultr.cloud.object_storage – Управление объектным хранилищем на Vultr

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install vultr.cloud.

Для использования в книге задач укажите: vultr.cloud.object_storage.

Новое в vultr.cloud 1.12.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управление объектным хранилищем.

Параметры

Параметр	Комментарии
api_endpoint строка	URL конечной точки API (без заключительного слэша). Дополнительная переменная окружения `VULTR_API_ENDPOINT`. Значение по умолчанию: `"https://api.vultr.com/v2"`
api_key строка / обязательно	Ключ API для Vultr API. Дополнительная переменная окружения `VULTR_API_KEY`.
api_retries целое число	Количество попыток повторного выполнения, если Vultr API возвращает HTTP-код ошибки, например, - 429 Слишком много запросов - 500 Внутренняя ошибка сервера - 504 Время ожидания шлюза истекло Дополнительная переменная окружения `VULTR_API_RETRIES`. Значение по умолчанию: `5`
api_retry_max_delay целое число	Задержка повторной попытки в секундах экспоненциально увеличивается до этого максимального значения. Дополнительная переменная окружения `VULTR_API_RETRY_MAX_DELAY`. Значение по умолчанию: `12`
api_timeout целое число	Таймаут HTTP-соединения с Vultr API. Дополнительная переменная окружения `VULTR_API_TIMEOUT`. Значение по умолчанию: `180`
cluster строка / обязательно	Имя хоста кластера, где будет создано объектное хранилище.
label псевдонимы: name строка / обязательно	Имя объектного хранилища.
state строка	Состояние объектного хранилища. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs логическое значение	Проверка SSL-сертификатов Vultr API. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Также см. документацию API по адресу https://www.vultr.com/api/.

Примеры

---
- name: Ensure an object storage is present
  vultr.cloud.object_storage:
    label: my object storage
    cluster: ewr1.vultrobjects.com

- name: Ensure an object storage is absent
  vultr.cloud.object_storage:
    label: my object storage
    cluster: ewr1.vultrobjects.com
    state: absent

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
vultr_api словарь	Ответ от API Vultr с несколькими дополнениями/изменениями. Возвращено: success
api_account строка	Аккаунт, используемый в файле ini для выбора ключа. Возвращено: success Пример: `"default"`
api_endpoint строка	Точка входа, используемая для запросов API. Возвращено: success Пример: `"https://api.vultr.com/v2"`
api_retries целое число	Максимальное количество повторных попыток для запросов API. Возвращено: success Пример: `5`
api_retry_max_delay целое число	Задержка экспоненциального возврата в секундах между повторными попытками до этого максимального значения задержки. Возвращено: success Пример: `12`
api_timeout целое число	Таймаут, используемый для запросов API. Возвращено: success Пример: `60`
vultr_block_storage словарь	Ответ от API Vultr. Возвращено: success
date_created строка	Дата создания хранилища объектов. Возвращено: success Пример: `"2020-10-10T01:56:20+00:00"`
id строка	Уникальный идентификатор хранилища объектов. Возвращено: success Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
label строка	Метка, заданная пользователем для этого хранилища объектов. Возвращено: success Пример: `"my object storage"`
region строка	Регион для этого хранилища объектов. Возвращено: success Пример: `"ews"`
s3_access_key строка	Ключ доступа к хранилищу объектов. Возвращено: success Пример: `"00example11223344"`
s3_hostname строка	Имя хоста кластера для этого хранилища объектов. Возвращено: success Пример: `"ewr1.vultrobjects.com"`
s3_secret_key строка	Секретный ключ хранилища объектов. Возвращено: success Пример: `"00example1122334455667788990011"`
status строка	Статус этого хранилища объектов. Возвращено: success Пример: `"active"`

Авторы

René Moser (@resmo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/vultr/cloud/object_storage_module.html