Spec-Zone.ru › Ansible

netapp.ontap.na_ontap_vscan_on_demand_task модуль – Настройка задачи Vscan по требованию NetApp ONTAP.

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: netapp.ontap.na_ontap_vscan_on_demand_task.

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

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

Описание

  • Настройка задачи Vscan по требованию

Требования

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

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

Параметры

Параметр

Комментарии

cert_filepath

строка

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

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

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

cross_junction

логическое значение

Указывает, разрешено ли задаче "On-Demand" пересекать объёмные соединения.

Этот параметр не поддерживается REST.

По умолчанию этот параметр равен False для ZAPI.

Варианты:

  • false
  • true

directory_recursion

логическое значение

Указывает, разрешено ли задаче "On-Demand" рекурсивно сканировать подкаталоги.

Этот параметр не поддерживается REST.

По умолчанию этот параметр равен False для ZAPI.

Варианты:

  • false
  • true

feature_flags

словарь

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

Включить или выключить новую функцию.

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

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

file_ext_to_exclude

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

Расширения файлов, для которых не должно выполняться сканирование.

Файл, расширение которого соответствует как списку включения, так и списку исключения, не рассматривается для сканирования.

file_ext_to_include

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

Расширения файлов, для которых выполняется сканирование.

Значение по умолчанию — «*», что означает, что все файлы рассматриваются для сканирования, за исключением тех, которые исключены из сканирования.

Файл, расширение которого соответствует как списку включения, так и списку исключения, не рассматривается для сканирования.

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.

hostname

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

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

http_port

целое число

Переопределить порт по умолчанию (80 или 443) этим портом

https

логическое значение

Включить и выключить https.

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

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

Варианты:

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

key_filepath

строка

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

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

max_file_size

целое число

Максимальный размер файла (в байтах), разрешенный для сканирования. Если значение не указано при создании задачи, используется значение по умолчанию 10737418240 (10 ГБ).

ontapi

целое число

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

password

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

строка

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

paths_to_exclude

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

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

report_directory

строка

Путь от корня vserver, где создаётся отчёт задачи. Путь должен быть каталогом и предоставляться в формате Unix от корня Vserver.

Пример /vol1/on-demand-reports.

report_log_level

строка

Уровень ведения журнала отчёта On-Demand.

Этот параметр не поддерживается REST.

По умолчанию этот параметр равен 'error' для ZAPI.

Варианты:

  • "verbose"
  • "info"
  • "error"

request_timeout

строка

Общий лимит времени обслуживания запроса в секундах. Если антивирусный сканер не отвечает в течение указанного времени, сканирование будет прервано по тайм-ауту.

Этот параметр не поддерживается REST.

scan_files_with_no_ext

boolean

Определяет, учитываются ли для сканирования файлы без расширения.

Варианты:

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

scan_paths

list / elements=string

Список путей, которые необходимо отсканировать. Путь должен быть предоставлен в формате Unix и с корня VServer.

Пример /vol1/large_files.

scan_priority

string

Приоритет запросов сканирования On-Demand, созданных этой задачей.

Этот параметр не поддерживается с REST.

По умолчанию для ZAPI этот параметр равен «low».

Варианты:

  • "low"
  • "normal"

schedule

string

Расписание задачи. Задача будет выполняться в соответствии с расписанием.

Для немедленного выполнения задачи необходимо использовать API vscan-on-demand-task-run после создания задачи.

state

string

Наличие или отсутствие задачи Vscan on demand.

Варианты:

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

task_name

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

Имя задачи.

use_rest

string

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

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

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

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

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

username

aliases: user

string

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

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

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

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

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

validate_certs

boolean

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

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

Варианты:

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

vserver

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

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

Примечания

Примечание

  • Модули с префиксом na_ontap созданы для поддержки платформы хранения ONTAP.
  • https включен по умолчанию и рекомендуется. Для включения http в кластере необходимо выполнить следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Примеры

- name: Create Vscan On Demand Task
  netapp.ontap.na_ontap_vscan_on_demand_task:
    state: present
    username: '{{ netapp_username }}'
    password: '{{ netapp_password }}'
    hostname: '{{ netapp_hostname }}'
    vserver: carchi-vsim2
    task_name: carchiOnDemand
    scan_paths: /
    report_directory: /
    file_ext_to_exclude: ['py', 'yml']
    max_file_size: 10737418241
    paths_to_exclude: ['/tmp', '/var']
    report_log_level: info
    request_timeout: 60

- name: Delete Vscan On Demand Task
  netapp.ontap.na_ontap_vscan_on_demand_task:
    state: absent
    username: '{{ netapp_username }}'
    password: '{{ netapp_password }}'
    hostname: '{{ netapp_hostname }}'
    vserver: carchi-vsim2
    task_name: carchiOnDemand

Авторы

  • Команда 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_vscan_on_demand_task_module.html

Spec-Zone.ru

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