Модуль hitachivantara.vspone_block.vsp.hv_vsp_one_snapshot — управление снимками на системах хранения VSP E series, VSP One Block 20 series и VSP One Block 80 series.

Примечание

Этот модуль входит в коллекцию hitachivantara.vspone_block (версия 4.8.1).

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

Для установки используйте: ansible-galaxy collection install hitachivantara.vspone_block. Для работы с этим модулем необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: hitachivantara.vspone_block.vsp.hv_vsp_one_snapshot.

Добавлено в hitachivantara.vspone_block 4.4.0

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

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

Модуль позволяет создавать, изменять и удалять снимки.
Использует простой API Hitachi Virtual Storage Platform One для управления снимками на моделях VSP One B20 series, VSP One B80 series и VSP E series.
Примеры использования см. на странице https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/vsp_one_snapshot.yml

Требования

На узле, на котором выполняется этот модуль, необходимы следующие компоненты.

python >= 3.9

Параметры

Параметр	Комментарии
connection_info dictionary / обязательный	Сведения, необходимые для установления соединения с системой хранения.
address string / обязательный	IP-адрес или имя хоста системы хранения.
api_token string	Токен, используемый для работы с заблокированными ресурсами.
password string	Пароль для аутентификации. Это обязательное поле.
username string	Имя пользователя для аутентификации. Это обязательное поле.
spec dictionary / обязательный	Параметры конфигурации для операции со снимком.
master_volume_id string	ID основного тома снимка. Это обязательное поле для операций сопоставления, восстановления и удаления снимка. Можно указать десятичное или шестнадцатеричное значение.
new_snapshots list / elements=dictionary	Список конфигураций новых снимков. Это обязательное поле для операции создания снимка.
master_volume_id string / обязательный	Укажите ID основного тома, на основе которого создаются снимки. Можно указать десятичное или шестнадцатеричное значение.
pool_id integer / обязательный	Укажите ID пула, в котором хранятся дифференциальные данные снимка, целым числом в диапазоне от 0 до 127.
snapshot_group_name string / обязательный	Укажите имя группы снимков длиной не более 32 символов.
type string / обязательный	Тип снимка. Значением может быть snapshot или mapped_snapshot; регистр букв не учитывается.
pool_id integer	Укажите ID пула, в котором хранятся дифференциальные данные снимка, целым числом в диапазоне от 0 до 127. Это обязательное поле для операции сопоставления снимка.
should_delete_svol boolean	Удаляет SVOL, если для этого поля задано значение true. Значение по умолчанию — false. Варианты: `false` ← (по умолчанию) `true`
snapshot_id integer	ID снимка. Это обязательное поле для операций сопоставления, восстановления и удаления снимка.
state string	Определяет тип операции со снимком. Доступны варианты `present`, `absent`, `map` и `restore`. Варианты: `"present"` ← (по умолчанию) `"absent"` `"map"` `"restore"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Указывает, работает ли модуль в режиме проверки.

Примеры

- name: Create VSP one snapshot pairs
  # this is a test comment
  hitachivantara.vspone_block.vsp.hv_vsp_one_snapshot:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      new_snapshots:
        - master_volume_id: 1229
          pool_id: 0
          snapshot_group_name: "rd_snapshot_group_1"
          type: "snapshot"
        - master_volume_id: 28
          pool_id: 3
          snapshot_group_name: "rd_snapshot_group_4"
          type: "snapshot"

- name: Map VSP one snapshot pair
  hitachivantara.vspone_block.vsp.hv_vsp_one_snapshot:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
      state: "map"
      spec:
          master_volume_id: 27
          snapshot_id: 7
          pool_id: 3

- name: Restore VSP one snapshot pair
  hitachivantara.vspone_block.vsp.hv_vsp_one_snapshot:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    state: "restore"
    spec:
        master_volume_id: 27
        snapshot_id: 7

- name: Delete VSP one snapshot pair
  hitachivantara.vspone_block.vsp.hv_vsp_one_snapshot:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    state: "absent"
    spec:
        master_volume_id: 27
        snapshot_id: 7

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

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

Ключ	Описание
snapshots list / elements=dictionary	Сведения о снимках, возвращаемые после выполнения операции. Для операции сопоставления возвращаются сведения о сопоставленном томе. Возвращается: always
id string	ID основного тома снимка и ID снимка, разделённые запятой. Возвращается: success Пример: `"6376,3"`
is_volume_capacity_expanding boolean	Указывает, увеличивается ли ёмкость тома. Возвращается: success Пример: `false`
mapped_volume_id integer	ID тома, создаваемого на основе снимков. Значение -1, если сопоставление не выполнено. Возвращается: success Пример: `-1`
mapped_volume_id_hex string	ID сопоставленного тома снимка в шестнадцатеричном формате. Пустое значение, если сопоставление не выполнено. Возвращается: success Пример: `""`
master_volume_id integer	ID основного тома снимка. Возвращается: success Пример: `6376`
master_volume_id_hex string	ID основного тома снимка в шестнадцатеричном формате. Возвращается: success Пример: `"00:18:E8"`
pool_id integer	ID пула, в котором хранятся дифференциальные данные снимков. Возвращается: success Пример: `13`
retention_period integer	Оставшееся время хранения снимка (в часах). Значение 0 означает, что срок не задан или истёк. Возвращается: success Пример: `0`
root_volume_id integer	ID корневого тома снимков. Возвращается: success Пример: `6376`
root_volume_id_hex string	ID корневого тома снимка в шестнадцатеричном формате. Возвращается: success Пример: `"00:18:E8"`
snapshot_date string	Дата и время создания снимка. Возвращается: success Пример: `"2025-10-15T13:07:18Z"`
snapshot_group_name string	Имя группы снимков. Возвращается: success Пример: `"sn_ti_group_6376"`
snapshot_id integer	ID снимка. Получается номер зеркального устройства. Возвращается: success Пример: `3`
status string	Состояние снимка. Возвращается: success Пример: `"Completed"`
type string	Тип снимка. Возвращается: success Пример: `"Snapshot"`
used_capacity_per_root_volume integer	Объём дискового пространства (MiB), занятый дифференциальными данными и управляющей информацией, используемыми группой снимков, созданной на основе того же тома. Возвращается: success Пример: `0`

Авторы

Hitachi Vantara LTD (@hitachi-vantara)

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

© 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/hitachivantara/vspone_block/vsp.hv_vsp_one_snapshot_module.html