модуль netapp.ontap.na_ontap_cg_snapshot — управление снимками групп согласованности NetApp ONTAP

Примечание

Этот модуль входит в коллекцию netapp.ontap (версия 23.5.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: netapp.ontap.na_ontap_cg_snapshot.

Добавлено в netapp.ontap 2.7.0

Краткое описание
Требования
Параметры
Примечания
Примеры

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

Создание или удаление снимка группы согласованности для томов ONTAP.

Требования

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

Ansible 2.9 или более поздней версии; рекомендуется версия 2.12 или более поздняя.
Python3; рекомендуется версия 3.9 или более поздняя.
netapp-lib требуется только при использовании ZAPI (установка командой ‘pip install netapp-lib’). Обратите внимание, что netapp-lib устарел и больше не поддерживается. Используйте его на свой страх и риск.
Физическая или виртуальная кластерная система Data ONTAP. Модули поддерживают Data ONTAP 9.1 и более поздние версии; для поддержки REST требуется ONTAP 9.6 или более поздняя версия.

Параметры

Параметр	Комментарии
cert_filepath string добавлено в netapp.ontap 20.6.0	Путь к файлу сертификата клиента SSL (.pem). Не поддерживается в Python 2.6.
comment string добавлено в netapp.ontap 22.8.0	Комментарий к копии снимка. Поддерживается только с REST.
consistency_group string добавлено в netapp.ontap 22.8.0	Имя группы согласованности, для которой требуется создать или удалить снимок. Действительно только с REST.
consistency_type string добавлено в netapp.ontap 23.2.0	Тип гарантии согласованности для снимка. Поддерживается только с REST. Если параметр не указан, ONTAP использует тип согласованности по умолчанию. Варианты: `"crash"` `"application"`
feature_flags dictionary добавлено в netapp.ontap 20.5.0	Включение или отключение новой функции. Этот параметр можно использовать для включения экспериментальной функции или отключения новой функции, нарушающей обратную совместимость. Поддерживаемые ключи и значения могут изменяться без предварительного уведомления. Неизвестные ключи игнорируются.
force_ontap_version string добавлено в netapp.ontap 21.23.0	Переопределение версии ONTAP кластера при использовании REST. Поведение не определено, если версия не соответствует целевому кластеру. Этот параметр служит обходным решением, если не удается прочитать версию кластера из-за проблем с разрешениями. См. https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. Значение должно иметь формат 9.10 или 9.10.1, где каждый элемент — целое число. Если для `use_rest` задано значение auto, это может принудительно переключить модуль на ZAPI в зависимости от версии и возможностей платформы. Игнорируется при использовании ZAPI.
hostname string / обязательный	Имя хоста или IP-адрес экземпляра ONTAP.
http_port integer	Переопределение порта по умолчанию (80 или 443) указанным портом
https boolean	Включение и отключение https. Игнорируется при использовании REST, так как поддерживается только https. Игнорируется при использовании аутентификации по сертификату SSL, поскольку для нее требуется SSL. Варианты: `false` ← (по умолчанию) `true`
key_filepath string добавлено в netapp.ontap 20.6.0	Путь к файлу ключа клиента SSL.
ontapi integer	Используемая версия API ONTAP
password псевдонимы: pass string	Пароль указанного пользователя.
snapmirror_label string	Понятная человеку метка SnapMirror, прикрепляемая к копиям снимка группы согласованности.
snapshot string / обязательный	Заданное имя снимка, который создается в каждом томе.
state string	Указывает, следует ли создать или удалить снимок. Вариант ‘absent’ допустим только с REST. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout string	Параметр выбора времени ожидания. Не поддерживается с REST. Варианты: `"urgent"` `"medium"` ← (по умолчанию) `"relaxed"`
use_lambda boolean добавлено в netapp.ontap 23.2.0	Указывает, следует ли использовать функцию прокси AWS Lambda для подключения к системе ONTAP. Поддерживается только с REST. Варианты: `false` ← (по умолчанию) `true`
use_rest string	Определяет, использовать REST или ZAPI. always — всегда использовать REST API, если модуль поддерживает REST. Если модуль не поддерживает REST, выдается предупреждение. Если параметр модуля не поддерживается в REST, выдается ошибка. never — всегда использовать ZAPI, если модуль поддерживает ZAPI. Если параметр REST не поддерживается в ZAPI, может быть выдана ошибка. auto — пытаться использовать REST API, если модуль поддерживает REST и параметры модуля поддерживаются. В противном случае выполняется переход на ZAPI. По умолчанию: `"always"`
username псевдонимы: user string	Учетная запись может быть на уровне кластера или SVM в зависимости от того, требуется ли API уровня кластера или уровня SVM. Дополнительную информацию см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Поддерживаются два метода аутентификации Базовая аутентификация с использованием имени пользователя и пароля. Аутентификация по сертификату SSL с использованием файла сертификата клиента SSL и, при необходимости, файла закрытого ключа. Для использования сертификата он должен быть установлен в кластере ONTAP, а аутентификация по сертификату должна быть включена.
validate_certs boolean	Если задано значение `no`, сертификаты SSL не будут проверяться. Это следует задавать только как `False` на сайтах под личным управлением, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)
volumes list / элементы=string	Список томов этой системы хранения, участвующих в данной операции с группой согласованности. Обязательный параметр при использовании ZAPI.
vserver string / обязательный	Имя vserver.

Примечания

Примечание

Для поддержки REST требуется ONTAP 9.10 или более поздняя версия.
Операция удаления поддерживается только с REST.
Модули с префиксом na_ontap предназначены для поддержки платформы хранения ONTAP.
HTTPS включен по умолчанию и рекомендуется к использованию. Чтобы включить HTTP в кластере, выполните следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Примеры

- name: Create CG snapshot
  na_ontap_cg_snapshot:
    state: present
    vserver: vserver_name
    snapshot: snapshot name
    volumes: vol_name
    # consistency_type defaults to 'crash' if not specified
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

- name: Create CG snapshot using CG name - REST
  na_ontap_cg_snapshot:
    state: present
    vserver: vserver_name
    snapshot: snapshot_name
    consistency_group: cg_name
    snapmirror_label: sm_label
    consistency_type: application
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

- name: Create CG snapshot using volumes - REST
  na_ontap_cg_snapshot:
    state: present
    vserver: vserver_name
    snapshot: snapshot_name
    volumes:
      - vol1
      - vol2
    snapmirror_label: sm_label
    consistency_type: crash
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

- name: Delete CG snapshot - REST
  na_ontap_cg_snapshot:
    state: absent
    vserver: vserver_name
    snapshot: snapshot_name
    consistency_group: cg_name
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

Авторы

Команда NetApp Ansible (@carchi8py)

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

© 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/ontap/na_ontap_cg_snapshot_module.html