модуль netapp.ontap.na_ontap_snapshot_policy — управление политиками снимков 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_policy.

Добавлено в netapp.ontap 2.8.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	Понятный для пользователя комментарий, прикреплённый к снимку. Длина комментария не может превышать 255 символов.
count list / elements=integer	Количество снимков, создаваемых по расписанию и сохраняемых для хранения.
enabled boolean	Состояние политики снимков, определяющее, включена она или отключена. Варианты: `false` `true`
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-клиента.
lambda_config dictionary добавлено в netapp.ontap 23.5.0	Параметры конфигурации прокси-функциональности AWS Lambda. Этот параметр и его подчинённые параметры поддерживаются только при использовании REST.
aws_profile string	Имя профиля AWS для аутентификации.
aws_region string / обязательный	Название региона AWS.
function_name string / обязательный	Имя вызываемой функции AWS Lambda.
name string / обязательный	Имя управляемой политики снимков. Максимальная длина строки — 256 символов.
ontapi integer	Версия API ONTAP для использования.
password псевдонимы: pass string	Пароль указанного пользователя.
prefix list / elements=string добавлено в netapp.ontap 19.11.0	Префикс имени снимка для расписания. Имя префикса должно быть уникальным в рамках политики. Нельзя задать другой префикс для расписания, уже назначенного политике снимков. Префикс нельзя изменить после добавления расписания.
retention_period list / elements=string добавлено в netapp.ontap 22.12.0	Срок хранения копий Snapshot для расписания. Допустимые значения: «infinite» или длительность в формате ISO 8601. Значение срока хранения, заданное в формате ISO 8061, должно быть указано в секундах (PT0S - PT65535S), минутах (PT0M - PT60M), часах (PT0H - PT24H), днях (P0D - P36500D), месяцах (P0M - P1200M) или годах (P0Y - P100Y). Поддерживается только с REST и требует ONTAP 9.12 или новее.
schedule list / elements=string	Расписание для добавления в политику.
snapmirror_label list / elements=string добавлено в netapp.ontap 2.9.0	Метка SnapMirror, назначаемая каждому расписанию в политике. Для отсутствия метки используйте пустую строку (‘’).
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` ← (по умолчанию)
vserver string добавлено в netapp.ontap 2.9.0	Имя используемого vserver. В среде с несколькими арендаторами назначение политики Snapshot vserver ограничит её использование этим vserver.

Примечания

Примечание

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

Примеры

- name: Create Snapshot policy
  netapp.ontap.na_ontap_snapshot_policy:
    state: present
    name: ansible2
    schedule: hourly
    prefix: hourly
    count: 150
    enabled: true
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    https: false

- name: Create Snapshot policy with multiple schedules
  netapp.ontap.na_ontap_snapshot_policy:
    state: present
    name: ansible2
    schedule: ['hourly', 'daily', 'weekly', 'monthly', '5min']
    prefix: ['hourly', 'daily', 'weekly', 'monthly', '5min']
    count: [1, 2, 3, 4, 5]
    enabled: true
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    https: false

- name: Create Snapshot policy owned by a vserver
  netapp.ontap.na_ontap_snapshot_policy:
    state: present
    name: ansible3
    vserver: ansible
    schedule: ['hourly', 'daily', 'weekly', 'monthly', '5min']
    prefix: ['hourly', 'daily', 'weekly', 'monthly', '5min']
    count: [1, 2, 3, 4, 5]
    snapmirror_label: ['hourly', 'daily', 'weekly', 'monthly', '']
    enabled: true
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    https: false

- name: Modify Snapshot policy with multiple schedules
  netapp.ontap.na_ontap_snapshot_policy:
    state: present
    name: ansible2
    schedule: ['daily', 'weekly']
    count: [20, 30]
    snapmirror_label: ['daily', 'weekly']
    enabled: true
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    https: false

- name: Delete Snapshot policy
  netapp.ontap.na_ontap_snapshot_policy:
    state: absent
    name: ansible2
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    https: false

Авторы

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