Модуль hitachivantara.vspone_block.sds_block.hv_sds_block_snapshot_facts — получение информации о снимках.

Примечание

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

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

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

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

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

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

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

Собирает информацию (факты) о снимках в системах VSP One SDS Block и Cloud.
Используйте этот модуль для получения сведений о существующих снимках, включая их имена, связанные тома и идентификаторы.
Примеры использования см. в https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/snapshot.yml

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
connection_info dictionary / обязательный	Информация, необходимая для установления соединения с системой хранения.
address string / обязательный	IP-адрес или имя хоста системы хранения.
connection_type string	Тип соединения с системой хранения. Варианты: `"direct"` ← (по умолчанию)
password string / обязательный	Пароль для аутентификации. Это обязательное поле.
username string / обязательный	Имя пользователя для аутентификации. Это обязательное поле.
spec dictionary / обязательный	Параметры фильтрации или определения снимков, для которых нужно собрать факты.
master_volume_id string	Идентификатор основного тома, связанного со снимком. Обязателен для задачи получения снимков по идентификатору основного тома.
master_volume_name string	Имя основного тома, связанного со снимком.
snapshot_volume_id string	Идентификатор тома снимка. Обязателен для задачи получения снимков по идентификатору тома снимка.
snapshot_volume_name string	Имя тома снимка. Обязательно для задачи получения снимков по имени тома снимка.
vps_id string	Идентификатор VPS.
vps_name string	Имя VPS.

Атрибуты

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

Примеры

- name: Gather all snapshots using master volume name
  hitachivantara.vspone_block.sds_block.hv_sds_block_snapshot_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      master_volume_name: "snPvol"

- name: Gather all snapshots using master volume name and snapshot volume name
  hitachivantara.vspone_block.sds_block.hv_sds_block_snapshot_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      master_volume_name: "volume1"
      snapshot_volume_name: "snapshot1"

Возвращаемые факты

Факты, возвращаемые этим модулем, добавляются или обновляются в фактах узла hostvars и могут использоваться по имени так же, как любые другие факты узла. Для их использования не требуется регистрировать их.

Ключ	Описание
snapshots_info list / элементы=dictionary	Список сведений о томах снимков, полученных из системы хранения. Возвращается: всегда
is_written_in_svol boolean	Были ли данные записаны во вторичный том. Возвращается: при успехе
qos_param dictionary	Параметры качества обслуживания снимка. Возвращается: при успехе
upper_alert_allowable_time integer	Пороговое время для верхнего предупреждения в секундах. Возвращается: при успехе
upper_alert_time integer	Текущее значение времени верхнего предупреждения. Возвращается: при успехе
upper_limit_for_iops integer	Верхний предел IOPS. Возвращается: при успехе
upper_limit_for_transfer_rate integer	Верхний предел скорости передачи данных (МБ/с). Возвращается: при успехе
snapshot_concordance_rate integer	Степень согласованности снимка в процентах. Возвращается: при успехе
snapshot_progress_rate integer	Ход выполнения операции создания снимка в процентах. Возвращается: при успехе
snapshot_status string	Текущий статус снимка. Возвращается: при успехе
snapshot_timestamp string	Временная метка создания снимка. Возвращается: при успехе
snapshot_type string	Тип снимка. Возвращается: при успехе
snapshot_volume_id string	Уникальный идентификатор тома снимка. Возвращается: при успехе
snapshot_volume_name string	Имя тома снимка. Возвращается: при успехе
snapshot_volume_nickname string	Псевдоним тома снимка. Возвращается: при успехе
status string	Общий статус снимка. Возвращается: при успехе
status_summary string	Сводка статуса снимка. Возвращается: при успехе
vps_id string	Идентификатор VPS, связанного со снимком. Возвращается: при успехе
vps_name string	Имя VPS, связанного со снимком. Возвращается: при успехе

Авторы

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/sds_block.hv_sds_block_snapshot_facts_module.html