Модуль netapp.ontap.na_ontap_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_snapshot.

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

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

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

Создание, изменение и удаление снимков ONTAP

Требования

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

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

Параметры

Параметр	Описание
async_bool boolean	Если значение равно true, снимок создаётся асинхронно. Варианты: `false` `true`
cert_filepath string добавлен в netapp.ontap 20.6.0	Путь к файлу сертификата клиента SSL (.pem). Не поддерживается в Python 2.6.
comment string	Понятный для пользователя комментарий к снимку. Длина комментария не должна превышать 255 символов.
expiry_time string добавлен в netapp.ontap 21.8.0	Время истечения срока действия снимка; доступно только при использовании REST. Формат должен соответствовать часовому поясу, настроенному в кластере.
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.
from_name string добавлен в netapp.ontap 2.8.0	Имя существующего снимка, которое следует изменить.
hostname string / обязательный	Имя узла или IP-адрес экземпляра ONTAP.
http_port integer	Позволяет переопределить порт по умолчанию (80 или 443).
https boolean	Включает или отключает HTTPS. Игнорируется при использовании REST, поскольку поддерживается только HTTPS. Игнорируется при использовании аутентификации с сертификатом SSL, поскольку для неё требуется SSL. Варианты: `false` ← (по умолчанию) `true`
ignore_owners boolean	Если значение этого поля равно true, снимок будет удалён, даже если к нему обращаются другие процессы. Варианты: `false` `true`
key_filepath string добавлен в netapp.ontap 20.6.0	Путь к файлу ключа клиента SSL.
lambda_config dictionary добавлен в netapp.ontap 23.3.0	Параметры конфигурации прокси-функции AWS Lambda. Эти параметры и вложенные параметры поддерживаются только при использовании REST.
aws_profile string	Имя профиля AWS для аутентификации.
aws_region string / обязательный	Название региона AWS.
function_name string / обязательный	Имя вызываемой функции AWS Lambda.
ontapi integer	Версия API ONTAP, которую следует использовать.
password псевдонимы: pass string	Пароль указанного пользователя.
snaplock_expiry_time string добавлен в netapp.ontap 23.2.0	Срок действия SnapLock для снимка, если он создан на томе SnapLock. Поддерживается только с REST; требуется ONTAP 9.15.1 или новее.
snapmirror_label string	Понятная для пользователя метка SnapMirror, прикреплённая к снимку. Длина метки не должна превышать 31 символ. Поддерживается в REST для ONTAP 9.7 или новее.
snapshot string / обязательный	Имя снимка, которым необходимо управлять. Максимальная длина строки — 256 символов.
snapshot_instance_uuid string	Уникальный 128-битный идентификатор снимка в формате UUID.
state string	Определяет, следует ли создать или изменить снимок либо удалить его. Варианты: `"present"` ← (по умолчанию) `"absent"`
use_lambda boolean добавлен в netapp.ontap 23.2.0	Указывает, следует ли использовать прокси-функцию AWS Lambda для подключения к системе ONTAP. Поддерживается только с REST. Варианты: `false` ← (по умолчанию) `true`
use_rest string	Определяет, следует ли использовать REST или ZAPI. always — всегда использовать REST API, если модуль его поддерживает. Если модуль не поддерживает REST, выдаётся предупреждение. Если параметр модуля не поддерживается в REST, возникает ошибка. never — всегда использовать 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` ← (по умолчанию)
volume string / обязательный	Имя тома, на котором необходимо создать снимок.
vserver string / обязательный	Имя Vserver.

Примечания

Примечание

При использовании REST поддерживается прокси-функция AWS Lambda. Примеры см. в файле README.
Модули с префиксом na_ontap предназначены для работы с платформой хранения ONTAP.
HTTPS включён по умолчанию и рекомендуется к использованию. Чтобы включить HTTP в кластере, выполните следующие команды: «set -privilege advanced;» «system services web modify -http-enabled true;»

Примеры

- name: Create SnapShot
  netapp.ontap.na_ontap_snapshot:
    state: present
    snapshot: "{{ snapshot_name }}"
    volume: "{{ vol_name }}"
    comment: "sample comment"
    expiry_time: "2022-02-04T14:00:00-05:00"
    vserver: "{{ vserver name }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete SnapShot
  netapp.ontap.na_ontap_snapshot:
    state: absent
    snapshot: "{{ snapshot_name }}"
    volume: "{{ vol_name }}"
    vserver: "{{ vserver_name }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Modify SnapShot
  netapp.ontap.na_ontap_snapshot:
    state: present
    snapshot: "{{ snapshot_name }}"
    comment: "New comments are great"
    volume: "{{ vol_name }}"
    vserver: "{{ vserver_name }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Авторы

Команда 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_snapshot_module.html