Spec-Zone.ru › Ansible

Модуль netapp.ontap.na_ontap_volume_efficiency — включение, отключение и изменение эффективности тома 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_efficiency.

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

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

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

  • Включение, изменение или отключение эффективности тома.
  • Необходимо указать либо path, либо volume_name.
  • Изменять эффективность тома может только пользователь с правами администратора.

Требования

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

  • 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 или более поздняя версия.

Параметры

Параметр

Описание

cert_filepath

string

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

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

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

enable_compression

boolean

Указывает, следует ли включить сжатие.

Варианты:

  • false
  • true

enable_cross_volume_background_dedupe

boolean

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

Варианты:

  • false
  • true

enable_cross_volume_inline_dedupe

boolean

Указывает, следует ли включить встроенную дедупликацию между томами. Ее можно включить, только если включена встроенная дедупликация.

Варианты:

  • false
  • true

enable_data_compaction

boolean

Указывает, следует ли включить уплотнение данных.

Варианты:

  • false
  • true

enable_inline_compression

boolean

Указывает, следует ли включить встроенное сжатие.

Варианты:

  • false
  • true

enable_inline_dedupe

boolean

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

Варианты:

  • false
  • true

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, где каждый элемент является целым числом.

Если use_rest установлено в значение auto, параметр может принудительно переключить модуль на ZAPI в зависимости от версии и возможностей платформы.

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

hostname

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

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

http_port

integer

Переопределяет порт по умолчанию (80 или 443), указывая другой порт.

https

boolean

Включение и отключение HTTPS.

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

Игнорируется при аутентификации с помощью SSL-сертификата, поскольку для нее требуется SSL.

Варианты:

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

key_filepath

string

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

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

lambda_config

dictionary

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

Параметры конфигурации функции прокси-сервера AWS Lambda.

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

aws_profile

string

Имя профиля AWS, используемого для аутентификации.

aws_region

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

Название региона AWS.

function_name

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

Имя вызываемой функции AWS Lambda.

ontapi

integer

Версия API ONTAP, которую следует использовать.

password

псевдонимы: pass

string

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

path

string

Указывает путь к тому.

Необходимо указать либо path, либо volume_name.

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

policy

string

Указывает политику эффективности хранения, которую следует использовать.

По умолчанию доступны следующие названия: ‘auto’, ‘default’, ‘inline-only’, ‘-’.

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

rest_timeout

integer

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

Задает время ожидания ответа REST API в секундах.

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

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

schedule

string

Указывает расписание эффективности хранения.

Поддерживается только при использовании ZAPI.

start_ve_build_metadata

boolean

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

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

Поддерживается только при использовании ZAPI.

Варианты:

  • false
  • true

start_ve_delete_checkpoint

boolean

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

Указывает сканеру удалить существующую контрольную точку и начать операцию сначала.

Поддерживается только при использовании ZAPI.

Варианты:

  • false
  • true

start_ve_qos_policy

string

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

Указывает политику QoS для операции.

В ZAPI по умолчанию используется best-effort.

Поддерживается только при использовании ZAPI.

Варианты:

  • "background"
  • "best-effort"

start_ve_queue_operation

boolean

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

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

Поддерживается только при использовании ZAPI.

Варианты:

  • false
  • true

start_ve_scan_all

boolean

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

Указывает сканеру просканировать весь том, не применяя оптимизацию совместного использования блоков.

Поддерживается только при использовании ZAPI.

Варианты:

  • false
  • true

start_ve_scan_old_data

boolean

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

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

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

Варианты:

  • false
  • true

state

string

Следует ли включить эффективность указанного тома.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

stop_ve_all_operations

boolean

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

Указывает остановить все выполняющиеся операции и операции в очереди.

Поддерживается только при использовании ZAPI.

Варианты:

  • false
  • true

storage_efficiency_mode

string

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

Режим эффективности хранения, используемый томом. Этот параметр поддерживается только на платформах AFF.

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

Варианты:

  • "default"
  • "efficient"

time_out

integer

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

Если задано wait_for_completion, указывает время ожидания выполнения операции повышения эффективности тома в секундах.

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

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

use_lambda

boolean

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

Указывает, следует ли использовать функцию прокси-сервера AWS Lambda для подключения к системе ONTAP.

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

Варианты:

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

use_rest

string

Выбор между REST и ZAPI.

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

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

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

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

username

псевдонимы: user

string

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

Дополнительные сведения см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html.

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

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

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

validate_certs

boolean

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

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

Варианты:

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

volume_efficiency

string

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

Запуск или остановка операции повышения эффективности для тома по указанному пути.

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

Варианты:

  • "start"
  • "stop"

volume_name

string

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

Указывает имя тома.

vserver

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

Указывает vserver для тома.

wait_for_completion

boolean

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

Для синхронного выполнения задайте этому параметру значение ‘true’.

При асинхронном выполнении работа завершается сразу после отправки запроса, а операция продолжается в фоновом режиме.

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

Варианты:

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

Примечания

Примечание

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

Примеры

- name: Enable Volume efficiency
  netapp.ontap.na_ontap_volume_efficiency:
    state: present
    vserver: "TESTSVM"
    path: "/vol/test_sis"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

- name: Disable Volume efficiency test
  netapp.ontap.na_ontap_volume_efficiency:
    state: absent
    vserver: "TESTSVM"
    path: "/vol/test_sis"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

- name: Modify storage efficiency schedule with ZAPI.
  netapp.ontap.na_ontap_volume_efficiency:
    state: present
    vserver: "TESTSVM"
    path: "/vol/test_sis"
    schedule: "mon-sun@0,1,23"
    enable_compression: true
    enable_inline_compression: true
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

- name: Start volume efficiency
  netapp.ontap.na_ontap_volume_efficiency:
    state: present
    vserver: "TESTSVM"
    path: "/vol/test_sis"
    volume_efficiency: "start"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

- name: Stop volume efficiency
  netapp.ontap.na_ontap_volume_efficiency:
    state: present
    vserver: "TESTSVM"
    path: "/vol/test_sis"
    volume_efficiency: "stop"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

- name: Modify volume efficiency with volume name in REST.
  netapp.ontap.na_ontap_volume_efficiency:
    state: present
    vserver: "TESTSVM"
    volume_name: "test_sis"
    volume_efficiency: "stop"
    enable_compression: true
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

Авторы

  • NetApp Ansible Team (@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_volume_efficiency_module.html

Spec-Zone.ru

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