Skip to main content

vserver vscan on-access-policy show

Display On-Access policies

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

Description​

The vserver vscan on-access-policy show command displays information about the On-Access policies belonging to the Vserver. It also displays the current status in Vserver scope. If you do not specify any parameters, the command displays the following information about all On-Access policies:

  • Vserver name

  • Policy name

  • Policy status

  • Policy owner

  • Protocol

  • File paths to exclude

  • File extensions to exclude

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

  • List of filters

  • Mandatory scan

  • Max file size

  • File extensions to include

  • Scan files without extension

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-Access policies for the specified Vserver.
[-policy-name <Policy name>] - Policy
If you specify this parameter, the command displays information only about the specified On-Access policy.
[-policy-status {on|off}] - Policy Status
If you specify this parameter, the command displays information only about the On-Access policies that have the specified status.
[-owner <Configuration owner>] - Policy Config Owner
If you specify this parameter, the command displays information only about the On-Access policies that have the specified owner.
[-protocol <CIFS>] - File-Access Protocol
If you specify this parameter, the command displays information only about the On-Access policies that have the specified protocol.
[-filters {scan-ro-volume|scan-execute-access}, ...] - Filters
If you specify this parameter, the command displays information only about the On-Access policies that have the specified filter or filters in the filter list.
[-scan-mandatory {on|off}] - Mandatory Scan
If you specify this parameter, the command displays information only about the On-Access policies that have mandatory scanning enabled.
[-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-Access policies that have the specified max-file-size.
[-paths-to-exclude <File path>, ...] - File Paths Not to Scan
If you specify this parameter, the command displays information only about the On-Access policies 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-Access policies 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-Access policies 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-Access policies that have the specified value.

Examples​

The following example displays information about all On-Access policies.

cluster1::> vserver vscan on-access-policy show
            Policy     Policy                              File-Ext    Policy
Vserver     Name       Owner    Protocol Paths Excluded    Excluded    Status
----------- ---------  -------- -------- ----------------- ----------- ------
Cluster     default_   cluster  CIFS     -                 -           off
            CIFS
vs1         default_   cluster  CIFS     -                 -           on
            CIFS
vs1         new        vserver  CIFS     \vol\temp         txt         off
vs2         default_   cluster  CIFS     -                 -           on
            CIFS
4 entries were displayed.

The following example displays detailed information about an On-Access policy.

cluster1::> vserver vscan on-access-policy show -instance -vserver vs1 -policy-name new

                           Vserver: vs1
                            Policy: new
                     Policy Status: off
               Policy Config Owner: vserver
              File-Access Protocol: CIFS
                           Filters: scan-ro-volume
                    Mandatory Scan: on
Max File Size Allowed for Scanning: 4GB
            File Paths Not to Scan: \vol\temp
       File Extensions Not to Scan: txt
           File Extensions to Scan: *
      Scan Files with No Extension: true