Модуль netapp_eseries.santricity.na_santricity_snapshot – моментальные снимки системы хранения NetApp E-Series.

Примечание

Этот модуль входит в коллекцию netapp_eseries.santricity (версия 1.4.1).

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

Чтобы установить её, используйте: ansible-galaxy collection install netapp_eseries.santricity.

Чтобы использовать её в плейбуке, укажите: netapp_eseries.santricity.na_santricity_snapshot.

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

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

Управление моментальными снимками системы хранения NetApp E-Series.

Параметры

Параметр	Описание
alert_threshold_pct integer	Порог заполнения резервной ёмкости в процентах, при достижении которого будет выдано предупреждение. По умолчанию: `75`
api_password string / обязательный	Пароль для аутентификации в SANtricity Web Services Proxy или API Embedded Web Services.
api_url string / обязательный	URL-адрес SANtricity Web Services Proxy или API Embedded Web Services. Пример: https://prod-1.wahoo.acme.com:8443/devmgr/v2
api_username string / обязательный	Имя пользователя для аутентификации в SANtricity Web Services Proxy или API Embedded Web Services.
group_name string / обязательный	Имя группы согласованности моментальных снимков или тома моментального снимка. Используйте разные имена для групп согласованности моментальных снимков и томов моментальных снимков, чтобы избежать конфликтов имён.
maximum_snapshots integer	Общее количество сохраняемых образов моментальных снимков. По умолчанию: `32`
pit_description string	Произвольное описание образов моментальных снимков группы согласованности.
pit_name string	Имя образов моментальных снимков группы согласованности.
pit_timestamp string	Временная метка образа моментального снимка в формате YYYY-MM-DD HH:MM:SS (AM\|PM) (часы, минуты, секунды и указатель времени суток можно не указывать) Указывайте только столько данных о времени, сколько необходимо для идентификации нужного образа моментального снимка. Если указатель времени суток (AM, PM) не задан, используется 24-часовой формат. Для выбора самого нового или самого старого образа группы согласованности можно использовать значения latest и oldest. Взаимоисключающий параметр с pit_name или pit_description
preferred_reserve_storage_pool string	Пул хранения или группа томов, предпочтительные по умолчанию для тома резервной ёмкости. Если параметр не задан, по умолчанию выбирается пул хранения или группа томов базового тома. Используется для указания пула хранения или группы томов как для томов-участников группы согласованности моментальных снимков, так и для томов моментальных снимков.
reserve_capacity_full_policy string	Политика при заполнении резервной ёмкости. Purge удаляет самый старый образ моментального снимка базового тома в группе согласованности. Reject запрещает запись в базовый том (образы моментальных снимков остаются действительными). Варианты: `"purge"` ← (по умолчанию) `"reject"`
reserve_capacity_pct integer	Доля ёмкости базового тома в процентах, резервируемая по умолчанию для копирования при записи (COW) моментальных снимков. Используется для определения резервной ёмкости как для томов-участников группы согласованности моментальных снимков, так и для томов моментальных снимков. По умолчанию: `40`
rollback_backup boolean	Нужно ли создавать моментальный снимок на определённый момент времени перед выполнением отката. Варианты: `false` `true` ← (по умолчанию)
rollback_priority string	Приоритет, назначаемый системой хранения для восстановления состояния на момент создания моментального снимка. Варианты: `"highest"` `"high"` `"medium"` ← (по умолчанию) `"low"` `"lowest"`
ssid string	Идентификатор управляемого массива. Это значение должно быть уникальным для каждого массива. По умолчанию: `"1"`
state string	Если state==absent, гарантирует удаление type. Если state==present, гарантирует доступность type. Если state==rollback, состояние группы согласованности будет восстановлено до состояния на момент создания образов моментальных снимков, выбранных с помощью pit_name или pit_timestamp. При state==rollback всегда возвращается значение changed, поскольку невозможно оценить текущее состояние базового тома относительно образа моментального снимка. Варианты: `"absent"` `"present"` ← (по умолчанию) `"rollback"`
type string	Тип объекта моментального снимка, над которым выполняется операция. Group обозначает группу согласованности моментальных снимков; в группах согласованности может быть один или несколько базовых томов-участников, определённых в volumes. Pit обозначает образы группы согласованности моментальных снимков на определённый момент времени; при state==present для каждого базового тома будет создан образ моментального снимка. Предупреждение! При state==absent and type==pit необходимо задать pit_name или pit_timestamp. Также будут удалены все образы на определённый момент времени, созданные до выбранного. View обозначает том моментального снимка группы согласованности для выбранных образов на определённый момент времени; для каждого базового тома-участника будут созданы тома моментальных снимков. Представления создаются на основе образов одного и того же момента времени, поэтому после создания их нельзя изменить. Варианты: `"group"` ← (по умолчанию) `"pit"` `"view"`
validate_certs boolean	Следует ли проверять сертификаты HTTPS? Варианты: `false` `true` ← (по умолчанию)
view_host string	Узел или группа узлов, назначаемые по умолчанию для сопоставления томов моментальных снимков.
view_name string	Группа томов моментальных снимков группы согласованности. Обязательный параметр при state==volume или при проверке отсутствия представлений, когда state==absent.
view_validate boolean	Значение по умолчанию, определяющее, следует ли проверять тома моментальных снимков. Варианты: `false` ← (по умолчанию) `true`
view_writable boolean	Значение по умолчанию, определяющее, должны ли тома моментальных снимков быть доступными для записи. Варианты: `false` `true` ← (по умолчанию)
volumes list / elements=dictionary	Сведения о каждом базовом томе группы согласованности: настройки резервной ёмкости, предпочтительного пула хранения для резервной ёмкости и томов моментальных снимков. При state==present and type==group записи томов используются для добавления базовых томов в группу согласованности моментальных снимков или их удаления из неё. При state==present and type==view записи томов используются для выбора образов на определённый момент времени для соответствующих томов моментальных снимков. Если заданы state==present and type==view, но не указан volume, будут выбраны все тома со значениями по умолчанию. Представления создаются на основе образов одного и того же момента времени, поэтому после создания их нельзя изменить. При state==rollback параметр volumes можно использовать для указания базовых томов, которые нужно откатить; в противном случае будут откачены все тома группы согласованности.
preferred_reserve_storage_pool string	Предпочтительный пул хранения или группа томов для тома резервной ёмкости. Если параметр не задан, по умолчанию выбирается пул хранения или группа томов базового тома. Используется для указания пула хранения или группы томов как для томов-участников группы согласованности моментальных снимков, так и для томов моментальных снимков.
reserve_capacity_pct integer	Доля ёмкости базового тома в процентах, резервируемая для копирования при записи (COW) моментальных снимков. Используется для определения резервной ёмкости как для томов-участников группы согласованности моментальных снимков, так и для томов моментальных снимков. По умолчанию: `40`
snapshot_volume_host string	Узел или группа узлов для сопоставления с томом моментального снимка.
snapshot_volume_lun integer	Идентификатор LUN для тома моментального снимка.
snapshot_volume_validate boolean	Нужно ли проверять том моментального снимка; проверка включает сканирование носителя и проверку чётности. Варианты: `false` ← (по умолчанию) `true`
snapshot_volume_writable boolean	Должны ли тома моментальных снимков образов базового тома быть доступными для записи. Варианты: `false` `true` ← (по умолчанию)
volume string / обязательный	Базовый том группы согласованности.

Примечания

Примечание

Для отслеживания имён и описаний моментальных снимков используются пары «ключ-значение», поскольку образы моментальных снимков на определённый момент времени не содержат метаданных в своих структурах данных. Поэтому необходимо удалять устаревшие ключи, не связанные с существующими образами. Очистка выполняется при каждом запуске этого модуля.
Для работы модулей Ansible E-Series необходим либо экземпляр Web Services Proxy (WSP), доступный для управления системой хранения, либо система хранения E-Series с поддержкой API Embedded Web Services.
Embedded Web Services доступен в настоящее время на моделях E2800, E5700, EF570 и более новых моделях оборудования.
netapp_eseries.santricity.netapp_e_storage_system можно использовать для настройки систем, управляемых экземпляром WSP.

Примеры

- name: Ensure snapshot consistency group exists.
  na_santricity_snapshot:
    ssid: "1"
    api_url: https://192.168.1.100:8443/devmgr/v2
    api_username: admin
    api_password: adminpass
    state: present
    type: group
    group_name: snapshot_group1
    volumes:
      - volume: vol1
        reserve_capacity_pct: 20
        preferred_reserve_storage_pool: vg1
      - volume: vol2
        reserve_capacity_pct: 30
      - volume: vol3
    alert_threshold_pct: 80
    maximum_snapshots: 30
- name: Take the current consistency group's base volumes point-in-time snapshot images.
  na_santricity_snapshot:
    ssid: "1"
    api_url: https://192.168.1.100:8443/devmgr/v2
    api_username: admin
    api_password: adminpass
    state: present
    type: pit
    group_name: snapshot_group1
    pit_name: pit1
    pit_description: Initial consistency group's point-in-time snapshot images.
- name: Ensure snapshot consistency group view exists and is mapped to host group.
  na_santricity_snapshot:
    ssid: "1"
    api_url: https://192.168.1.100:8443/devmgr/v2
    api_username: admin
    api_password: adminpass
    state: present
    type: view
    group_name: snapshot_group1
    pit_name: pit1
    view_name: view1
    view_host: view1_hosts_group
    volumes:
      - volume: vol1
        reserve_capacity_pct: 20
        preferred_reserve_storage_pool: vg4
        snapshot_volume_writable: false
        snapshot_volume_validate: true
      - volume: vol2
        reserve_capacity_pct: 20
        preferred_reserve_storage_pool: vg4
        snapshot_volume_writable: true
        snapshot_volume_validate: true
      - volume: vol3
        reserve_capacity_pct: 20
        preferred_reserve_storage_pool: vg4
        snapshot_volume_writable: false
        snapshot_volume_validate: true
    alert_threshold_pct: 80
    maximum_snapshots: 30
- name: Rollback base volumes to consistency group's point-in-time pit1.
  na_santricity_snapshot:
    ssid: "1"
    api_url: https://192.168.1.100:8443/devmgr/v2
    api_username: admin
    api_password: adminpass
    state: present
    type: group
    group_name: snapshot_group1
    pit_name: pit1
    rollback: true
    rollback_priority: high
- name: Ensure snapshot consistency group view no longer exists.
  na_santricity_snapshot:
    ssid: "1"
    api_url: https://192.168.1.100:8443/devmgr/v2
    api_username: admin
    api_password: adminpass
    state: absent
    type: view
    group_name: snapshot_group1
    view_name: view1
- name: Ensure that the consistency group's base volumes point-in-time snapshot images pit1 no longer exists.
  na_santricity_snapshot:
    ssid: "1"
    api_url: https://192.168.1.100:8443/devmgr/v2
    api_username: admin
    api_password: adminpass
    state: absent
    type: image
    group_name: snapshot_group1
    pit_name: pit1
- name: Ensure snapshot consistency group no longer exists.
  na_santricity_snapshot:
    ssid: "1"
    api_url: https://192.168.1.100:8443/devmgr/v2
    api_username: admin
    api_password: adminpass
    state: absent
    type: group
    group_name: snapshot_group1

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

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

Ключ	Описание
changed boolean	Были ли внесены изменения. Возвращается: всегда
deleted_metadata_keys list / elements=string	Ключи, удалённые из хранилища пар «ключ-значение». Возвращается: всегда
group_changes dictionary	Все изменения, внесённые в группу согласованности. Возвращается: всегда

Авторы

Nathan Swartz (@swartzn)
Vu Tran (@VuTran007)

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

© 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/netapp_eseries/santricity/na_santricity_snapshot_module.html