netapp.ontap.na_ontap_snapmirror_policy модуль — NetApp ONTAP создание, удаление или изменение политик SnapMirror
Примечание
Этот модуль входит в состав коллекции netapp.ontap (версия 22.12.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 или более поздней версии; рекомендуется Ansible 2.12 или более поздней версии.
- Python3 - 3.9 или более поздней версии; рекомендуется.
- При использовании ZAPI, netapp-lib 2018.11.13 или более поздней версии (установка с помощью «pip install netapp-lib»); strongly рекомендуется netapp-lib 2020.3.12, так как он обеспечивает лучшую обработку ошибок при подключении.
- физическая или виртуальная кластеризованная система Data ONTAP; модули поддерживают Data ONTAP 9.1 и более поздние версии; поддержка REST требует ONTAP 9.6 или более поздней версии
Параметры
Параметр | Комментарии |
|---|---|
cert_filepath string added in netapp.ontap 20.6.0 | путь к файлу сертификата клиента SSL (.pem). не поддерживается с python 2.6. |
comment string | Указывает комментарий к политике SnapMirror. |
common_snapshot_schedule string | Указывает общее расписание копирования моментальных снимков, связанное с политикой, требуется только для strict_sync_mirror и sync_mirror. Не поддерживается с REST. |
copy_all_source_snapshots boolean added in netapp.ontap 22.1.0 | Указывает, следует ли копировать все копии моментальных снимков источника в назначение при передаче, а не указывать конкретные периоды хранения. Это свойство применимо только к асинхронным политикам. Свойство можно установить только в значение «true». Поддерживается только с REST и требует ONTAP 9.10.1 или более поздней версии. Варианты:
|
copy_latest_source_snapshot boolean added in netapp.ontap 22.2.0 | Указывает, что последняя копия моментального снимка источника (созданная SnapMirror до начала передачи) должна быть скопирована в назначение при передаче. Свойства хранения не могут быть указаны вместе с этим свойством. Свойство можно установить только в значение «true». Поддерживается только с REST и требует ONTAP 9.11.1 или более поздней версии. Варианты:
|
create_snapshot_on_source boolean added in netapp.ontap 22.2.0 | Указывает, следует ли создавать новую копию моментального снимка на источнике в начале операции обновления или повторной синхронизации. Это свойство применимо только к асинхронным политикам. Свойство можно установить только в значение «false». Поддерживается только с REST и требует ONTAP 9.11.1 или более поздней версии. Варианты:
|
feature_flags dictionary added in netapp.ontap 20.5.0 | Включить или отключить новую функцию. Это можно использовать для включения экспериментальной функции или отключения новой функции, которая нарушает обратную совместимость. Поддерживаемые ключи и значения могут изменяться без предварительного уведомления. Неизвестные ключи игнорируются. |
force_ontap_version string added in netapp.ontap 21.23.0 | Переопределить версию ONTAP кластера при использовании REST. Поведение не определено, если версия не соответствует целевому кластеру. Это предоставлено как обходной путь, когда версию кластера невозможно прочитать из-за проблем с разрешениями. См. https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. Это должно быть в формате 9.10 или 9.10.1, где каждый элемент является целым числом. Когда Игнорируется с ZAPI. |
hostname string / required | Имя хоста или IP-адрес экземпляра ONTAP. |
http_port integer | Переопределить порт по умолчанию (80 или 443) этим портом |
https boolean | Включить и отключить https. Игнорируется при использовании REST, так как поддерживается только https. Игнорируется при использовании проверки подлинности сертификата SSL, так как она требует SSL. Варианты:
|
identity_preservation string added in netapp.ontap 22.0.0 | Указывает, какая конфигурация исходного SVM реплицируется в целевой SVM. Это свойство применимо только для защиты данных SVM с типом политики «async». Поддерживается только с REST. Варианты:
|
ignore_atime boolean | Указывает, будут ли приращенные передачи игнорировать файлы, у которых изменено только время доступа. Применяется только к отношениям хранилища SnapMirror. Не поддерживается с REST. Варианты:
|
is_network_compression_enabled boolean | Указывает, включена ли сжатие сети для передач. Варианты:
|
keep list / elements=integer added in netapp.ontap 20.7.0 | Количество периодов хранения правила политики SnapMirror для созданных моментальных снимков. Требуется при определении правил политики. |
key_filepath string added in netapp.ontap 20.6.0 | путь к файлу ключа клиента SSL. |
ontapi integer | Номер версии API ontap, который нужно использовать |
owner string | Указывает владельца политики SnapMirror. Не поддерживается с REST. Варианты:
|
password aliases: pass string | Пароль для указанного пользователя. |
policy_name aliases: name string / required добавлено в netapp.ontap 22.0.0 | Указывает имя политики SnapMirror.
|
policy_type string | Указывает тип политики SnapMirror. Изменение типа существующей политики SnapMirror не поддерживается. Типы политик «sync» и «async» поддерживаются только в REST. Варианты:
|
prefix list / elements=string добавлено в netapp.ontap 20.7.0 | Префикс правила политики SnapMirror. Необязательно при определении правил политики. Установите значение ‘’ для того, чтобы не устанавливать или удалить существующий пользовательский префикс. Имя префикса должно быть уникальным в рамках политики. При указании пользовательского префикса также необходимо указать расписание. |
restart string | Определяет поведение SnapMirror, если существует прерванная передача, применяется только к защите данных. Не поддерживается с REST. Варианты:
|
schedule list / elements=string добавлено в netapp.ontap 20.7.0 | Расписание правила политики SnapMirror. Необязательно при определении правил политики. Установите значение ‘’ для того, чтобы не устанавливать или удалить расписание. При указании расписания можно установить пользовательский префикс, иначе префикс будет установлен как snapmirror_label. |
snapmirror_label list / elements=string добавлено в netapp.ontap 20.7.0 | Метка правила политики SnapMirror. Обязательно при определении правил политики. Используйте пустой список, чтобы удалить все определенные пользователем правила. |
state string | Должна ли существовать указанная политика SnapMirror или нет. Варианты:
|
sync_type string добавлено в netapp.ontap 22.2.0 | Это свойство применимо только к типам политик синхронизации. Если «sync_type» имеет значение «sync», то клиенту возвращается подтверждение успешной записи после записи данных в основную конечную точку и до записи данных во вторичную конечную точку. Если «sync_type» имеет значение «strict_sync», то клиенту возвращается подтверждение успешной записи после записи данных как в основную, так и во вторичную конечные точки. «sync_type» со значением «automated_failover» может быть связан с отношением SnapMirror, имеющим группу согласованности в качестве конечной точки, и требует ONTAP 9.7 или более поздней версии. Поддерживается только с REST. Варианты:
|
transfer_priority string | Указывает приоритет выполнения передачи SnapMirror. Не поддерживается с REST. Варианты:
|
transfer_schedule string добавлено в netapp.ontap 22.2.0 | Указывает имя расписания, используемого для обновления асинхронных отношений SnapMirror. Не поддерживается с ZAPI. |
tries string | Указывает количество попыток. Не поддерживается с REST. |
use_rest string | Использовать REST или ZAPI. always – всегда будет использовать REST API, если модуль поддерживает REST. Выдается предупреждение, если модуль не поддерживает REST. Выдается ошибка, если параметр модуля не поддерживается в REST. never – всегда будет использовать ZAPI, если модуль поддерживает ZAPI. Ошибка может быть выдана, если параметр REST не поддерживается в ZAPI. auto – будет пытаться использовать REST API, если модуль поддерживает REST и параметры модулей поддерживаются. В противном случае возвращается к ZAPI. По умолчанию: |
имя_пользователя алиасы: user строка | Это может быть учётная запись кластерного или SVM-уровня, в зависимости от того, требуется ли API кластерного или SVM-уровня. Для получения дополнительной информации, пожалуйста, ознакомьтесь с документацией https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Поддерживаются два метода аутентификации
Для использования сертификата сертификат должен быть установлен в кластере ONTAP, и аутентификация с помощью сертификатов должна быть включена. |
validate_certs логический | Если установлено в Это следует установить только в Варианты:
|
vserver строка | Указывает vserver для политики SnapMirror. Необходимо для ZAPI. Имя виртуального сервера данных с REST. В текущих версиях ONTAP при использовании REST для кластерных политик (9.12.1 и более ранние версии) это должно быть установлено в имя кластера. В текущих версиях ONTAP возникает ошибка «svm.uuid» требуется, когда поле vserver не установлено. В более новых версиях ONTAP, опустите значение или опустите этот параметр для кластерной политики с REST. |
Примечания
Примечание
- В REST типы политик ‘mirror_vault’, ‘vault’ и ‘async_mirror’ сопоставляются с типом политики ‘async’.
- В REST типы политик ‘sync_mirror’ и ‘strict_sync_mirror’ сопоставляются с типом политики ‘sync’.
- В REST используйте тип политики ‘async’, чтобы настроить ‘mirror-vault’ в командной строке.
- В REST используйте тип политики ‘async’ со значением ‘copy_all_source_snapshots’, чтобы настроить ‘async-mirror’ со значением ‘all_source_snapshots’ в командной строке.
- В REST используйте тип политики ‘async’ со значением ‘copy_latest_source_snapshot’, чтобы настроить ‘async-mirror’ без ‘all_source_snapshots’ в командной строке.
- В REST используйте тип политики ‘async’ со значением ‘create_snapshot_on_source’, чтобы настроить ‘vault’ в командной строке.
- В REST используйте тип политики ‘sync’ со значением sync_type ‘sync’, чтобы настроить ‘sync-mirror’ в командной строке.
- В REST используйте тип политики ‘sync’ со значением sync_type ‘strict_sync’, чтобы настроить ‘strict-sync-mirror’ в командной строке.
- В REST используйте тип политики ‘sync’ со значением sync_type ‘automated_failover’, чтобы настроить ‘automated-failover’ в командной строке.
- Модули с префиксом na_ontap созданы для поддержки платформы хранения ONTAP.
- https включён по умолчанию и рекомендуется. Чтобы включить http в кластере, необходимо выполнить следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Примеры
- name: Create SnapMirror policy
na_ontap_snapmirror_policy:
state: present
vserver: "SVM1"
policy_name: "ansible_policy"
policy_type: "mirror_vault"
comment: "created by ansible"
transfer_schedule: "daily" # when using REST
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Modify SnapMirror policy
na_ontap_snapmirror_policy:
state: present
vserver: "SVM1"
policy_name: "ansible_policy"
policy_type: "async_mirror"
transfer_priority: "low"
transfer_schedule: "weekly" # when using REST
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Create SnapMirror policy with basic rules
na_ontap_snapmirror_policy:
state: present
vserver: "SVM1"
policy_name: "ansible_policy"
policy_type: "async_mirror"
snapmirror_label: ['daily', 'weekly', 'monthly']
keep: [7, 5, 12]
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Create SnapMirror policy with rules and schedules (no schedule for daily rule)
na_ontap_snapmirror_policy:
state: present
vserver: "SVM1"
policy_name: "ansible_policy"
policy_type: "mirror_vault"
snapmirror_label: ['daily', 'weekly', 'monthly']
keep: [7, 5, 12]
schedule: ['','weekly','monthly']
prefix: ['','','monthly_mv']
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Modify SnapMirror policy with rules, remove existing schedules and prefixes
na_ontap_snapmirror_policy:
state: present
vserver: "SVM1"
policy_name: "ansible_policy"
policy_type: "mirror_vault"
snapmirror_label: ['daily', 'weekly', 'monthly']
keep: [7, 5, 12]
schedule: ['','','']
prefix: ['','','']
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Modify SnapMirror policy, delete all rules (excludes builtin rules)
na_ontap_snapmirror_policy:
state: present
vserver: "SVM1"
policy_name: "ansible_policy"
policy_type: "mirror_vault"
snapmirror_label: []
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Delete SnapMirror policy
na_ontap_snapmirror_policy:
state: absent
vserver: "SVM1"
policy_type: "async_mirror"
policy_name: "ansible_policy"
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
Ссылки на коллекции
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_snapmirror_policy_module.html