Spec-Zone.ru › Ansible

Модуль netapp.ontap.na_ontap_volume – Управление томами NetApp ONTAP.

Примечание

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

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

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

Для использования в playbook, укажите: netapp.ontap.na_ontap_volume.

Новая функция в netapp.ontap 2.6.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры

Обзор

  • Создание, удаление или изменение томов на NetApp ONTAP.

Требования

Ниже перечислены требования, необходимые на хосте, на котором будет выполняться этот модуль.

  • Ansible 2.9 или более поздняя версия — рекомендуется 2.12 или более поздняя.
  • Python3 — 3.9 или более поздняя версия — рекомендуется.
  • При использовании ZAPI, netapp-lib 2018.11.13 или более поздняя версия (установить с помощью «pip install netapp-lib»), настоятельно рекомендуется netapp-lib 2020.3.12, так как она обеспечивает лучшую отчетность об ошибках при подключении.
  • Физическая или виртуальная кластерная система Data ONTAP, модули поддерживают Data ONTAP 9.1 и более поздние версии, поддержка REST требует ONTAP 9.6 или более поздней версии.

Параметры

Параметр

Комментарии

activity_tracking

string

added in netapp.ontap 22.12.0

Устанавливает состояние отслеживания активности тома.

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

Choices:

  • "on"
  • "off"

aggr_list

list / elements=string

added in netapp.ontap 2.8.0

Массив имен агрегатов, которые будут использоваться для компонентов FlexGroup.

aggr_list_multiplier

integer

added in netapp.ontap 2.8.0

Количество итераций по агрегатам, указанным с помощью параметра aggr_list, при создании FlexGroup.

aggregate_name

string

Имя агрегата, на котором должен находиться flexvol.

Не может быть установлен при использовании опции na_application_template.

analytics

string

added in netapp.ontap 22.0.0

Устанавливает состояние аналитики файловой системы тома.

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

Невозможно включить аналитику для тома, содержащего LUN.

Choices:

  • "on"
  • "off"

atime_update

boolean

added in netapp.ontap 2.8.0

Это расширенный параметр, значение по умолчанию — True.

Если false, предотвращает обновление времени последнего доступа к индексному дескриптору при чтении файла.

Это значение полезно для томов с чрезвычайно высоким трафиком чтения, поскольку оно предотвращает запись в файл индексных дескрипторов для тома от конкуренции с чтениями из других файлов.

Это поле следует использовать осторожно.

То есть используйте это поле, если вы заранее знаете, что правильное время доступа к индексным дескрипторам не потребуется для файлов на этом томе.

Этот параметр поддерживается в REST для ONTAP 9.8 или более поздней версии с версией коллекции ONTAP 22.8.0 или более поздней.

Choices:

  • false
  • true

auto_provision_as

string

added in netapp.ontap 2.8.0

Автоматически подготавливает том FlexGroup.

Choices:

  • "flexgroup"

auto_remap_luns

boolean

added in netapp.ontap 20.6.0

Флаг для управления автоматическим отображением LUN.

Choices:

  • false
  • true

cert_filepath

string

added in netapp.ontap 20.6.0

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

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

check_interval

integer

added in netapp.ontap 20.6.0

Время в секундах ожидания между проверками тома, чтобы убедиться, что он успешно перемещен.

Default: 30

comment

string

added in netapp.ontap 2.9.0

Устанавливает комментарий, связанный с томом.

compression

boolean

added in netapp.ontap 20.12.0

Включать ли сжатие для тома (агрегаты HDD и Flash Pool).

Если этот параметр отсутствует, он автоматически устанавливается в true, если inline_compression равно true.

Choices:

  • false
  • true

cutover_action

string

added in netapp.ontap 20.5.0

Указывает действие, которое необходимо выполнить для переключения.

Возможные значения: ‘abort_on_failure’, ‘defer_on_failure’, ‘force’ и ‘wait’. Значение по умолчанию — ‘defer_on_failure’.

Choices:

  • "abort_on_failure"
  • "defer_on_failure"
  • "force"
  • "wait"

efficiency_policy

string

added in netapp.ontap 2.7.0

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

encrypt

boolean

added in netapp.ontap 2.7.0

Включать ли шифрование тома.

Если отсутствует, ONTAP по умолчанию устанавливает false при создании тома.

Изменение значения encrypt после создания требует ONTAP 9.3 или более поздней версии.

Choices:

  • false
  • true

export_policy

aliases: policy

string

Имя политики экспорта.

Взаимоисключающее с подуровнем nfs_access в nas_application_template.

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 установлено в авто, это может принудительно переключить на ZAPI в зависимости от версии и возможностей платформы.

Игнорируется при использовании ZAPI.

force_restore

логическое

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

Если это поле установлено в «true», копия снимка восстанавливается даже если у тома есть одна или несколько более новых копий снимка, которые в настоящее время используются как ссылка снимка SnapMirror. Если восстановление выполняется в такой ситуации, это приведет к ошибкам будущих передач SnapMirror.

Параметр следует использовать только вместе с snapshot_restore.

Варианты:

  • false
  • true

force_unmap_luns

логическое

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

Флаг для управления автоматическим размапированием LUN.

Варианты:

  • false
  • true

from_name

строка

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

Имя существующего тома, который нужно переименовать в name.

from_vserver

строка

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

ИСТОЧНИК vserver тома, который переносит.

group_id

целое число

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

Идентификатор группы UNIX для тома. Значение по умолчанию — 0 («root»).

hostname

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

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

http_port

целое число

Переопределить стандартный порт (80 или 443) на указанный порт.

https

логическое

Включить и отключить https.

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

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

Варианты:

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

inline_compression

логическое

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

Включить или отключить сжатие внутри тома (HDD и Flash Pool агрегаты, платформы AFF).

Варианты:

  • false
  • true

is_infinite

логическое

Установить True, если том является бесконечным томом.

Удаление бесконечного тома асинхронно.

Варианты:

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

is_online

логическое

Указать, онлайн ли указанный том.

Варианты:

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

junction_path

строка

Путь соединения тома.

Для размонтирования используйте путь соединения ''.

key_filepath

строка

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

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

language

строка

добавлено в 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’ к коду языка

logical_space_enforcement

boolean

added in netapp.ontap 21.16.0

Это необязательно указывает, следует ли выполнять логическое учётное пространство на томе. Когда пространство выполняется логически, ONTAP принуждает настройки тома таким образом, что всё физическое пространство, сохранённое функциями повышения эффективности хранения, будет рассчитываться как использованное.

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

Варианты:

  • false
  • true

logical_space_reporting

boolean

added in netapp.ontap 21.16.0

Это необязательно указывает, следует ли логически сообщать о пространстве на томе. Когда пространство сообщается логически, ONTAP сообщает о пространстве тома таким образом, что всё физическое пространство, сохранённое функциями повышения эффективности хранения, также сообщается как использованное.

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

Варианты:

  • false
  • true

max_files

integer

added in netapp.ontap 21.18.0

Максимальное количество файлов (индексов) для данных, видимых пользователю, разрешённых на томе.

Примечание: ONTAP выделяет немного другое значение, например, 3990 при запросе 4000. Для сохранения идемпотентности небольшие различия в размере игнорируются.

max_wait_time

integer

added in netapp.ontap 22.0.0

Операции перемещения и шифрования томов могут занимать больше времени для завершения.

При установке wait_for_completion, модуль будет ожидать время, установленное в этом параметре, для завершения перемещения и шифрования тома.

Если время истечёт, модуль завершит работу, и операция может по-прежнему выполняться.

Значение по умолчанию установлено в 10 минут.

Значение по умолчанию: 600

name

string / обязательный

Имя тома для управления.

nas_application_template

словарь

added in netapp.ontap 20.12.0

Дополнительные параметры при использовании REST API для создания тома.

Модуль по умолчанию использует ZAPI и переключается на REST, если присутствует любой подпараметр.

По умолчанию создаётся FlexVol.

Создаётся FlexGroup, если auto_provision_as установлено и FlexCache не установлено.

Создаётся FlexCache, если присутствует параметр flexcache.

cifs_access

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

Список CIFS контролей доступа. Необходимо указать user_or_group или access для активации CIFS доступа.

access

строка

Предоставленный CIFS доступ пользователю или группе. По умолчанию full_control.

Варианты:

  • "change"
  • "full_control"
  • "no_access"
  • "read"

user_or_group

строка

Имя CIFS пользователя или группы, которому будет предоставлен доступ. По умолчанию Everyone.

exclude_aggregates

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

added in netapp.ontap 21.7.0

Список имён агрегатов, которые нужно исключить при создании тома.

Требуется ONTAP 9.9.1 GA или более поздней версии.

flexcache

словарь

указывает на создание flexcache. Если отсутствует, создаётся FlexVol или FlexGroup.

dr_cache

boolean

added in netapp.ontap 21.3.0

Использовать ли тот же msid flexgroup, что и у источника.

Требуется ONTAP 9.9 и REST.

Только для создания, игнорируется, если flexcache уже существует.

Варианты:

  • false
  • true

origin_component_name

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

Удаленный компонент для flexcache.

origin_svm_name

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

Удалённый SVM для flexcache.

nfs_access

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

Список NFS контролей доступа. Необходимо указать host или access для активации NFS доступа.

Взаимоисключающее с параметром export_policy.

access

строка

Предоставленный NFS доступ. По умолчанию rw.

Варианты:

  • "none"
  • "ro"
  • "rw"

host

строка

Имя NFS сущности, которой предоставляется доступ. По умолчанию 0.0.0.0/0.

storage_service

string

Уровень производительности (PSL) для этого тома

Выбор:

  • "value"
  • "performance"
  • "extreme"

tiering

dictionary

Политика тиеринга облака (см. tiering_policy для более подробного описания).

control

string

Правила размещения тиеринга хранилища для контейнера.

Выбор:

  • "required"
  • "best_effort"
  • "disallowed"

object_stores

list / elements=string

Список имён хранилищ объектов для тиеринга.

policy

string

Политика тиеринга облака (см. tiering_policy).

Должно совпадать с tiering_policy, если оба присутствуют.

Выбор:

  • "all"
  • "auto"
  • "none"
  • "snapshot-only"

use_nas_application

boolean

Использовать ли REST/API приложения/приложений для создания тома.

По умолчанию будет true, если присутствует любая другая подопция.

Выбор:

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

nvfail_enabled

boolean

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

Если true, контроллер выполняет дополнительную работу при загрузке и перехвате, если обнаруживает потенциальную потерю данных в компонентах тома из-за сбоя NVRAM.

Компоненты тома будут помещены в специальное состояние «in-nvfailed-state», в результате чего доступ по протоколу будет заблокирован.

Это приведет к сбою клиентских приложений и, таким образом, предотвратит доступ к устаревшим данным.

Чтобы выйти из этой ситуации, администратору необходимо вручную очистить «in-nvfailed-state» в компонентах тома.

Выбор:

  • false
  • true

ontapi

integer

Используемая версия API ontap

password

aliases: pass

string

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

percent_snapshot_space

integer

Количество места, резервируемого для снимков тома.

preserve_lun_ids

boolean

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

Если это поле установлено в «true», LUN в восстанавливаемом томе останутся сопоставленными и их идентификаторы будут сохранены, чтобы обеспечить бесперебойность подключения хостов во время операции восстановления. Ввод-вывод в LUN будет заблокирован во время операции восстановления, поместив LUN в недоступное состояние. После завершения операции восстановления хосты смогут возобновить доступ к LUN.

Параметр следует использовать только вместе со snapshot_restore.

Выбор:

  • false
  • true

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). Требуется при state=present.

size_change_threshold

integer

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

Процент изменения размера для запуска изменения размера.

Когда этот параметр больше 0, разница в размере между ожидаемым и настроенным значениями игнорируется, если она меньше порога.

Например, приложение nas выделяет больший размер, чем указано, чтобы учесть издержки.

Установите значение 0 для точного соответствия.

По умолчанию: 10

size_unit

string

Единица измерения, используемая для интерпретации параметра size.

Выбор:

  • "bytes"
  • "b"
  • "kb"
  • "mb"
  • "gb" ← (по умолчанию)
  • "tb"
  • "pb"
  • "eb"
  • "zb"
  • "yb"

sizing_method

string

added in netapp.ontap 20.12.0

Представляет метод изменения размера FlexGroup.

use_existing_resources - Увеличивает или уменьшает размер FlexGroup, увеличивая или уменьшая размер текущих ресурсов FlexGroup.

add_new_resources - Увеличивает размер FlexGroup, добавляя новые ресурсы. Ограничено двумя новыми ресурсами на агрегат.

Поддерживается только при включенном REST (ONTAP 9.6 или новее) и только для FlexGroup. ONTAP по умолчанию использует use_existing_resources.

Варианты:

  • "add_new_resources"
  • "use_existing_resources"

snapdir_access

boolean

added in netapp.ontap 2.8.0

Это расширенный параметр, по умолчанию False.

Включает видимую директорию ‘.snapshot’, которая обычно присутствует на внутренних точках монтирования системы.

Этот параметр также включает доступ ко всем другим каталогам ‘.snapshot’ в томе.

Этот параметр поддерживается в REST для ONTAP 9.13.1 или новее с версией ONTAP collection 22.8.0 или новее.

Варианты:

  • false
  • true

snaplock

dictionary

added in netapp.ontap 21.18.0

Начиная с ONTAP 9.10.1, snaplock.type устанавливается на уровне тома.

Другие подпараметры могут быть установлены или изменены при использовании REST в более ранних версиях ONTAP.

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

append_mode_enabled

boolean

При включении все файлы, созданные с правами записи на томе, по умолчанию являются файлами, допускающими добавление в конец (WORM). Пользователь может добавлять данные к файлу, допускающему добавление в конец, но не может изменять существующее содержимое файла или удалять файл до его истечения срока действия.

Варианты:

  • false
  • true

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.

Варианты:

  • "disabled"
  • "enabled"
  • "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.

Варианты:

  • "compliance"
  • "enterprise"
  • "non_snaplock"

snapshot_auto_delete

dictionary

added in netapp.ontap 20.4.0

Словарь с параметрами и значениями для автоматического удаления снимков.

Поддерживаемые параметры включают ‘state’, ‘commitment’, ‘trigger’, ‘target_free_space’, ‘delete_order’, ‘defer_delete’, ‘prefix’, ‘destroy_list’.

Все вышеперечисленные параметры, кроме ‘destroy_list’, поддерживаются в REST для ONTAP 9.13.1 или новее с версией ONTAP collection 22.8.0 или новее.

Параметр ‘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-режимного, возможные значения для этого параметра - комбинация ‘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_locking

boolean

added in netapp.ontap 22.12.0

Определяет, включена ли блокировка копий снимков на томе.

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

Варианты:

  • false
  • true

snapshot_policy

string

added in netapp.ontap 2.8.0

Имя политики снимков.

Имя политики по умолчанию — «default».

При наличии это будет устанавливать protection_type при использовании nas_application_template.

snapshot_restore

string

added in netapp.ontap 20.6.0

Имя снимка, из которого нужно восстановить.

Не поддерживается на бесконечных томах (Infinite Volume).

space_guarantee

string

Стиль гарантии пространства для тома.

Настройка файла больше не поддерживается.

Варианты:

  • "none"
  • "file"
  • "volume"

space_slo

string

added in netapp.ontap 2.9.0

Указывает тип SLO пространства для тома. Тип SLO пространства — это целевой уровень обслуживания для управления пространством для тома.

Значение SLO пространства используется для принудительного применения существующих параметров тома, чтобы на агрегате было выделено достаточно места для соответствия SLO пространства.

Этот параметр не поддерживается на бесконечных томах (Infinite Volumes).

Варианты:

  • "none"
  • "thick"
  • "semi-thick"

state

string

Должен ли указанный том существовать или нет.

Варианты:

  • "present" ← (default)
  • "absent"

tags

list / elements=string

added in netapp.ontap 22.6.0

Теги — это необязательный способ отслеживания использования ресурса.

Значения тегов должны быть отформатированы как строки ключ:значение, например [“team:csi”, “environment:test”]

tiering_minimum_cooling_days

integer

added in netapp.ontap 21.16.0

Определяет, сколько дней должно пройти, прежде чем неактивные данные в томе, использующем политику «Авто» или «Только снимок», будут считаться холодными и пригодными для многоуровневого хранения.

Эта опция поддерживается только в REST 9.8 и более поздних версиях.

tiering_policy

string

added in netapp.ontap 2.9.0

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

Эта политика определяет, будут ли блоки тома переведены на уровень емкости.

Политика «только снимок» позволяет многоуровневое хранение только копий снимков тома, не связанных с активной файловой системой.

Политика «авто» позволяет многоуровневое хранение как снимков, так и активных пользовательских данных файловой системы на уровне емкости.

Политика резервного копирования на томах DP позволяет всем переданным блокам пользовательских данных начинаться на уровне емкости.

all — эквивалент backup в REST.

Если установлено значение none, блоки тома не будут переведены на уровень емкости.

Если значение не указано, тому по умолчанию назначается «только снимок».

Требуется ONTAP 9.4 или более поздняя версия.

Варианты:

  • "snapshot-only"
  • "auto"
  • "backup"
  • "none"
  • "all"

time_out

integer

added in netapp.ontap 2.8.0

С ZAPI — время ожидания создания, изменения или удаления группы Flexgroup в секундах.

С REST — время ожидания создания, изменения или удаления любого тома в секундах.

Возникает ошибка, если задача не завершена за указанное время.

С ZAPI — если 0, запрос асинхронный.

По умолчанию установлено 3 минуты.

Используйте max_wait_time и wait_for_completion для операций перемещения и шифрования томов.

По умолчанию: 180

type

string

Тип тома: запись-чтение (RW) или защита данных (DP).

unix_permissions

string

added in netapp.ontap 2.8.0

Биты разрешений Unix в восьмеричном или символическом формате.

Например, 0 эквивалентно ————, 777 эквивалентно —rwxrwxrwx, оба формата принимаются.

Допустимый восьмеричный диапазон значений от 0 до 777 включительно.

use_rest

string

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

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

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

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

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

user_id

integer

added in netapp.ontap 20.1.0

Идентификатор UNIX-пользователя для тома. Значение по умолчанию — 0 («root»).

username

aliases: user

string

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

Дополнительные сведения см. в документации https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/.

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

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

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

validate_certs

boolean

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

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

Варианты:

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

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

Стиль безопасности, связанный с этим томом.

Варианты:

  • "mixed"
  • "ntfs"
  • "unified"
  • "unix"

vserver

string / обязательно

Имя vserver для использования.

vserver_dr_protection

string

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

Указывает тип защиты тома в настройке DR Vserver.

Варианты:

  • "protected"
  • "unprotected"

wait_for_completion

boolean

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

Установите этот параметр в ‘true’ для синхронного выполнения во время создания (дождитесь, пока статус тома не станет online)

Установите этот параметр в ‘false’ для асинхронного выполнения.

Для асинхронного выполнения скрипт завершается сразу после отправки запроса, не проверяя статус тома

Варианты:

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

Примечания

Примечание

  • поддерживает REST и ZAPI. REST требует ONTAP 9.6 или более поздней версии. Эффективность с REST требует ONTAP 9.7 или более поздней версии.
  • REST активирован, когда use_rest установлен в всегда.
  • Флаг функции warn_or_fail_on_fabricpool_backend_change управляет тем, сообщается ли об ошибке, когда управление тиерингом требует или запрещает FabricPool для существующего тома с другим бэкендом. Разрешенные значения — fail, warn и ignore, а по умолчанию установлено fail.
  • snapshot_restore не идемпотентен, он всегда восстанавливает.
  • Модули с префиксом 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
    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

Авторы

  • Команда NetApp Ansible (@carchi8py)

Ссылки на сборку

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (источники)

© 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_volume_module.html

Spec-Zone.ru

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