Модуль netapp.ontap.na_ontap_volume – управление томами NetApp ONTAP.
Примечание
Этот модуль входит в коллекцию netapp.ontap (версия 23.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install netapp.ontap. Для использования этого модуля необходимы дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: netapp.ontap.na_ontap_volume.
Добавлено в netapp.ontap 2.6.0
Краткое описание
- Создание, удаление или изменение томов в NetApp 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 или более поздняя версия.
Параметры
Параметр | Комментарии |
|---|---|
activity_tracking string добавлено в netapp.ontap 22.12.0 | Задает состояние отслеживания активности тома. Поддерживается только с REST и требует ONTAP версии 9.10 или более поздней. Варианты:
|
aggr_list list / elements=string добавлено в netapp.ontap 2.8.0 | Массив имен агрегатов, используемых для компонентов FlexGroup. |
aggr_list_multiplier integer добавлено в netapp.ontap 2.8.0 | Количество проходов по агрегатам, указанным параметром aggr_list, при создании FlexGroup. |
aggregate_name string | Имя агрегата, в котором должен находиться flexvol. Нельзя задать при использовании параметра |
analytics string добавлено в netapp.ontap 22.0.0 | Задает состояние аналитики файловой системы тома. Поддерживается только с REST и требует ONTAP версии 9.8 или более поздней. Нельзя включить аналитику для тома, содержащего LUN. Варианты:
|
anti_ransomware dictionary добавлено в netapp.ontap 23.5.0 | Информация о защите тома от программ-вымогателей. Поддерживается только с REST и требует ONTAP версии 9.10 или более поздней. |
|
state string |
Определяет состояние защиты тома от программ-вымогателей.
Варианты:
|
atime_update boolean добавлено в netapp.ontap 2.8.0 | Это расширенный параметр, значение по умолчанию — True. Если значение равно false, обновление времени доступа к inode при чтении файла не выполняется. Это значение полезно для томов с чрезвычайно высокой нагрузкой на чтение, поскольку предотвращает конкуренцию операций записи в файл inode тома с чтением других файлов. Используйте это поле с осторожностью. Иными словами, используйте это поле, только если вы заранее уверены, что для файлов на этом томе не потребуется правильное время доступа к inode. Этот параметр поддерживается в REST для ONTAP 9.8 или более поздней версии и коллекции ONTAP версии 22.8.0 или более поздней. Варианты:
|
auto_provision_as string добавлено в netapp.ontap 2.8.0 | Автоматически подготавливает том FlexGroup. Варианты:
|
auto_remap_luns boolean добавлено в netapp.ontap 20.6.0 | Флаг управления автоматическим сопоставлением LUN. Варианты:
|
cert_filepath string добавлено в netapp.ontap 20.6.0 | Путь к файлу сертификата клиента SSL (.pem). Не поддерживается в Python 2.6. |
check_interval integer добавлено в netapp.ontap 20.6.0 | Интервал ожидания в секундах между проверками успешного перемещения тома. По умолчанию: |
comment string добавлено в netapp.ontap 2.9.0 | Задает комментарий, связанный с томом. |
compression boolean добавлено в netapp.ontap 20.12.0 | Включить ли сжатие для тома (агрегаты HDD и Flash Pool). Если этот параметр не задан, для него автоматически устанавливается значение true, когда inline_compression имеет значение true. Варианты:
|
cutover_action string добавлено в netapp.ontap 20.5.0 | Указывает действие, которое необходимо выполнить при переключении. Возможные значения: ‘abort_on_failure’, ‘defer_on_failure’, ‘force’ и ‘wait’. Значение по умолчанию — ‘defer_on_failure’. Варианты:
|
efficiency_policy string добавлено в netapp.ontap 2.7.0 | Позволяет задать политику эффективности хранения при создании тома. |
encrypt boolean добавлено в netapp.ontap 2.7.0 | Включать ли шифрование тома. Если параметр не задан, при создании тома ONTAP использует значение false. Для изменения значения encrypt после создания требуется ONTAP 9.3 или более поздняя версия. Варианты:
|
export_policy псевдонимы: policy string | Имя политики экспорта. Не может использоваться одновременно с подопцией nfs_access в nas_application_template. |
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, где каждый компонент является целым числом. Если для Игнорируется при использовании ZAPI. |
force_restore boolean добавлено в netapp.ontap 20.6.0 | Если для этого поля задано значение “true”, Snapshot-копия восстанавливается, даже если в томе есть одна или несколько более новых Snapshot-копий, используемых в данный момент SnapMirror в качестве эталонной Snapshot-копии. Восстановление в этой ситуации приведет к сбою последующих передач SnapMirror. Параметр следует использовать только вместе с snapshot_restore. Варианты:
|
force_unmap_luns boolean добавлено в netapp.ontap 20.6.0 | Флаг управления автоматическим отменой сопоставления LUN. Варианты:
|
from_name string добавлено в netapp.ontap 2.7.0 | Имя существующего тома, который необходимо переименовать в name. |
from_vserver string добавлено в netapp.ontap 20.6.0 | Исходный vserver тома, который перемещается на другой vserver. |
granular_data boolean добавлено в netapp.ontap 22.13.0 | Состояние детализированных данных в томе. Эта функция поддерживается только томами FlexGroup. После включения эту настройку можно отключить только путем восстановления Snapshot-копии. Поддерживается только с REST и требует ONTAP версии 9.12 или более поздней. Варианты:
|
group_id integer добавлено в netapp.ontap 20.1.0 | Идентификатор группы UNIX для тома. Значение по умолчанию — 0 (‘root’). |
hostname string / обязательный | Имя хоста или IP-адрес экземпляра ONTAP. |
http_port integer | Переопределяет порт по умолчанию (80 или 443), используя указанный порт |
https boolean | Включает и отключает HTTPS. Игнорируется при использовании REST, поскольку поддерживается только HTTPS. Игнорируется при использовании аутентификации с сертификатом SSL, поскольку для нее требуется SSL. Варианты:
|
inline_compression boolean добавлено в netapp.ontap 20.12.0 | Включить ли встроенное сжатие для тома (агрегаты HDD и Flash Pool, платформы AFF). Варианты:
|
is_infinite boolean | Установите значение True, если том является Infinite Volume. Удаление Infinite Volume выполняется асинхронно. Варианты:
|
is_online boolean | Находится ли указанный том в сети. Варианты:
|
junction_path string | Путь соединения тома. Чтобы отключить монтирование, используйте путь соединения |
key_filepath string добавлено в netapp.ontap 20.6.0 | Путь к файлу ключа клиента SSL. |
lambda_config dictionary добавлено в netapp.ontap 23.2.0 | Параметры конфигурации функциональности прокси AWS Lambda. Эти параметр и подопции поддерживаются только с REST. |
|
aws_profile string |
Имя профиля AWS, используемого для аутентификации. |
|
aws_region string / обязательный |
Название региона AWS. |
|
function_name string / обязательный |
Имя вызываемой функции AWS Lambda. |
language string добавлено в netapp.ontap 2.8.0 | Язык тома По умолчанию используется язык SVM Возможные значения Язык 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’ к коду языка |
large_size_enabled boolean добавлено в netapp.ontap 22.14.0 | Указывает, включена ли для этого тома поддержка больших томов FlexVol и больших файлов. Варианты:
|
logical_space_enforcement boolean добавлено в netapp.ontap 21.16.0 | Этот необязательный параметр указывает, следует ли выполнять учет логического пространства на томе. При логическом ограничении пространства ONTAP применяет настройки тома таким образом, что все физическое пространство, сэкономленное благодаря функциям эффективности хранения, учитывается как использованное. Поддерживается только с REST. Варианты:
|
logical_space_reporting boolean добавлено в netapp.ontap 21.16.0 | Этот необязательный параметр указывает, следует ли отображать сведения о пространстве тома в логическом виде. При логическом отображении пространства ONTAP сообщает об объеме пространства тома, включая физическое пространство, сэкономленное благодаря функциям эффективности хранения, как об использованном. Поддерживается только с REST. Варианты:
|
max_files integer добавлено в netapp.ontap 21.18.0 | Максимальное количество файлов (inode) пользовательских данных, доступное на томе. Примечание: ONTAP выделяет немного отличающееся значение, например 3990 вместо запрошенных 4000. Для сохранения идемпотентности небольшие отклонения размера игнорируются. |
max_wait_time integer добавлено в netapp.ontap 22.0.0 | Операции перемещения и шифрования тома могут занимать больше времени. Если задано По истечении времени модуль завершит работу, но операция может продолжать выполняться. По умолчанию задано 10 минут. По умолчанию: |
name string / обязательный | Имя тома, которым необходимо управлять. |
nas_application_template dictionary добавлено в netapp.ontap 20.12.0 | Дополнительные параметры при использовании REST API application/applications для создания тома. По умолчанию модуль использует ZAPI и переключается на REST, если задана любая подопция. По умолчанию создается FlexVol. Создается FlexGroup, если задано Создается FlexCache, если задан параметр |
|
cifs_access list / elements=dictionary |
Список элементов управления доступом CIFS. Для включения доступа CIFS необходимо указать user_or_group или access. |
|
access string |
Уровень доступа CIFS, предоставляемый пользователю или группе. По умолчанию — full_control. Варианты:
|
|
user_or_group string |
Имя пользователя или группы CIFS, которым будет предоставлен доступ. По умолчанию — Everyone. |
|
string добавлено в netapp.ontap 22.13.0 |
Имя общего ресурса CIFS. Требуется ONTAP 9.11 или более поздняя версия. |
|
exclude_aggregates list / elements=string добавлено в netapp.ontap 21.7.0 |
Список имен агрегатов, которые нужно исключить при создании тома. Требуется ONTAP 9.9.1 GA или более поздняя версия. |
|
flexcache dictionary |
Создавать ли FlexCache. Если параметр не указан, создается FlexVol или FlexGroup. |
|
dr_cache boolean добавлено в netapp.ontap 21.3.0 |
Использовать ли для flexgroup тот же msid, что и у источника. Требуется ONTAP 9.9 и REST. Параметр применяется только при создании и игнорируется, если FlexCache уже существует. Варианты:
|
|
origin_component_name string / обязательный |
Удаленный компонент для FlexCache. |
|
origin_svm_name string / обязательный |
Удаленная SVM для FlexCache. |
|
nfs_access list / elements=dictionary |
Список элементов управления доступом NFS. Для включения доступа NFS необходимо указать host или access. Несовместим с параметром export_policy. |
|
access string |
Предоставляемый доступ NFS. По умолчанию — rw. Варианты:
|
|
host string |
Имя объекта NFS, которому предоставляется доступ. По умолчанию — 0.0.0.0/0. |
|
snaplock dictionary добавлено в netapp.ontap 22.13.0 |
Требуется ONTAP 9.12 или более поздняя версия. |
|
append_mode_enabled boolean |
Указывает, включен или отключен режим добавления данных в том. Варианты:
|
|
autocommit_period string |
Задает период автоматической фиксации для тома SnapLock. Длительность указывается в формате длительности ISO-8601 (например, PY, PM, PD, PTH, PTM). Примеры: P30M, P10Y, PT1H, none. Длительность, объединяющая разные периоды, не поддерживается. |
|
retention dictionary |
Периоды хранения по умолчанию, максимальный и минимальный для файлов, переведенных в состояние WORM на томе. Длительности указываются в формате длительности ISO-8601; см. autocommit_period. |
|
default string |
Период хранения по умолчанию, применяемый к файлам при переводе в состояние WORM, если для них не задан период хранения. |
|
maximum string |
Максимально допустимый период хранения файлов, переведенных в состояние WORM на томе. |
|
minimum string |
Минимально допустимый период хранения файлов, переведенных в состояние WORM на томе. |
|
snaplock_type string |
Тип SnapLock интеллектуального контейнера. Варианты:
|
|
snapshot_locking_enabled boolean добавлено в netapp.ontap 22.13.0 |
Указывает, включена ли блокировка Snapshot-копий на томе. Требуется ONTAP 9.13.1 или более поздняя версия. Варианты:
|
|
storage_service string |
Уровень производительности службы (PSL) для этого тома Варианты:
|
|
tiering dictionary |
Политика размещения данных в облачном уровне (более подробное описание см. в |
|
control string |
Правила размещения контейнера на уровнях хранения. Варианты:
|
|
object_stores list / elements=string |
Список имен объектных хранилищ для размещения данных на уровнях хранения. |
|
policy string |
Политика размещения данных в облачном уровне (см. Если оба параметра указаны, значение должно совпадать с Варианты:
|
|
use_nas_application boolean |
Использовать ли REST/API приложения или приложений для создания тома. Если присутствует любой другой вложенный параметр, по умолчанию будет установлено значение true. Варианты:
|
nvfail_enabled boolean добавлено в netapp.ontap 2.9.0 | Если значение равно true, при загрузке и переключении контроллера он выполняет дополнительные действия, если обнаруживает возможную потерю данных в компонентах тома из-за сбоя NVRAM. Компоненты тома будут переведены в специальное состояние «in-nvfailed-state», в котором доступ по протоколам блокируется. Это приведет к аварийному завершению работы клиентских приложений и тем самым предотвратит доступ к устаревшим данным. Чтобы выйти из этой ситуации, администратору необходимо вручную сбросить состояние «in-nvfailed-state» для компонентов тома. Варианты:
|
ontapi integer | Версия API ONTAP, которую следует использовать |
password псевдонимы: pass string | Пароль указанного пользователя. |
percent_snapshot_space integer | Объем пространства, зарезервированного для Snapshot-копий тома. |
preserve_lun_ids boolean добавлено в netapp.ontap 20.6.0 | Если для этого поля задано значение «true», LUN в восстанавливаемом томе останутся сопоставленными, а их идентификаторы будут сохранены, чтобы подключение хостов не прерывалось во время операции восстановления. На время операции восстановления ввод-вывод для LUN будет заблокирован путем перевода LUN в недоступное состояние. После завершения операции восстановления хосты смогут возобновить ввод-вывод для LUN. Этот параметр следует использовать только вместе с snapshot_restore. Варианты:
|
qos_adaptive_policy_group string добавлено в netapp.ontap 2.9.0 | Указывает адаптивную группу политик QoS, назначаемую тому. |
qos_policy_group string добавлено в netapp.ontap 2.9.0 | Указывает группу политик QoS, назначаемую тому. |
size integer | Размер тома в единицах (size_unit). Обязателен, если |
size_change_threshold integer добавлено в netapp.ontap 20.12.0 | Процент изменения размера, при достижении которого запускается изменение размера. Если значение этого параметра больше 0, разница между ожидаемым и настроенным размерами игнорируется, когда она ниже порогового значения. Например, приложение NAS выделяет размер больше указанного, чтобы учесть накладные расходы. При использовании Если разница превышает пороговое значение, размер тома будет изменен на запрошенный. Для обычных томов (без nas_application_template) разница размеров в пределах порогового значения игнорируется, а параметры не обновляются. Установите значение 0 для точного совпадения. По умолчанию: |
size_unit string | Единица измерения, используемая для интерпретации параметра size. Варианты:
|
sizing_method string добавлено в netapp.ontap 20.12.0 | Метод изменения размера FlexGroup. use_existing_resources — увеличивает или уменьшает размер FlexGroup, изменяя размеры его текущих ресурсов. add_new_resources — увеличивает размер FlexGroup путем добавления новых ресурсов. Ограничение — не более двух новых ресурсов на каждый доступный агрегат. Поддерживается только при включенном REST (ONTAP 9.6 или более поздняя версия) и только для FlexGroup. По умолчанию ONTAP использует use_existing_resources. Варианты:
|
snapdir_access boolean добавлено в netapp.ontap 2.8.0 | Это расширенный параметр; значение по умолчанию — False. Включает отображение каталога «.snapshot», который обычно находится в системных точках монтирования. Это значение также включает доступ ко всем остальным каталогам «.snapshot» в томе. Этот параметр поддерживается в REST для ONTAP 9.13.1 или более поздней версии при использовании версии коллекции ONTAP 22.8.0 или более поздней. Варианты:
|
snaplock dictionary добавлено в netapp.ontap 21.18.0 | Начиная с ONTAP 9.10.1, значение snaplock.type задается на уровне тома. При использовании REST остальные вложенные параметры можно задавать или изменять в более ранних версиях ONTAP. Этот параметр и его вложенные параметры поддерживаются только при использовании REST. |
|
append_mode_enabled boolean |
Если этот режим включен, все файлы, созданные с разрешением на запись в томе, по умолчанию являются файлами WORM, допускающими добавление данных. Пользователь может добавлять данные в такой файл WORM, но не может изменять его существующее содержимое или удалять файл до истечения срока хранения. Варианты:
|
|
autocommit_period string |
Период автоматической фиксации для тома SnapLock. Все файлы, которые не изменялись дольше периода автоматической фиксации тома, переводятся в состояние WORM. Длительность указывается в формате длительности ISO-8601 (например, PY, PM, PD, PTH, PTM). Примеры: P30M, P10Y, PT1H, «none». Длительность, объединяющая разные периоды, не поддерживается. |
|
privileged_delete string |
Атрибут privileged-delete тома SnapLock. На томе SnapLock Enterprise (SLE) назначенный привилегированный пользователь может выборочно удалять файлы независимо от срока их хранения. На томе SnapLock Compliance (SLC) этот атрибут всегда имеет значение permanently_disabled. Варианты:
|
|
retention dictionary |
Периоды хранения по умолчанию, максимальный и минимальный для файлов, переведенных в состояние WORM на томе. Длительности указываются в формате длительности ISO-8601; см. autocommit_period. |
|
default string |
Период хранения по умолчанию, применяемый к файлам при переводе в состояние WORM, если для них не задан период хранения. |
|
maximum string |
Максимально допустимый период хранения файлов, переведенных в состояние WORM на томе. |
|
minimum string |
Минимально допустимый период хранения файлов, переведенных в состояние WORM на томе. |
|
type string |
Тип SnapLock тома. compliance — том SnapLock Compliance (SLC) обеспечивает максимальный уровень защиты WORM; администратор не может уничтожить том SLC, если на нем хранятся файлы WORM с неистекшим сроком хранения. enterprise — администратор может удалить том SnapLock Enterprise (SLE). non_snaplock — указывает, что том не использует SnapLock. Варианты:
|
snapshot_auto_delete dictionary добавлено в netapp.ontap 20.4.0 | Словарь параметров и значений автоматического удаления. Все упомянутые выше параметры, кроме ‘destroy_list’, поддерживаются в REST для ONTAP 9.13.1 или более поздней версии с версией коллекции ONTAP 22.8.0 или более поздней. |
|
commitment string |
Определяет, какие снимки разрешено удалять функции автоматического удаления снимков для освобождения места. Варианты:
|
|
defer_delete string |
Определяет, какой тип снимка удаляется в последнюю очередь. Варианты:
|
|
delete_order string |
Определяет, какой снимок удаляется первым — самый старый или самый новый. Варианты:
|
|
destroy_list string |
Разделённый запятыми список служб, которые можно уничтожить при удалении снимка, на котором основана эта служба. Для 7-mode возможные значения этого параметра представляют собой комбинацию значений ‘lun_clone’, ‘vol_clone’, ‘cifs_share’, ‘file_clone’ или ‘none’. Для cluster-mode возможные значения этого параметра представляют собой комбинацию значений ‘lun_clone,file_clone’ (для клона LUN и/или клона файла), ‘lun_clone,sfsr’ (для клона LUN и/или sfsr), ‘vol_clone’, ‘cifs_share’ или ‘none’. |
|
prefix string |
Можно задать строку префикса для значения ‘prefix’ параметра ‘defer_delete’. Длина строки префикса может составлять 15 символов. |
|
state string |
Определяет, включено ли в данный момент автоматическое удаление снимков для тома. Варианты:
|
|
target_free_space integer |
Определяет, когда автоматическое удаление снимков должно прекратить их удаление. В зависимости от триггера снимки удаляются до достижения целевого процента свободного пространства. |
|
trigger string |
Определяет условие, запускающее автоматическое удаление снимков. Примечание — параметр Варианты:
|
snapshot_locking boolean добавлено в netapp.ontap 22.12.0 | Указывает, включена ли блокировка копий снимков на томе. Поддерживается только в REST и требует ONTAP 9.12 или более поздней версии. Варианты:
|
snapshot_policy string добавлено в netapp.ontap 2.8.0 | Имя политики снимков. Имя политики по умолчанию — ‘default’. Если указано, при использовании |
snapshot_restore string добавлено в netapp.ontap 20.6.0 | Имя снимка, из которого выполняется восстановление. Не поддерживается для Infinite Volume. |
space_guarantee string | Тип гарантии пространства для тома. Настройка file больше не поддерживается. Варианты:
|
space_slo string добавлено в netapp.ontap 2.9.0 | Задаёт тип SLO пространства для тома. Тип SLO пространства — это целевой уровень обслуживания для управления пространством тома. Значение SLO пространства используется для применения существующих настроек тома, чтобы на агрегате было зарезервировано достаточно места для соблюдения SLO пространства. Этот параметр не поддерживается для Infinite Volumes. Варианты:
|
state string | Должен ли указанный том существовать. Варианты:
|
tags list / elements=string добавлено в netapp.ontap 22.6.0 | Теги — это необязательный способ отслеживания использования ресурса. Значения тегов должны быть представлены в виде строк ключ:значение, например [“team:csi”, “environment:test”] |
tiering_minimum_cooling_days integer добавлено в netapp.ontap 21.16.0 | Определяет, сколько дней должно пройти, прежде чем неактивные данные в томе с политикой Auto или Snapshot-Only будут считаться холодными и пригодными для перемещения на уровень хранения. Этот параметр поддерживается только в REST 9.8 или более поздней версии. |
tiering_object_tags list / elements=string добавлено в netapp.ontap 23.1.0 | Этот параметр задаёт теги тома для объектов, хранящихся на агрегате с включённым FabricPool. Каждый тег представляет собой пару ключ-значение в формате “key=value”. Для одного тома можно задать не более 4 тегов. Чтобы удалить все существующие теги объектов для перемещения на уровень хранения, укажите в качестве значения параметра пустой список. |
tiering_policy string добавлено в netapp.ontap 2.9.0 | Политика перемещения на уровень хранения, связанная с томом. Эта политика определяет, будут ли блоки тома перемещаться на уровень ёмкости. Политика snapshot-only разрешает перемещение только копий снимков тома, не связанных с активной файловой системой. Политика auto разрешает перемещение на уровень ёмкости пользовательских данных как из снимков, так и из активной файловой системы. Политика backup для томов DP позволяет размещать все передаваемые блоки пользовательских данных на уровне ёмкости. В REST значению backup соответствует all. Если задано значение none, блоки тома не будут перемещаться на уровень ёмкости. Если значение не указано, по умолчанию том назначается политике snapshot only. Требуется ONTAP 9.4 или более поздняя версия. Варианты:
|
time_out integer добавлено в netapp.ontap 2.8.0 | Для ZAPI — время ожидания создания, изменения или удаления FlexGroup в секундах. Для REST — время ожидания создания, изменения или удаления любого тома в секундах. Выдаёт ошибку, если задача не завершена в течение заданного времени. Для ZAPI значение 0 означает, что запрос выполняется асинхронно. По умолчанию задано 3 минуты. Для операций перемещения тома и шифрования используйте По умолчанию: |
type string | Тип тома: для чтения и записи (RW) или для защиты данных (DP). |
unix_permissions string добавлено в netapp.ontap 2.8.0 | Биты разрешений Unix в восьмеричном или символьном формате. Например, 0 эквивалентно ------------, а 777 — ---rwxrwxrwx; поддерживаются оба формата. Допустимое восьмеричное значение находится в диапазоне от 0 до 777 включительно. |
use_lambda boolean добавлено в netapp.ontap 23.2.0 | Указывает, следует ли использовать функцию прокси AWS Lambda для подключения к системе ONTAP. Поддерживается только с REST. Варианты:
|
use_rest string | Использовать REST или ZAPI. always — всегда использовать REST API, если модуль поддерживает REST. Если модуль не поддерживает REST, выдаётся предупреждение. Если параметр модуля не поддерживается в REST, выдаётся ошибка. never — всегда использовать ZAPI, если модуль поддерживает ZAPI. Если параметр REST не поддерживается в ZAPI, может быть выдана ошибка. auto — попытаться использовать REST API, если модуль поддерживает REST и параметры модуля поддерживаются. В противном случае используется ZAPI. По умолчанию: |
user_id integer добавлено в netapp.ontap 20.1.0 | Идентификатор пользователя UNIX для тома. Значение по умолчанию — 0 (‘root’). |
username псевдонимы: user string | Это может быть учётная запись уровня кластера или уровня SVM — в зависимости от того, требуется ли API уровня кластера или уровня SVM. Дополнительные сведения см. в документации https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Поддерживаются два метода аутентификации
Для использования сертификата его необходимо установить в кластере ONTAP и включить аутентификацию по сертификату. |
validate_certs boolean | Если задано значение Это следует задавать только для Варианты:
|
vol_full_threshold_percent integer добавлено в netapp.ontap 22.8.0 | Задаёт процент заполнения, при достижении которого том считается заполненным и выше которого будет сгенерирована критическая ошибка EMS. Значение по умолчанию — 98%. Максимальное значение этого параметра — 100%. При установке порога в 0 предупреждения о заполнении тома отключаются. Поддерживается только в REST и требует ONTAP 9.9 или более поздней версии. |
vol_nearly_full_threshold_percent integer добавлено в netapp.ontap 22.8.0 | Задаёт процент заполнения, при достижении которого том считается почти заполненным и выше которого будет сгенерировано предупреждение EMS. Значение по умолчанию — 95%. Максимальное значение этого параметра — 99%. При установке порога в 0 предупреждения о почти полном заполнении тома отключаются. Поддерживается только в REST и требует ONTAP 9.9 или более поздней версии. |
volume_security_style string | Стиль безопасности, связанный с этим томом. Варианты:
|
vserver string / обязательный | Имя используемого vserver. |
vserver_dr_protection string добавлено в netapp.ontap 2.9.0 | Задаёт тип защиты тома в конфигурации Vserver DR. Варианты:
|
wait_for_completion boolean добавлено в netapp.ontap 2.8.0 | Задайте этому параметру значение ‘true’ для синхронного выполнения при создании (ожидания перехода тома в состояние online). Задайте этому параметру значение ‘false’ для асинхронного выполнения. При асинхронном выполнении запрос отправляется, после чего выполнение завершается без проверки состояния тома. Варианты:
|
Примечания
Примечание
- Поддерживаются REST и ZAPI. Для REST требуется ONTAP 9.6 или более поздняя версия. Для работы функции Efficiency через REST требуется ONTAP 9.7 или более поздняя версия.
- REST включается, если для
use_restзадано значение always. - Параметр feature_flag
warn_or_fail_on_fabricpool_backend_changeопределяет, будет ли выдаваться ошибка, если управление перемещением на уровень хранения требует включить или отключить FabricPool для существующего тома с другим серверным хранилищем. Допустимые значения: fail, warn и ignore; по умолчанию задано fail. - Операция snapshot_restore не является идемпотентной: восстановление выполняется всегда.
- При использовании REST поддерживается функция прокси AWS Lambda. Примеры см. в файле README.
- Модули с префиксом na_ontap предназначены для поддержки платформы хранения ONTAP.
- HTTPS включён по умолчанию и рекомендуется к использованию. Чтобы включить HTTP в кластере, выполните следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Примеры
- name: Create FlexVol
netapp.ontap.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
tiering_object_tags: ['tag1=one', 'tag2=two', 'tag3=3', 'tag4=4']
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Volume Delete
netapp.ontap.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
netapp.ontap.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
netapp.ontap.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
netapp.ontap.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
netapp.ontap.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)
netapp.ontap.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
netapp.ontap.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
netapp.ontap.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
netapp.ontap.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
netapp.ontap.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
netapp.ontap.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
netapp.ontap.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
exclude_aggregates: aggr0
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
# requires Ontap collection version - 21.24.0 to use iso filter plugin.
- name: volume create with snaplock set.
netapp.ontap.na_ontap_volume:
state: present
name: "{{ snaplock_volume }}"
aggregate_name: "{{ aggregate }}"
size: 20
size_unit: mb
space_guarantee: none
policy: default
type: rw
snaplock:
type: enterprise
retention:
default: "{{ 60 | netapp.ontap.iso8601_duration_from_seconds }}"
- name: Create volume with snapshot-auto-delete options - REST
netapp.ontap.na_ontap_volume:
state: present
name: test_vol
aggregate_name: "{{ aggr }}"
size: 20
size_unit: mb
snapshot_auto_delete:
state: 'on'
trigger: volume
delete_order: "oldest_first"
defer_delete: "user_created"
commitment: "try"
target_free_space: 30
prefix: "my_prefix"
wait_for_completion: true
- name: Modify volume - REST
netapp.ontap.na_ontap_volume:
state: present
name: test_vol
aggregate_name: "{{ aggr }}"
snapdir_access: false
snapshot_auto_delete:
state: 'on'
target_free_space: 25
- name: Modify volume tiering onject_tags - REST
netapp.ontap.na_ontap_volume:
state: present
name: test_vol
aggregate_name: "{{ aggr }}"
tiering_object_tags: ['tag1=one', 'tag2=two']
Ссылки на коллекцию
© 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_volume_module.html