community.general.scaleway_volume – Модуль управления томами Scaleway

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

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

Чтобы использовать его в книге задач, укажите: community.general.scaleway_volume.

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

Обзор

Этот модуль управляет томами на аккаунте Scaleway https://developer.scaleway.com

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число	По умолчанию: 30	Таймаут HTTP-запросов к API Scaleway в секундах. Псевдонимы: timeout
api_token строка / обязательно		Токен Scaleway OAuth. Псевдонимы: oauth_token
api_url строка	По умолчанию: "https://api.scaleway.com"	URL API Scaleway. Псевдонимы: base_url
name строка / обязательно		Имя для идентификации тома.
organization строка		Идентификатор организации Scaleway, к которой принадлежит том.
query_parameters словарь	По умолчанию: {}	Список параметров, передаваемых в строку запроса.
region строка / обязательно	Варианты: ams1 EMEA-NL-EVS par1 EMEA-FR-PAR1 par2 EMEA-FR-PAR2 waw1 EMEA-PL-WAW1	Регион Scaleway для использования (например, par1).
size целое число		Размер тома в байтах.
state строка	Варианты: present ← absent	Указывает желаемое состояние тома.
validate_certs булево	Варианты: no yes ←	Проверять SSL-сертификаты API Scaleway.
volume_type строка		Тип тома (например, 'l_ssd').

Примечания

Примечание

Также см. документацию API на https://developer.scaleway.com/
Если api_token не задано в модуле, можно использовать следующие переменные среды в порядке убывания приоритета: SCW_TOKEN, SCW_API_KEY, SCW_OAUTH_TOKEN или SCW_API_TOKEN.
Если требуется использовать другой api_url, можно также установить переменную среды SCW_API_URL.

Примеры

- name: Create 10GB volume
  community.general.scaleway_volume:
    name: my-volume
    state: present
    region: par1
    organization: "{{ scw_org }}"
    "size": 10000000000
    volume_type: l_ssd
  register: server_creation_check_task

- name: Make sure volume deleted
  community.general.scaleway_volume:
    name: my-volume
    state: absent
    region: par1

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
data словарь	при `state=present`	Присутствует только при `state=present` Пример: {'volume': {'export_uri': None, 'id': 'c675f420-cfeb-48ff-ba2a-9d2a4dbe3fcd', 'name': 'volume-0-3', 'organization': '000a115d-2852-4b0a-9ce8-47f1134ba95a', 'server': None, 'size': 10000000000, 'volume_type': 'l_ssd'}}

Авторы

Генрик Консек (@hekonsek)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/scaleway_volume_module.html