Модуль cloudscale_ch.cloud.volume_snapshot — управление снимками томов в сервисе IaaS cloudscale.ch

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: cloudscale_ch.cloud.volume_snapshot.

Добавлено в cloudscale_ch.cloud 2.5.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Получение, создание, обновление и удаление снимков томов в сервисе IaaS cloudscale.ch.

Параметры

Параметр	Комментарии
api_timeout integer	Тайм-аут в секундах для вызовов API cloudscale.ch. Это значение также можно передать через переменную окружения `CLOUDSCALE_API_TIMEOUT`. По умолчанию: `45`
api_token string / обязательный	Токен API cloudscale.ch. Это значение также можно передать через переменную окружения `CLOUDSCALE_API_TOKEN`.
api_url string добавлено в cloudscale_ch.cloud 1.3.0	URL API cloudscale.ch. Это значение также можно передать через переменную окружения `CLOUDSCALE_API_URL`. По умолчанию: `"https://api.cloudscale.ch/v1"`
name string	Имя снимка тома. Требуется указать либо name, либо uuid.
source_volume string	UUID тома, к которому относится этот снимок. Если указаны name и source_volume, создаётся новый снимок тома. Этот параметр не влияет на существующие снимки томов (указан параметр uuid).
state string	Состояние снимка тома. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags dictionary	Теги, назначенные снимку тома. Укажите `{}`, чтобы удалить все теги.
uuid string	UUID снимка тома.

Примечания

Примечание

Если указан параметр uuid, при выборе снимка тома он имеет приоритет над name. Это позволяет изменить имя снимка тома.
Если параметр uuid не указан, для выбора снимка тома используется name. Если существует несколько снимков тома с таким именем, выполнение прерывается.
Чтобы восстановить снимок, используйте модуль volume.
Все операции выполняются с помощью публичного API cloudscale.ch v1.
Подробную информацию см. в полной документации API: https://www.cloudscale.ch/en/api/v1.
Для выполнения всех операций требуется действительный токен API. Вы можете создать любое количество токенов в панели управления cloudscale.ch: https://control.cloudscale.ch.

Примеры

# Create a volume snapshot for a volume
- name: Create a volume snapshot
  cloudscale_ch.cloud.volume_snapshot:
    name: 'pre-dist-upgrade'
    source_volume: '2db69ba3-1864-4608-853a-0771b6885a3a'
    tags: {}
    api_token: xxxxx

# Get a volume snapshot by name
- name: Get facts of a volume snapshot
  cloudscale_ch.cloud.volume_snapshot:
    name: 'pre-dist-upgrade'
    api_token: xxxxx

# Delete a volume snapshot
- name: Delete a volume snapshot
  cloudscale_ch.cloud.volume_snapshot:
    uuid: '351d461c-2333-455f-b788-db11bf0b4aa2'
    state: absent

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

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

Ключ	Описание
created_at string	Дата и время создания ресурса. Возвращается: state == present Пример: `"2025-04-10T11:05:45.777073Z"`
href string	URL API для получения сведений об этом снимке тома. Возвращается: state == present Пример: `"https://api.cloudscale.ch/v1/volume-snapshots/e504dc99-ff01-4e89-ad89-7df080f97b4b"`
name string	Отображаемое имя снимка тома. Возвращается: state == present Пример: `"my_ssd_volume_snapshot"`
size_gb string	Размер тома в ГБ. Возвращается: state == present Пример: `"50"`
source_volume dictionary	Исходный том, к которому относится этот снимок. Возвращается: state == present Пример: `{"source_volume": {"href": "https://api.cloudscale.ch/v1/volumes/0952b1ca-3657-4901-b4c8-669796ec55e6", "name": "my_ssd_volume", "uuid": "0952b1ca-3657-4901-b4c8-669796ec55e6"}}`
state string	Текущее состояние тома. Возвращается: при успешном выполнении Пример: `"present"`
status string	Текущий статус снимка тома. Возвращается: при успешном выполнении Пример: `"available"`
tags dictionary	Теги, связанные с томом. Возвращается: state == present Пример: `{"project": "my project"}`
uuid string	Уникальный идентификатор этого снимка тома. Возвращается: state == present Пример: `"e504dc99-ff01-4e89-ad89-7df080f97b4b"`

Авторы

Ciril Troxler (@ctx)

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

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