netapp.ontap.na_ontap_volume – NetApp ONTAP управлять томами.
Примечание
Этот плагин является частью коллекции netapp.ontap (версия 20.12.0).
Для его установки используйте: ansible-galaxy collection install netapp.ontap.
Чтобы использовать его в книге задач, укажите: netapp.ontap.na_ontap_volume.
Введено в версии 2.6.0: из netapp.ontap
Обзор
- Создание, удаление или изменение томов на NetApp ONTAP.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- Физическая или виртуальная кластеризованная система Data ONTAP. Модули поддерживают Data ONTAP 9.1 и более поздние версии.
- Поддержка REST требует ONTAP 9.6 или более поздней версии.
- Ansible 2.6
- Настоятельно рекомендуется использовать Ansible 2.9 или более позднюю версию, так как она обеспечивает новую систему доставки коллекций.
- Python2 netapp-lib (2017.10.30) или более поздняя версия. Установите с помощью «pip install netapp-lib»
- Python3 netapp-lib (2018.11.13) или более поздняя версия. Установите с помощью «pip install netapp-lib»
- netapp-lib 2020.3.12 настоятельно рекомендуется, так как он обеспечивает лучшую обработку ошибок при подключении.
- Для включения http в кластере необходимо выполнить следующие команды «set -privilege advanced;» ‘system services web modify -http-enabled true;’
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| aggr_list список / элементы=строка добавлен в 2.8.0 netapp.ontap | массив имён агрегатов, которые будут использоваться для составляющих FlexGroup. | |||
| aggr_list_multiplier целое число добавлен в 2.8.0 netapp.ontap | Количество раз, в которое нужно итерировать по агрегатам, перечисленным в параметре aggr_list при создании FlexGroup. | |||
| aggregate_name строка | Имя агрегата, на котором должен существовать flexvol. Не может быть задано при использовании параметра na_application_template. | |||
| atime_update логическое значение добавлен в 2.8.0 netapp.ontap |
| Это расширенный параметр, по умолчанию True. Если false, предотвращает обновление времени доступа inode при чтении файла. Это значение полезно для томов с очень высоким трафиком чтения, так как предотвращает запись в файл inode тома при столкновении с чтением из других файлов. Это поле следует использовать осторожно. То есть используйте это поле, когда заранее известно, что правильное время доступа к inode не понадобится для файлов на этом томе. | ||
| auto_provision_as строка добавлен в 2.8.0 netapp.ontap |
| Автоматически предоставляет том FlexGroup. | ||
| auto_remap_luns логическое значение добавлен в 20.6.0 netapp.ontap |
| Флаг для управления автоматической привязкой LUN. | ||
| cert_filepath строка добавлен в 20.6.0 netapp.ontap | путь к файлу SSL-сертификата клиента (.pem). не поддерживается с python 2.6. | |||
| check_interval целое число добавлен в 20.6.0 netapp.ontap | Значение по умолчанию: 30 | Количество секунд, которые нужно ждать между проверками тома, чтобы убедиться, что он успешно переместился. | ||
| comment строка добавлен в 2.9.0 netapp.ontap | Устанавливает комментарий, связанный с томом. | |||
| compression логическое значение добавлен в 20.12.0 netapp.ontap |
| Включить или выключить сжатие для тома (агрегаты HDD и Flash Pool). Если этот параметр отсутствует, он автоматически устанавливается в true, если inline_compression равен true. | ||
| cutover_action строка добавлен в 20.5.0 netapp.ontap |
| Указывает действие, которое необходимо выполнить при переключении. Возможные значения — 'abort_on_failure', 'defer_on_failure', 'force' и 'wait'. По умолчанию 'defer_on_failure'. | ||
| efficiency_policy строка добавлен в 2.7.0 netapp.ontap | Позволяет установить политику эффективного использования хранилища при создании тома. | |||
| encrypt логическое значение добавлен в 2.7.0 netapp.ontap |
| Включить или выключить шифрование тома. | ||
| export_policy строка | Имя политики экспорта. Исключительно с nfs_access подвариантом в nas_application_template. псевдонимы: policy | |||
| feature_flags словарь добавлен в 20.5.0 netapp.ontap | Включить или отключить новую функцию. Это можно использовать для включения экспериментальной функции или отключения новой функции, которая нарушает обратную совместимость. Поддерживаемые ключи и значения могут быть изменены без предварительного уведомления. Неизвестные ключи игнорируются. | |||
| force_restore логическое значение добавлен в 20.6.0 netapp.ontap |
| Если это поле установлено в «true», то копия моментального снимка восстанавливается даже если том имеет один или несколько более новых копий моментальных снимков, которые в настоящее время используются как ссылка моментального снимка SnapMirror. Если восстановление выполняется в этой ситуации, это приведёт к сбою будущих передачь SnapMirror. Параметр следует использовать только вместе с параметром snapshot_restore. | ||
| force_unmap_luns логическое значение добавлен в 20.6.0 netapp.ontap |
| Флаг для управления автоматическим отключением LUN. | ||
| from_name строка добавлен в 2.7.0 netapp.ontap | Имя существующего тома, который будет переименован в name. | |||
| from_vserver строка добавлен в 20.6.0 netapp.ontap | Исходный vserver тома, который переносится. | |||
| group_id целое число добавлен в 20.1.0 netapp.ontap | Идентификатор UNIX-группы для тома. Значение по умолчанию 0 ('root'). | |||
| hostname строка / обязательно | Имя хоста или IP-адрес экземпляра ONTAP. | |||
| http_port целое число | Переопределить порт по умолчанию (80 или 443) на этот порт | |||
| https логическое значение |
| Включить и выключить https. Игнорируется при использовании REST, так как поддерживается только https. Игнорируется при использовании аутентификации SSL-сертификата, так как она требует SSL. | ||
| inline_compression логическое значение добавлен в 20.12.0 netapp.ontap |
| Включить или выключить сжатие в строке для тома (агрегаты HDD и Flash Pool, платформы AFF). | ||
| is_infinite логическое значение |
| Установить True, если том — том Infinite. Удаление бесконечного тома асинхронно. | ||
| is_online логическое значение |
| Указывает, является ли указанный том онлайн или нет. | ||
| junction_path строка | Путь соединения тома. Для отключения используйте путь соединения ''. | |||
| key_filepath строка добавлен в 20.6.0 netapp.ontap | путь к файлу ключа SSL клиента. | |||
| language строка добавлен в 2.8.0 netapp.ontap | Язык, который нужно использовать для тома По умолчанию используется язык SVM Возможные значения Language c POSIX ar арабский cs чешский da датский de немецкий en английский en_us английский (США) es испанский fi финский fr французский he иврит hr хорватский hu венгерский it итальянский ja японский euc-j ja_v1 японский euc-j ja_jp.pck японский PCK (sjis) ja_jp.932 японский cp932 ja_jp.pck_v2 японский PCK (sjis) ko корейский no норвежский nl голландский pl польский pt португальский ro румынский ru русский sk словацкий sl словенский sv шведский tr турецкий zh упрощённый китайский zh.gbk упрощённый китайский (GBK) zh_tw традиционный китайский euc-tw zh_tw.big5 традиционный китайский Big 5 Для использования UTF-8 в качестве набора символов NFS, добавьте '.UTF-8' к коду языка | |||
| name строка / обязательно | Имя тома для управления. | |||
| nas_application_template словарь добавлен в 20.12.0 netapp.ontap | Дополнительные параметры при использовании REST-API приложений/приложений для создания тома. Модуль по умолчанию использует ZAPI и переключается на REST, если присутствует любой подвариант. По умолчанию создаёт FlexVol. Создаёт FlexGroup, если auto_provision_as установлен и параметр FlexCache отсутствует.Создаёт FlexCache, если параметр flexcache присутствует. | |||
| cifs_access список / элементы=словарь | Список CIFS-контролей доступа. Вы должны предоставить user_or_group или access, чтобы включить доступ CIFS. | |||
| access строка |
| Предоставленный CIFS-доступ пользователю или группе. По умолчанию полный контроль. | ||
| user_or_group строка | Имя CIFS-пользователя или группы, которому будет предоставлен доступ. По умолчанию Все. | |||
| flexcache словарь | Включает создание flexcache. Если отсутствует, создаётся FlexVol или FlexGroup. | |||
| origin_component_name строка / обязательно | Удалённый компонент для flexcache. | |||
| origin_svm_name строка / обязательно | удаленный SVM для flexcache. | |||
| nfs_access список / элементы=словарь | Список правил доступа NFS. Для включения доступа NFS необходимо указать host или access. Взаимоисключительно с параметром export_policy в nas_application_template. | |||
| access строка |
| Предоставленный доступ NFS. По умолчанию rw. | ||
| host строка | Имя NFS-сущности, которой предоставлен доступ. По умолчанию 0.0.0.0/0. | |||
| storage_service строка |
| Уровень обслуживания производительности (PSL) для этого тома | ||
| tiering словарь | Политика тиеринга облака (см. tiering_policy для более подробного описания). | |||
| control строка |
| Правила размещения тиеринга хранилища для контейнера. | ||
| object_stores список / элементы=строка | Список имен хранилищ объектов для тиеринга. | |||
| policy строка |
| Политика тиеринга облака (см. tiering_policy).Должно совпадать с tiering_policy, если оба параметра присутствуют. | ||
| use_nas_application булево |
| Использовать ли REST/API приложения/приложений для создания тома. По умолчанию true, если присутствует любой другой подпараметр. | ||
| nvfail_enabled булево добавлен в 2.9.0 netapp.ontap |
| Если true, контроллер выполняет дополнительную работу при загрузке и переключении, если обнаруживает потенциальную потерю данных в компонентах тома из-за сбоя NVRAM. Компоненты тома будут переведены в специальное состояние 'in-nvfailed-state', в котором заблокирован доступ к протоколу. Это приведет к сбою приложений-клиентов и предотвратит доступ к устаревшим данным. Для выхода из этого состояния администратору необходимо вручную очистить 'in-nvfailed-state' в компонентах тома. | ||
| ontapi целое число | Используемая версия API ontap | |||
| password строка | Пароль для указанного пользователя. псевдонимы: pass | |||
| percent_snapshot_space целое число | Размер места, зарезервированного для копий моментальных снимков тома. | |||
| preserve_lun_ids булево добавлен в 20.6.0 netapp.ontap |
| Если это поле установлено в "true", LUN в восстанавливаемом томе останутся сопоставленными и их идентификаторы сохранятся, что предотвратит прерывание подключения к хосту во время операции восстановления. Ввод-вывод к LUN будет ограничен во время операции восстановления путем перевода LUN в недоступное состояние. После завершения операции восстановления хосты смогут возобновить доступ к LUN. Параметр следует использовать только вместе с snapshot_restore. | ||
| qos_adaptive_policy_group строка добавлен в 2.9.0 netapp.ontap | Устанавливает группу адаптивных политик QoS для тома. | |||
| qos_policy_group строка добавлен в 2.9.0 netapp.ontap | Устанавливает группу политик QoS для тома. | |||
| size целое число | Размер тома в (size_unit). Требуется, когда state=present. | |||
| size_change_threshold целое число добавлен в 20.12.0 netapp.ontap | По умолчанию: 10 | Процент изменения размера, вызывающий изменение размера. Если этот параметр больше 0, разница в размере между ожидаемым и настроенным размером игнорируется, если она меньше порога. Например, приложение nas выделяет больший размер, чтобы учесть накладные расходы. Установите это значение в 0 для точного совпадения. | ||
| size_unit строка |
| Единица измерения, используемая для интерпретации параметра размера. | ||
| sizing_method строка добавлен в 20.12.0 netapp.ontap |
| Представляет метод изменения размера FlexGroup. use_existing_resources - Увеличивает или уменьшает размер FlexGroup, увеличивая или уменьшая размер текущих ресурсов FlexGroup. add_new_resources - Увеличивает размер FlexGroup путем добавления новых ресурсов. Ограничено двумя новыми ресурсами на доступный агрегат. Поддерживается только при включенном REST (ONTAP 9.6 или более поздняя версия) и только для FlexGroup. ONTAP по умолчанию использует use_existing_resources. | ||
| snapdir_access булево добавлен в 2.8.0 netapp.ontap |
| Это расширенный параметр, по умолчанию False. Включить видимую директорию '.snapshot', которая обычно присутствует в системных внутренних точках монтирования. Это значение также включает доступ ко всем другим директориям '.snapshot' в томе. | ||
| snapshot_auto_delete словарь добавлен в 20.4.0 netapp.ontap | Словарь для параметров и значений автоматического удаления. Поддерживаемые параметры включают 'state', 'commitment', 'trigger', 'target_free_space', 'delete_order', 'defer_delete', 'prefix', 'destroy_list'. Параметр 'state' определяет, включено ли автоматическое удаление снимков для тома. Возможные значения: 'on' и 'off'. Параметр 'commitment' определяет, какие снимки разрешено удалять автоматическому удалению снимков, чтобы освободить место. Возможные значения: 'try', 'disrupt' и 'destroy'. Параметр 'trigger' определяет условие, которое запускает автоматическое удаление снимков. Возможные значения: 'volume', 'snap_reserve' и устаревший 'space_reserve'. Параметр 'target_free_space' определяет, когда автоматическое удаление снимков должно прекратить удаление снимков. В зависимости от триггера, снимки удаляются до тех пор, пока не будет достигнуто процентное значение свободного места. Принимает тип int. Параметр 'delete_order' определяет, какие снимки удаляются первыми — самые старые или самые новые. Возможные значения: 'newest_first' и 'oldest_first'. Параметр 'defer_delete' определяет, какие снимки удалить в конце. Возможные значения: 'scheduled', 'user_created', 'prefix' и 'none'. Параметр 'prefix' может быть установлен для предоставления префиксной строки для параметра 'prefix' опции 'defer_delete'. Длина префиксной строки может быть 15 символов. Параметр 'destroy_list' — список сервисов, разделенных запятыми, которые могут быть удалены, если удаляется резервная копия снимка этого сервиса. Для режима 7-mode возможные значения этого параметра — комбинация 'lun_clone', 'vol_clone', 'cifs_share', 'file_clone' или 'none'. Для режима кластера возможные значения этого параметра — комбинация 'lun_clone,file_clone' (для клонирования LUN и/или файлов), 'lun_clone,sfsr' (для клонирования LUN и/или sfsr), 'vol_clone', 'cifs_share' или 'none'. | |||
| snapshot_policy строка добавлен в 2.8.0 netapp.ontap | Имя политики моментальных снимков. Имя политики по умолчанию — 'default'. При наличии этого параметра тип защиты будет задан при использовании nas_application_template. | |||
| snapshot_restore строка добавлен в 20.6.0 netapp.ontap | Имя снимка для восстановления. Не поддерживается в Infinite Volume. | |||
| space_guarantee строка |
| Стиль гарантии места для тома. | ||
| space_slo строка добавлен в 2.9.0 netapp.ontap |
| Указывает тип SLO пространства для тома. Тип SLO пространства — целевой уровень обслуживания для управления пространством для тома. Значение SLO пространства используется для принудительного применения существующих параметров тома, чтобы отвести достаточно места в агрегате для соответствия SLO пространства. Этот параметр не поддерживается в Infinite Volumes. | ||
| state строка |
| Должен ли существовать указанный том или нет. | ||
| tiering_policy string добавлено в 2.9.0 netapp.ontap |
| Политика тиеринга, которая должна быть связана с томом. Эта политика определяет, будут ли блоки тома перемещены в уровень емкости. Политика snapshot-only позволяет перемещать только копии снимков тома, не связанные с активной файловой системой. Политика auto позволяет перемещать как данные снимков, так и активные данные пользователей файловой системы на уровень емкости. Политика backup на томах DP позволяет всем перенесенным блокам данных пользователей начинать с уровня емкости. При установке в значение none блоки тома не будут перемещены на уровень емкости. Если значение не указано, то по умолчанию для тома устанавливается политика snapshot-only. Требуется ONTAP 9.4 или более поздняя версия. | ||
| time_out integer добавлено в 2.8.0 netapp.ontap | Значение по умолчанию: 180 | Время ожидания создания, изменения или удаления flexGroup в секундах. Возвращение ошибки, если задача не завершена в определенное время. Если значение 0, запрос является асинхронным. Значение по умолчанию установлено в 3 минуты. | ||
| type string | Тип тома, либо чтение-запись (RW), либо защита данных (DP). | |||
| unix_permissions string добавлено в 2.8.0 netapp.ontap | Разрешения Unix в восьмеричном или символическом формате. Например, 0 эквивалентно ------------, 777 эквивалентно ---rwxrwxrwx; оба формата принимаются. Допустимое восьмеричное значение находится в диапазоне от 0 до 777 включительно. | |||
| use_rest string | Значение по умолчанию: "auto" | REST API, если поддерживается целевой системой для всех ресурсов и атрибутов, необходимых модулю. В противном случае будет использоваться ZAPI. всегда -- всегда использовать REST API никогда -- всегда использовать ZAPI auto -- попытаться использовать REST API | ||
| user_id integer добавлено в 20.1.0 netapp.ontap | Идентификатор пользователя UNIX для тома. Значение по умолчанию 0 ('root'). | |||
| username string | Это может быть учетная запись на уровне кластера или на уровне SVM, в зависимости от того, требуется ли API на уровне кластера или на уровне SVM. Для получения дополнительной информации, пожалуйста, прочитайте документацию https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Поддерживаются два метода аутентификации 1. базовая аутентификация, используя имя пользователя и пароль, 2. аутентификация с помощью сертификата SSL, используя файл ssl-сертификата клиента и, необязательно, файл закрытого ключа. Для использования сертификата он должен быть установлен в кластере ONTAP, и должна быть включена аутентификация по сертификатам. псевдонимы: user | |||
| validate_certs boolean |
| Если установлено в no, сертификаты SSL не будут проверены.Это следует устанавливать только в False на сайтах с собственными сертификатами, управляемых самостоятельно. | ||
| volume_security_style string |
| Стиль защиты, связанный с этим томом. | ||
| vserver string / обязательно | Имя vserver для использования. | |||
| vserver_dr_protection string добавлено в 2.9.0 netapp.ontap |
| Определяет тип защиты для тома в настройке DR Vserver. | ||
| wait_for_completion boolean добавлено в 2.8.0 netapp.ontap |
| Установите этот параметр в 'true' для синхронного выполнения во время создания (подождать, пока статус тома не станет online) Установите этот параметр в 'false' для асинхронного выполнения Для асинхронного выполнения выполнение завершается сразу после отправки запроса, без проверки статуса тома | ||
Примечания
Примечание
- Модули с префиксом na_ontap разработаны для поддержки платформы хранения ONTAP.
Примеры
- name: Create FlexVol
na_ontap_volume:
state: present
name: ansibleVolume12
is_infinite: False
aggregate_name: ansible_aggr
size: 100
size_unit: mb
user_id: 1001
group_id: 2002
space_guarantee: none
tiering_policy: auto
export_policy: default
percent_snapshot_space: 60
qos_policy_group: max_performance_gold
vserver: ansibleVServer
wait_for_completion: True
space_slo: none
nvfail_enabled: False
comment: ansible created volume
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Volume Delete
na_ontap_volume:
state: absent
name: ansibleVolume12
aggregate_name: ansible_aggr
vserver: ansibleVServer
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Make FlexVol offline
na_ontap_volume:
state: present
name: ansibleVolume
is_infinite: False
is_online: False
vserver: ansibleVServer
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Create flexGroup volume manually
na_ontap_volume:
state: present
name: ansibleVolume
is_infinite: False
aggr_list: "{{ aggr_list }}"
aggr_list_multiplier: 2
size: 200
size_unit: mb
space_guarantee: none
export_policy: default
vserver: "{{ vserver }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: False
unix_permissions: 777
snapshot_policy: default
time_out: 0
- name: Create flexGroup volume auto provsion as flex group
na_ontap_volume:
state: present
name: ansibleVolume
is_infinite: False
auto_provision_as: flexgroup
size: 200
size_unit: mb
space_guarantee: none
export_policy: default
vserver: "{{ vserver }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: False
unix_permissions: 777
snapshot_policy: default
time_out: 0
- name: Create FlexVol with QoS adaptive
na_ontap_volume:
state: present
name: ansibleVolume15
is_infinite: False
aggregate_name: ansible_aggr
size: 100
size_unit: gb
space_guarantee: none
export_policy: default
percent_snapshot_space: 10
qos_adaptive_policy_group: extreme
vserver: ansibleVServer
wait_for_completion: True
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Modify volume dr protection (vserver of the volume must be in a snapmirror relationship)
na_ontap_volume:
state: present
name: ansibleVolume
vserver_dr_protection: protected
vserver: "{{ vserver }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: False
- name: Modify volume with snapshot auto delete options
na_ontap_volume:
state: present
name: vol_auto_delete
snapshot_auto_delete:
state: "on"
commitment: try
defer_delete: scheduled
target_free_space: 30
destroy_list: lun_clone,vol_clone
delete_order: newest_first
aggregate_name: "{{ aggr }}"
vserver: "{{ vserver }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: False
- name: Move volume with force cutover action
na_ontap_volume:
name: ansible_vol
aggregate_name: aggr_ansible
cutover_action: force
vserver: "{{ vserver }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: false
- name: Rehost volume to another vserver auto remap luns
na_ontap_volume:
name: ansible_vol
from_vserver: ansible
auto_remap_luns: true
vserver: "{{ vserver }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: false
- name: Rehost volume to another vserver force unmap luns
na_ontap_volume:
name: ansible_vol
from_vserver: ansible
force_unmap_luns: true
vserver: "{{ vserver }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: false
- name: Snapshot restore volume
na_ontap_volume:
name: ansible_vol
vserver: ansible
snapshot_restore: 2020-05-24-weekly
force_restore: true
preserve_lun_ids: true
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
- name: Volume create using application/applications nas template
na_ontap_volume:
state: present
name: ansibleVolume12
vserver: ansibleSVM
size: 100000000
size_unit: b
space_guarantee: none
language: es
percent_snapshot_space: 60
unix_permissions: ---rwxrwxrwx
snapshot_policy: default
efficiency_policy: default
comment: testing
nas_application_template:
nfs_access: # the mere presence of a suboption is enough to enable this new feature
- access: ro
- access: rw
host: 10.0.0.0/8
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
Авторы
- Команда NetApp Ansible (@carchi8py) <ng-ansibleteam@netapp.com>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/netapp/ontap/na_ontap_volume_module.html