модуль netapp.ontap.na_ontap_flexcache — NetApp ONTAP FlexCache — создание/удаление отношений

Примечание

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

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

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

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

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

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

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

Создание/изменение/удаление отношений томов FlexCache.
При использовании ZAPI этот модуль не изменяет существующий том FlexCache.
При использовании REST можно запустить предварительное заполнение существующего тома FlexCache.
При использовании REST том можно смонтировать или размонтировать. Чтобы размонтировать том, установите для path значение ‘’.
Для предварительного заполнения том должен быть смонтирован.
Некоторые действия также доступны через na_ontap_volume.
В ZAPI нельзя удалить том кэша.

Требования

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

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

Параметры

Параметр	Комментарии
aggr_list aliases: aggregates list / elements=string	Список агрегатов для размещения целевого тома FlexCache.
aggr_list_multiplier aliases: constituents_per_aggregate integer	Количество повторов списка агрегатов. REST — число составляющих FlexCache на агрегат, если указано поле `aggregates`.
atime_scrub dictionary добавлено в netapp.ontap 22.14.0	Поддерживается только с REST и требует ONTAP 9.14.1 или более поздней версии.
enabled boolean	Указывает, включена ли для тома FlexCache очистка неактивных файлов на основе atime. Варианты: `false` `true`
period integer	Указывает продолжительность atime в днях, после которой кэшированный файл считается неактивным.
auto_provision_as string	Используйте этот параметр для автоматического выбора существующих агрегатов при подготовке тома. Например, flexgroup Обратите внимание, что будет выбран самый быстрый тип агрегата, у которого есть хотя бы один агрегат на каждом узле кластера. Игнорируется при использовании REST — для автоматического выбора не указывайте aggr_list.
cert_filepath string добавлено в netapp.ontap 20.6.0	Путь к файлу сертификата клиента SSL (.pem). Не поддерживается в Python 2.6.
cifs_change_notify_enabled boolean добавлено в netapp.ontap 22.14.0	Указывает, включены ли уведомления об изменениях CIFS для тома FlexCache. Поддерживается только с REST и требует ONTAP 9.15.1 или более поздней версии. Варианты: `false` `true`
dr_cache boolean добавлено в netapp.ontap 22.14.0	Если задано значение true, создается кэш DR. Поддерживается только с REST и требует ONTAP 9.9 или более поздней версии. Варианты: `false` `true`
feature_flags dictionary добавлено в netapp.ontap 20.5.0	Включение или отключение новой функции. Этот параметр можно использовать для включения экспериментальной функции или отключения новой функции, нарушающей обратную совместимость. Поддерживаемые ключи и значения могут изменяться без предварительного уведомления. Неизвестные ключи игнорируются.
force_offline boolean	Перевести том FlexCache в автономный режим перед удалением связи FlexCache. Том будет уничтожен, данные могут быть потеряны. Варианты: `false` ← (значение по умолчанию) `true`
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, где каждый элемент — целое число. Если для `use_rest` задано значение auto, это может принудительно переключить систему на ZAPI в зависимости от версии и возможностей платформы. Игнорируется при использовании ZAPI.
force_unmount boolean	Отмонтировать том FlexCache. Перед удалением связи FlexCache удалить путь соединения, по которому смонтирован том. Варианты: `false` ← (значение по умолчанию) `true`
global_file_locking_enabled boolean добавлено в netapp.ontap 22.14.0	Указывает, включен ли для тома FlexCache режим глобальной блокировки файлов. Если режим глобальной блокировки файлов включен, флаг ‘is_disconnected_mode_off_for_locks’ всегда установлен в ‘true’. Поддерживается только с REST и требует ONTAP 9.9 или более поздней версии. Варианты: `false` `true`
guarantee_type string добавлено в netapp.ontap 22.14.0	Указывает тип гарантии пространства этого тома в агрегате. Значение ‘volume’ резервирует пространство в агрегатах для всего тома. Значение ‘none’ не резервирует пространство в агрегатах, поэтому операции записи могут завершиться ошибкой, если в агрегате закончится свободное пространство. Поддерживается только с REST и требует ONTAP 9.7 или более поздней версии. Варианты: `"volume"` `"none"`
hostname string / обязательный	Имя хоста или IP-адрес экземпляра ONTAP.
http_port integer	Переопределяет порт по умолчанию (80 или 443) указанным портом.
https boolean	Включение и отключение https. Игнорируется при использовании REST, поскольку поддерживается только https. Игнорируется при использовании аутентификации с помощью SSL-сертификата, поскольку для нее требуется SSL. Варианты: `false` ← (значение по умолчанию) `true`
junction_path aliases: path string	Путь соединения кэш-тома.
key_filepath string добавлено в netapp.ontap 20.6.0	Путь к файлу ключа клиента SSL.
lambda_config dictionary добавлено в netapp.ontap 23.5.0	Параметры конфигурации прокси-функциональности AWS Lambda. Эти параметры и вложенные параметры поддерживаются только с REST.
aws_profile string	Имя профиля AWS, используемого для аутентификации.
aws_region string / обязательный	Название региона AWS.
function_name string / обязательный	Имя вызываемой функции AWS Lambda.
name aliases: volume string / обязательный добавлено в netapp.ontap 21.3.0	Имя целевого тома для FlexCache.
ontapi integer	Используемая версия API ONTAP.
origin_cluster string	Имя исходного кластера для FlexCache. Если параметр не указан, используется кластер, связанный с целевым vserver. Не используется при создании.
origin_volume string	Имя исходного тома для FlexCache. Обязателен при создании.
origin_vserver string	Имя исходного vserver для FlexCache. Обязателен при создании.
override_encryption boolean добавлено в netapp.ontap 22.14.0	Если задано значение true, для зашифрованного исходного тома создается незашифрованный том FlexCache. Поддерживается только с REST и требует ONTAP 9.14.1 или более поздней версии. Варианты: `false` `true`
password aliases: pass string	Пароль указанного пользователя.
prepopulate dictionary добавлено в netapp.ontap 21.3.0	Предварительно заполнить FlexCache данными из исходного тома. Требуется ONTAP 9.8 или более поздней версии и поддержка REST. Чтобы этот параметр действовал, необходимо задать dir_paths.
dir_paths list / elements=string / обязательный	Список путей к каталогам в пространстве имен владеющей SVM, по которым смонтирован том FlexCache. Путь должен начинаться с ‘/’.
exclude_dir_paths list / elements=string	Путь к каталогу, который необходимо исключить из предварительного заполнения. Путь должен начинаться с ‘/’. Требуется ONTAP 9.9 или более поздней версии.
force_prepopulate_if_already_created boolean	По умолчанию этот модуль запускает задачу предварительного заполнения при каждом вызове и не является идемпотентным. Если задано значение false, задача предварительного заполнения не запускается, если FlexCache уже существует. Варианты: `false` `true` ← (значение по умолчанию)
recurse boolean	Указывает, следует ли действию предварительного заполнения рекурсивно выполнять поиск по пути к каталогу. Если значение не задано, используется значение по умолчанию ‘true’. Варианты: `false` `true`
relative_size dictionary добавлено в netapp.ontap 22.14.0	Поддерживается только с REST и требует ONTAP 9.13.1 или более поздней версии.
enabled boolean	Указывает, включено ли для тома FlexCache относительное масштабирование размера. Варианты: `false` `true`
percentage integer	Указывает размер тома FlexCache в процентах относительно общего размера исходного тома.
size integer	Размер кэш-тома.
size_unit string	Единица измерения, используемая для интерпретации параметра size. Варианты: `"bytes"` `"b"` `"kb"` `"mb"` `"gb"` ← (значение по умолчанию) `"tb"` `"pb"` `"eb"` `"zb"` `"yb"`
state string	Должна ли указанная связь существовать. Варианты: `"present"` ← (значение по умолчанию) `"absent"`
time_out integer	Время ожидания создания или удаления FlexCache в секундах. Если значение равно 0, запрос выполняется асинхронно. По умолчанию задано значение 3 минуты. По умолчанию: `180`
use_lambda boolean добавлено в netapp.ontap 23.2.0	Указывает, следует ли использовать прокси-функциональность AWS Lambda для подключения к системе ONTAP. Поддерживается только с REST. Варианты: `false` ← (значение по умолчанию) `true`
use_rest string	Использовать REST или ZAPI. always — всегда использовать REST API, если модуль его поддерживает. Если модуль не поддерживает REST, выдается предупреждение. Если параметр модуля не поддерживается в REST, выдается ошибка. never — всегда использовать ZAPI, если модуль его поддерживает. Может быть выдана ошибка, если параметр REST не поддерживается в ZAPI. auto — попытаться использовать REST API, если модуль его поддерживает и параметры модуля поддерживаются. В противном случае переключиться на ZAPI. По умолчанию: `"always"`
username aliases: user string	Это может быть учетная запись уровня кластера или уровня SVM — в зависимости от того, требуется ли API уровня кластера или уровня SVM. Дополнительные сведения см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Поддерживаются два метода аутентификации: Базовая аутентификация с использованием имени пользователя и пароля. Аутентификация с помощью SSL-сертификата с использованием файла сертификата клиента SSL и, при необходимости, файла закрытого ключа. Для использования сертификата он должен быть установлен в кластере ONTAP, а аутентификация по сертификату должна быть включена.
validate_certs boolean	Если задано значение `no`, сертификаты SSL проверяться не будут. Задавать это значение следует только для `False` на контролируемых вами ресурсах, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (значение по умолчанию)
vserver string / обязательный	Имя целевого vserver для FlexCache. Обратите внимание, что hostname, username и password относятся к целевому vserver.

writeback

dictionary

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

Запись с отложенной записью FlexCache.

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

enabled

boolean

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

Запись с отложенной записью — это метод хранения, при котором данные сначала записываются в том FlexCache, а затем — в исходный том FlexCache.

Варианты:

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

Примечания

Примечание

При использовании REST поддерживается функциональность прокси AWS Lambda. Пример использования см. в README.
Модули с префиксом na_ontap предназначены для поддержки платформы хранения ONTAP.
HTTPS включён по умолчанию и рекомендуется к использованию. Чтобы включить HTTP в кластере, выполните следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Примеры

- name: Create FlexCache
  netapp.ontap.na_ontap_flexcache:
    state: present
    origin_volume: test_src
    name: test_dest
    origin_vserver: ansible_src
    vserver: ansible_dest
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete FlexCache
  netapp.ontap.na_ontap_flexcache:
    state: absent
    name: test_dest
    vserver: ansible_dest
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Авторы

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

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/netapp/ontap/na_ontap_flexcache_module.html