Skip to main content
Command reference

vserver vscan on-demand-task show

Suggest changes
PDFs

Display On-Demand tasks

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

The vserver vscan on-demand-task show command displays information about the On-Demand tasks belonging to the Vserver. If you do not specify any parameters, the command displays the following information about all On-Demand tasks:

  • Vserver name

  • Task name

  • Scan paths

  • Report directory path

  • Schedule

You can specify the -fields parameter to specify which fields of information to display about On-Demand tasks. In addition to the fields above, you can display the following fields:

  • Max file size

  • File paths to exclude

  • File extensions to exclude

  • File extensions to include

  • Scan files without extension

  • Scan timeout

  • Cross junction

  • Directory recursion

  • Scan priority

  • Report log level

Parameters

{ [-fields <fieldname>,…​]

If you specify the -fields <fieldname>, …​ parameter, the command output also includes the specified field or fields. You can use '-fields ?' to display the fields to specify.

| [-instance ] }

If you specify the -instance parameter, the command displays detailed information about all fields.

[-vserver <vserver name>] - Vserver

If you specify this parameter, the command displays information only about the On-Demand tasks for the specified Vserver.

[-task-name <text>] - Task Name

If you specify this parameter, the command displays information only about the specified On-Demand task.

[-scan-paths <text>,…​] - List of Scan Paths

If you specify this parameter, the command displays information only about the On-Demand tasks that have the specified path or paths in the scan-paths list.

[-report-directory <text>] - Report Directory Path

If you specify this parameter, the command displays information only about the On-Demand tasks that have the specified report-directory.

[-schedule <text>] - Job Schedule

If you specify this parameter, the command displays information only about the On-Demand tasks that have the specified schedule.

[-max-file-size {<integer>[KB|MB|GB|TB|PB]}] - Max File Size Allowed for Scanning

If you specify this parameter, the command displays information only about the On-Demand tasks that have the specified max-file-size.

[-paths-to-exclude <text>,…​] - File Paths Not to Scan

If you specify this parameter, the command displays information only about the On-Demand tasks that have the specified path or paths in the exclude list.

[-file-ext-to-exclude <File extension>,…​] - File Extensions Not to Scan

If you specify this parameter, the command displays information only about the On-Demand tasks that have the specified file extension or extensions in the exclude list.

[-file-ext-to-include <File extension>,…​] - File Extensions to Scan

If you specify this parameter, the command displays information only about the On-Demand tasks that have the specified file extension or extensions in the include list.

[-scan-files-with-no-ext {true|false}] - Scan Files with No Extension

If you specify this parameter, the command displays information only about the On-Demand tasks that have the specified value.

[-request-timeout <[<integer>d][<integer>h][<integer>m][<integer>s]>] - Request Service Timeout

If you specify this parameter, the command displays information only about the On-Demand tasks that have the specified request-timeout.

[-cross-junction {true|false}] - Cross Junction

If you specify this parameter, the command displays information only about the On-Demand tasks that have the specified value.

[-directory-recursion {true|false}] - Directory Recursion

If you specify this parameter, the command displays information only about the On-Demand tasks that have the specified value.

[-scan-priority {low|normal}] - Scan Priority

If you specify this parameter, the command displays information only about the On-Demand tasks that have the specified scan-priority.

[-report-log-level {verbose|info|error}] - Report Log Level

If you specify this parameter, the command displays information only about the On-Demand tasks that have the specified report-log-level.

[-report-expiry-time <[<integer>d][<integer>h][<integer>m][<integer>s]>] - Expiration Time for Report

This parameter specifies the expiration time for the reports generated by On-Demand scans. Once this time elapses, the reports are auto-deleted. The default value is 0, which means reports are retained until they are manually deleted.

Examples

The following example displays information about all On-Demand tasks:

cluster1::> vserver vscan on-demand-task show
                                             Report
Vserver     Task Name   Scan Paths           Directory Path    Schedule
----------- ----------  -------------------- ----------------- --------------
vs1         t1          /test                /report           -
vs2         t2          /, /test/            /report           daily
2 entries were displayed.

The following example displays detailed information about an On-Demand task:

cluster1::> vserver vscan on-demand-task show -instance -vserver vs1 -task-name t1
Vserver: vs1
                         Task Name: t1
                List of Scan Paths: /test
             Report Directory Path: /report
                      Job Schedule: -
Max File Size Allowed for Scanning: 2GB
            File Paths Not to Scan: /vol1/cold-files/
       File Extensions Not to Scan: mp3, mp4
           File Extensions to Scan: *
      Scan Files with No Extension: true
           Request Service Timeout: 1m
                    Cross Junction: true
               Directory Recursion: true
                     Scan Priority: low
                  Report Log Level: verbose