Spec-Zone.ru › Ansible

Модуль netapp.ontap.na_ontap_vscan_on_demand_task — настройка задачи сканирования Vscan по запросу в NetApp ONTAP.

Примечание

Этот модуль входит в коллекцию netapp.ontap (версия 23.5.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 или новее.
  • Python 3 — рекомендуется версия 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.

cross_junction

boolean

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

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

Для ZAPI по умолчанию установлено значение False.

Варианты:

  • false
  • true

directory_recursion

boolean

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

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

Для ZAPI по умолчанию установлено значение False.

Варианты:

  • false
  • true

feature_flags

dictionary

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

Включение или отключение новой функции.

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

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

file_ext_to_exclude

list / элементы=string

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

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

file_ext_to_include

list / элементы=string

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

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

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

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-клиента.

max_file_size

integer

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

ontapi

integer

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

password

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

string

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

paths_to_exclude

list / элементы=string

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

report_directory

string

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

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

report_log_level

string

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

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

Для ZAPI по умолчанию используется значение «error».

Варианты:

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

request_timeout

string

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

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

scan_files_with_no_ext

boolean

Указывает, следует ли сканировать файлы без расширения.

Варианты:

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

scan_paths

list / элементы=string

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

Пример: /vol1/large_files.

scan_priority

string

Приоритет запросов на сканирование по запросу, создаваемых этой задачей.

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

Для ZAPI по умолчанию используется значение «low».

Варианты:

  • "low"
  • "normal"

schedule

string

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

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

state

string

Наличие или отсутствие задачи Vscan по запросу.

Варианты:

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

task_name

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

Имя задачи.

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 ← (по умолчанию)

vserver

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

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

Примечания

Примечание

  • Модули с префиксом 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–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_vscan_on_demand_task_module.html

Spec-Zone.ru

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