Spec-Zone.ru › Ansible

Модуль netapp.ontap.na_ontap_snapmirror_policy — создание, удаление или изменение политик SnapMirror в NetApp ONTAP

Примечание

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

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

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

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

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

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

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

  • Создание, изменение или удаление политики SnapMirror в NetApp ONTAP
  • Добавление, изменение и удаление правил политики SnapMirror
  • Следующие параметры не поддерживаются в REST: ‘owner’, ‘restart’, ‘transfer_priority’, ‘tries’, ‘ignore_atime’, ‘common_snapshot_schedule’

Требования

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

  • 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

строка

добавлено в netapp.ontap 20.6.0

Путь к файлу сертификата клиента SSL (.pem).

Не поддерживается в Python 2.6.

comment

строка

Задает комментарий к политике SnapMirror.

common_snapshot_schedule

строка

Задает общее расписание создания копий Snapshot, связанное с политикой; требуется только для strict_sync_mirror и sync_mirror.

Не поддерживается в REST.

copy_all_source_snapshots

логическое значение

добавлено в netapp.ontap 22.1.0

Задает, следует ли копировать все исходные копии Snapshot в место назначения при передаче вместо указания конкретных сроков хранения.

Это свойство применимо только к асинхронным политикам.

Для свойства можно задать только значение ‘true’.

Поддерживается только в REST и требует ONTAP 9.10.1 или более поздней версии.

Варианты:

  • false
  • true

copy_latest_source_snapshot

логическое значение

добавлено в netapp.ontap 22.2.0

Задает, следует ли копировать в место назначения при передаче последнюю исходную копию Snapshot (созданную SnapMirror до начала передачи).

Нельзя указывать свойства хранения вместе с этим свойством.

Для свойства можно задать только значение ‘true’.

Поддерживается только в REST и требует ONTAP 9.11.1 или более поздней версии.

Варианты:

  • false
  • true

create_snapshot_on_source

логическое значение

добавлено в netapp.ontap 22.2.0

Задает, следует ли создавать новую копию Snapshot на источнике в начале операции обновления или повторной синхронизации.

Это свойство применимо только к асинхронным политикам.

Для свойства можно задать только значение ‘false’.

Поддерживается только в REST и требует ONTAP 9.11.1 или более поздней версии.

Варианты:

  • false
  • true

feature_flags

словарь

добавлено в netapp.ontap 20.5.0

Включает или отключает новую функцию.

С помощью этого параметра можно включить экспериментальную функцию или отключить новую функцию, нарушающую обратную совместимость.

Поддерживаемые ключи и значения могут измениться без уведомления. Неизвестные ключи игнорируются.

force_ontap_version

строка

добавлено в 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

строка / обязательный

Имя хоста или IP-адрес экземпляра ONTAP.

http_port

целое число

Переопределяет порт по умолчанию (80 или 443), задавая этот порт

https

логическое значение

Включает или отключает https.

Игнорируется при использовании REST, поскольку поддерживается только https.

Игнорируется при использовании аутентификации с сертификатом SSL, так как для нее требуется SSL.

Варианты:

  • false ← (по умолчанию)
  • true

identity_preservation

строка

добавлено в netapp.ontap 22.0.0

Задает, какая конфигурация исходной SVM реплицируется в целевую SVM.

Это свойство применимо только для защиты данных SVM с типом политики “async”.

Поддерживается только в REST.

Варианты:

  • "full"
  • "exclude_network_config"
  • "exclude_network_and_protocol_config"

ignore_atime

логическое значение

Задает, будут ли при инкрементальной передаче игнорироваться файлы, у которых изменилось только время доступа. Применяется только к отношениям SnapMirror vault.

Не поддерживается в REST.

Варианты:

  • false
  • true

is_network_compression_enabled

логическое значение

Задает, включено ли сжатие сети для передач.

Варианты:

  • false
  • true

keep

список / элементы=целое число

добавлено в netapp.ontap 20.7.0

Количество копий Snapshot, созданных по правилу политики SnapMirror, которые следует хранить.

Обязательный параметр при определении правил политики.

key_filepath

строка

добавлено в netapp.ontap 20.6.0

Путь к файлу ключа клиента SSL.

lambda_config

словарь

добавлено в netapp.ontap 23.5.0

Параметры конфигурации функции прокси-сервера AWS Lambda.

Этот параметр и его вложенные параметры поддерживаются только в REST.

aws_profile

строка

Имя профиля AWS, используемого для аутентификации.

aws_region

строка / обязательный

Имя региона AWS.

function_name

строка / обязательный

Имя вызываемой функции AWS Lambda.

ontapi

целое число

Версия API ONTAP, которую следует использовать

owner

строка

Задает владельца политики SnapMirror.

Не поддерживается в REST.

Варианты:

  • "cluster_admin"
  • "vserver_admin"

password

псевдонимы: pass

строка

Пароль указанного пользователя.

policy_name

псевдонимы: name

строка / обязательный

добавлено в netapp.ontap 22.0.0

Задает имя политики SnapMirror.

name добавлен как псевдоним в версии 22.0.0.

policy_type

строка

Задает тип политики SnapMirror. Изменение типа существующей политики SnapMirror не поддерживается.

Типы политик ‘sync’ и ‘async’ поддерживаются только в REST.

Варианты:

  • "vault"
  • "async_mirror"
  • "mirror_vault"
  • "strict_sync_mirror"
  • "sync_mirror"
  • "sync"
  • "async"

prefix

список / элементы=строка

добавлено в netapp.ontap 20.7.0

Префикс правила политики SnapMirror.

Необязательный параметр при определении правил политики.

Установите значение ‘’ чтобы не задавать префикс или удалить существующий пользовательский префикс.

Имя префикса должно быть уникальным в пределах политики.

При указании пользовательского префикса также необходимо указать расписание.

restart

строка

Задает поведение SnapMirror при наличии прерванной передачи; применяется только к защите данных.

Не поддерживается в REST.

Варианты:

  • "always"
  • "never"
  • "default"

schedule

список / элементы=строка

добавлено в netapp.ontap 20.7.0

Расписание правила политики SnapMirror.

Необязательный параметр при определении правил политики.

Установите значение ‘’ чтобы не задавать или удалить расписание.

При указании расписания можно задать пользовательский префикс; в противном случае для префикса будет задано значение snapmirror_label.

snapmirror_label

список / элементы=строка

добавлено в netapp.ontap 20.7.0

Метка правила политики SnapMirror.

Обязательный параметр при определении правил политики.

Чтобы удалить все правила, определенные пользователем, укажите пустой список.

state

строка

Должна ли указанная политика SnapMirror существовать.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

sync_type

строка

добавлено в netapp.ontap 22.2.0

Это свойство применимо только к типам политик sync.

Если для “sync_type” задано значение “sync”, клиент получает подтверждение успешной записи после записи данных в основную конечную точку и до записи данных во вторичную конечную точку.

Если для “sync_type” задано значение “strict_sync”, клиент получает подтверждение успешной записи после записи данных в обе конечные точки — основную и вторичную.

Значение “automated_failover” для “sync_type” можно связать с отношением SnapMirror, конечной точкой которого является группа согласованности; для этого требуется ONTAP 9.7 или более поздняя версия.

Поддерживается только в REST.

Варианты:

  • "sync"
  • "strict_sync"
  • "automated_failover"

transfer_priority

строка

Задает приоритет выполнения передачи SnapMirror.

Не поддерживается в REST.

Варианты:

  • "low"
  • "normal"

transfer_schedule

строка

добавлено в netapp.ontap 22.2.0

Задает имя расписания, используемого для обновления асинхронных отношений SnapMirror.

Не поддерживается в ZAPI.

tries

строка

Задает количество попыток.

Не поддерживается в REST.

use_lambda

логическое значение

добавлено в netapp.ontap 23.2.0

Задает, следует ли использовать функцию прокси-сервера AWS Lambda для подключения к системе ONTAP.

Поддерживается только в REST.

Варианты:

  • false ← (по умолчанию)
  • true

use_rest

строка

Использовать REST или ZAPI.

always — всегда использовать REST API, если модуль его поддерживает. Если модуль не поддерживает REST, выдается предупреждение. Если параметр модуля не поддерживается в REST, выдается ошибка.

never — всегда использовать ZAPI, если модуль его поддерживает. Может быть выдана ошибка, если параметр REST не поддерживается в ZAPI.

auto — пытаться использовать REST API, если модуль поддерживает REST и поддерживаются параметры модуля. В противном случае использовать ZAPI.

По умолчанию: "always"

username

псевдонимы: user

строка

Это может быть учетная запись уровня кластера или уровня SVM — в зависимости от того, требуется ли API уровня кластера или уровня SVM.

Дополнительные сведения см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html.

Поддерживаются два метода аутентификации

  1. Базовая аутентификация с использованием имени пользователя и пароля.
  2. Аутентификация с помощью сертификата SSL с использованием файла сертификата клиента SSL и, при необходимости, файла закрытого ключа.

Для использования сертификата он должен быть установлен в кластере ONTAP, а аутентификация с помощью сертификата должна быть включена.

validate_certs

логическое значение

Если задано значение no, сертификаты SSL не будут проверяться.

Задавайте это значение только для False на сайтах под личным контролем, использующих самоподписанные сертификаты.

Варианты:

  • false
  • true ← (по умолчанию)

vserver

строка

Задает vserver для политики SnapMirror.

Обязательный параметр при использовании ZAPI.

При использовании REST укажите имя vserver данных.

В текущих версиях ONTAP при использовании REST для политик уровня кластера необходимо указать имя кластера (версия 9.12.1 или более ранняя).

В текущих версиях ONTAP возникает ошибка “svm.uuid” is required, если поле vserver не задано.

В более новых версиях ONTAP для политики уровня кластера при использовании REST опустите значение или не указывайте этот параметр.

Примечания

Примечание

  • В REST типы политик ‘mirror_vault’, ‘vault’ и ‘async_mirror’ сопоставляются с policy_type ‘async’.
  • В REST типы политик ‘sync_mirror’ и ‘strict_sync_mirror’ сопоставляются с policy_type ‘sync’.
  • В REST используйте policy_type ‘async’ для настройки ‘mirror-vault’ в CLI.
  • В REST используйте policy_type ‘async’ с ‘copy_all_source_snapshots’ для настройки ‘async-mirror’ с ‘all_source_snapshots’ в CLI.
  • В REST используйте policy_type ‘async’ с ‘copy_latest_source_snapshot’ для настройки ‘async-mirror’ без ‘all_source_snapshots’ в CLI.
  • В REST используйте policy_type ‘async’ с ‘create_snapshot_on_source’ для настройки ‘vault’ в CLI.
  • В REST используйте policy_type ‘sync’ с sync_type ‘sync’ для настройки ‘sync-mirror’ в CLI.
  • В REST используйте policy_type ‘sync’ с sync_type ‘strict_sync’ для настройки ‘strict-sync-mirror’ в CLI.
  • В REST используйте policy_type ‘sync’ с sync_type ‘automated_failover’ для настройки ‘automated-failover’ в CLI.
  • При использовании REST поддерживается функциональность прокси AWS Lambda. Примеры см. в файле README.
  • Модули с префиксом na_ontap предназначены для поддержки платформы хранения ONTAP.
  • HTTPS включен по умолчанию и рекомендуется. Чтобы включить HTTP в кластере, необходимо выполнить следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Примеры

- name: Create SnapMirror policy
  netapp.ontap.na_ontap_snapmirror_policy:
    state: present
    vserver: "SVM1"
    policy_name: "ansible_policy"
    policy_type: "async_mirror"
    copy_latest_source_snapshot: true
    comment: "created by ansible"
    transfer_schedule: "daily"      # when using REST
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

- name: Modify SnapMirror policy
  netapp.ontap.na_ontap_snapmirror_policy:
    state: present
    vserver: "SVM1"
    policy_name: "ansible_policy"
    policy_type: "async_mirror"
    copy_latest_source_snapshot: true
    transfer_priority: "low"        # when using ZAPI
    transfer_schedule: "weekly"     # when using REST
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

- name: Create SnapMirror policy with basic rules
  netapp.ontap.na_ontap_snapmirror_policy:
    state: present
    vserver: "SVM1"
    policy_name: "snapmirror_policy"
    policy_type: "async"
    snapmirror_label: ['daily', 'weekly', 'monthly']
    keep: [7, 5, 12]
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

- name: Modify SnapMirror policy with rules and schedules (no schedule for daily rule)
  netapp.ontap.na_ontap_snapmirror_policy:
    state: present
    vserver: "SVM1"
    policy_name: "snapmirror_policy"
    policy_type: "mirror_vault"
    snapmirror_label: ['daily', 'weekly', 'monthly']
    keep: [7, 5, 12]
    schedule: ['', 'weekly', 'monthly']
    prefix: ['', '', 'monthly_mv']
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

- name: Modify SnapMirror policy with rules, remove existing schedules and prefixes
  netapp.ontap.na_ontap_snapmirror_policy:
    state: present
    vserver: "SVM1"
    policy_name: "snapmirror_policy"
    policy_type: "mirror_vault"
    snapmirror_label: ['daily', 'weekly', 'monthly']
    keep: [7, 5, 12]
    schedule: ['', '', '']
    prefix: ['', '', '']
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

- name: Modify SnapMirror policy, delete all rules (excludes builtin rules)
  netapp.ontap.na_ontap_snapmirror_policy:
    state: present
    vserver: "SVM1"
    policy_name: "snapmirror_policy"
    policy_type: "mirror_vault"
    snapmirror_label: []
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

- name: Delete SnapMirror policy
  netapp.ontap.na_ontap_snapmirror_policy:
    state: absent
    vserver: "SVM1"
    policy_name: "ansible_policy"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: 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_snapmirror_policy_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API