vscanadm(1m)

1vscanadm(1M)            System Administration Commands            vscanadm(1M)
2
3
4

NAME

6       vscanadm - vscan service configuration utility
7

SYNOPSIS

9       vscanadm set -p property=value [-p property=value]...
10
11
12       vscanadm get [-p property]...
13
14
15       vscanadm import -p property filename
16
17
18       vscanadm export -p property filename
19
20
21       vscanadm validate -p property filename
22
23
24       vscanadm add-engine [-p property=value]... engine_id
25
26
27       vscanadm remove-engine engine_id
28
29
30       vscanadm set-engine -pproperty=value [-p property=value]... engine_id
31
32
33       vscanadm get-engine [-p property=value]... [engine_id]
34
35
36       vscanadm show
37
38
39       vscanadm stats [-z]
40
41

DESCRIPTION

43       The vscanadm command sets and displays properties of the vscan service,
44       vscand(1M), and provides scan statistics.
45
46
47       File system exemption from virus scanning may be  configured  per  file
48       system  using  the  appropriate file system administrative command, for
49       example zfs(1M).
50
51
52       Scan engines are third-party applications on external hosts  that  per‐
53       form  the  actual  virus  scanning  operation  on  files. Multiple scan
54       engines can be configured for use by the vscan service.  A  minimum  of
55       two  scan  engines  is  recommended. File scan requests are distributed
56       among the configured scan engines to achieve  load  balancing.  A  scan
57       engine  is identified by its engine_id. The engine_id is a user defined
58       string of up to 64 bytes.
59
60
61       The vscan service properties are  divided  into  two  categories:  scan
62       engine  properties, which are specific to a scan engine definition, and
63       general properties, which apply to the service and are not scan engine-
64       specific.
65

SUBCOMMANDS

67       vscanadm recognizes the following subcommands:
68
69       vscanadm set -p property=value [-p property=value]...
70
71           Sets the values of vscan service general properties.
72
73           -p property=value    Specifies a property value
74
75
76
77       vscanadm get [-p property]...
78
79           Displays  the  values  of  vscan  service general properties. If no
80           properties are specified, all vscan service general properties  are
81           displayed.
82
83           -p property    Specifies a property value
84
85
86
87
88       The  following  properties  are  available  for  the  vscanadm  set and
89       vscanadm get subcommands:
90
91       max-size           The maximum size  of  files  that  should  be  virus
92                          scanned.  Files  exceeding max-size are not scanned.
93                          The  max-size-action  property  determines   whether
94                          access  should  be  allowed  or denied to files that
95                          exceed max-size.
96
97                          The value of max-size is a  string  with  a  numeric
98                          (decimal) component and an optional letter component
99                          that  specifies  a  unit   size,   in   the   format
100                          "N[.N][KMGTP][B]".
101
102                          Following  the  numeric component, the optional unit
103                          can be specified as either one  or  two  characters.
104                          For example, either "K" or "KB" can be used to spec‐
105                          ify kilobytes. Unit specifiers are  not  case-sensi‐
106                          tive,  and must follow the numeric value immediately
107                          with no intervening whitespace.
108
109                          With either no unit specifier, or a  unit  specifier
110                          of  only  "B", the numeric value is assumed to be in
111                          bytes. The default value is 1GB.
112
113                          Note that while the vscan service defines a  maximum
114                          file  size for scanning, scan engines also typically
115                          define their own maximum file size  setting.  It  is
116                          recommended  that  max-size  be  set to a value less
117                          than or equal to the maximum file size for the  scan
118                          engine(s).
119
120
121       max-size-action    Specifies  whether  access will be allowed or denied
122                          to files larger than  max-size.  Files  larger  than
123                          max-size are not virus scanned. Valid values are:
124
125                          allow    allow  access to files larger than max-size
126                                   (no virus scan). This is the default value.
127
128
129                          deny     deny access to files larger  than  max-size
130                                   (no virus scan)
131
132
133
134       vscanadm import -p property filename
135
136           Imports  the  property value from the specified file. The file must
137           contain a single line specifying the value of a single property.
138
139
140       vscanadm export -p property filename
141
142           Exports the property value to the specified  file.  The  file  must
143           contain a single line specifying the value of a single property.
144
145
146       vscanadm validate -p property filename
147
148           Validates  the  property value in the specified file. The file must
149           contain a single line specifying the value of a single property.
150
151
152
153       The  following  properties  are  available  for  the  vscanadm  import,
154       vscanadm export, and vscanadm validate subcommands:
155
156       types    A  comma-separated list of file type extension matching rules.
157                This list defines which types of files are scanned  and  which
158                should  be excluded during virus scanning. Each rule comprises
159                the rule indicator [+|-], followed by a file type  expresssion
160                against  which  a  file's type extension is compared. The file
161                type expresssion is case insensitive and may include  the  "*"
162                and  "?"  wildcards. There should be no whitespace between the
163                rule indicator and the file type expresssion. If  a  comma  is
164                included  within  the file type expression, it must be escaped
165                using a "\"  (backslash).  A  file  type  extension  does  not
166                include its preceding dot.
167
168                The rule indicator is a single character and can be one of:
169
170                  + include file type in virus scanning
171                  - exclude file type from virus scanning
172
173
174                When  a file is being evaluated as a candidate for virus scan‐
175                ning, its file type will be compared with the rules defined in
176                types.  The first rule matched will be applied. If no match is
177                found, the file will be virus scanned. The total length of the
178                types string can not exceed 4096 bytes. The default content of
179                the types list is "+*".
180
181
182       vscanadm add-engine [-p property=value]... engine_id
183
184           Adds a new scan engine identified by engine_id. The default  values
185           are used for any scan engine properties that are not specified. The
186           hostname defaults to the engine_id.
187
188           -p property=value    Specifies a property value
189
190
191
192       vscanadm remove-engine engine_id
193
194           Remove scan engine identified by engine_id,  removing  all  of  its
195           configuration property values.
196
197
198       vscanadm set-engine -pproperty=value [-p property=value]... engine_id
199
200           Creates  or  updates the configuration property values for the scan
201           engine identified by engine_id.
202
203           -p property=value    Specifies a property value
204
205
206
207       vscanadm get-engine [-p property=value]... [engine_id]
208
209           Displays the values of the specified scan engine properties for the
210           scan  engine identified by engine_id. If no engine_id is specified,
211           this subcommand displays the specified scan engine property  values
212           for  all  configured  scan engines. If no properties are specified,
213           this subcommand displays all vscan service scan engine properties.
214
215           -p property=value    Specifies a property value
216
217
218
219
220       The following properties are available  for  the  vscanadm  add-engine,
221       vscanadm  remove-engine,  vscanadm  set-engine, and vscanadm get-engine
222       subcommands:
223
224       enable            Specifies whether the scan engine is enabled or  dis‐
225                         abled.  Valid  values  are  "on"  (enabled) and "off"
226                         (disabled). The default is  "on"  (enabled).  A  scan
227                         engine  cannot  be  enabled  if  its host property is
228                         invalid.
229
230
231       host              Hostname or  IPv4  format  IP  address  of  the  scan
232                         engine.
233
234
235       port              ICAP  port  number  of  the  scan engine. The numeric
236                         value ranges from 0 to 65535. The default  ICAP  port
237                         is 1344.
238
239
240       max-connection    The maximum number of concurrent connections that may
241                         be established with a scan engine. The numeric  value
242                         ranges from 1 to 512. This property defaults to 8.
243
244
245       vscanadm show          Displays the values of all vscan service general
246                              properties and scan engine properties.
247
248
249       vscanadm stats [-z]    Displays or resets the following  vscan  service
250                              statistics:
251
252                                  o      number of files scanned
253
254                                  o      number of infected files
255
256                                  o      number of failed scan requests
257
258                                  o      scan  errors  (including  a  per scan
259                                         engine error count)
260
261                              -z    Resets vscan service  statistics  counters
262                                    to zero
263
264
265

EXAMPLES

267       Example 1 Setting the Maximum Size Limit
268
269
270       To  set  the  maximum  size  limit for files to be virus scanned to 128
271       megabytes, enter
272
273
274         # vscanadm set -p max-size=128M
275
276
277
278       Example 2 Allowing Access to Files
279
280
281       To allow access to files exceeding the maximum file size, enter
282
283
284         # vscanadm set -p max-size-action=allow
285
286
287
288       Example 3 Setting File Types
289
290
291       To set the types so that only files of type "odt", "exe" and "jpg"  are
292       virus scanned, enter
293
294
295         # vscanadm set -p types=+odt,+exe,+jpg,-*
296
297
298
299
300       To set the types so that all file types except "doc" are virus scanned,
301       enter
302
303
304         # vscanadm set -p types=-doc,+*
305
306
307
308       Example 4 Displaying the File Types List
309
310
311       To display the file types list, enter
312
313
314         # vscanadm get -p types
315
316
317
318       Example 5 Adding the Scan Engine
319
320
321       To add the scan engine "my_eng" using the default values, enter
322
323
324         # vscanadm add-engine my_eng
325
326
327
328       Example 6 Disabling the Scan Engine
329
330
331       To disable the scan engine "my_eng", enter
332
333
334         # vscanadm set-engine -p enable=off my_eng
335
336
337
338       Example 7 Displaying Scan Engine Properties
339
340
341       To display the properties of the scan engine "my_eng", enter
342
343
344         # vscanadm get-engine my_eng
345
346
347
348       Example 8 Removing Scan Engine
349
350
351       To remove the scan engine "my_eng", enter
352
353
354         # vscanadm remove-engine my_eng
355
356
357
358       Example 9 Displaying Vscan Service General and Scan Engine Properties
359
360
361       To Display all vscan service general properties and scan engine proper‐
362       ties, enter
363
364
365         # vscanadm show
366
367
368

EXIT STATUS

370       The following exit values are returned:
371
372       0           Successful completion.
373
374
375       non-zero    An error occurred.
376
377

ATTRIBUTES

379       See attributes(5) for descriptions of the following attributes:
380
381
382
383
384       ┌─────────────────────────────┬─────────────────────────────┐
385       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
386       ├─────────────────────────────┼─────────────────────────────┤
387       │Availability                 │SUNWvscanu                   │
388       ├─────────────────────────────┼─────────────────────────────┤
389       │Interface Stability          │Uncommitted                  │
390       ├─────────────────────────────┼─────────────────────────────┤
391       │Utility output format        │Not-An-Interface             │
392       └─────────────────────────────┴─────────────────────────────┘
393

NOTES

398       All  users  are  permitted to use vscanadm to view vscan properties and
399       statistics. To set property values or reset statistics,  the  following
400       authorizations are required:
401
402       solaris.smf.value.vscan
403
404           change the property values or reset statistics
405
406
407       solaris.manage.vscan
408
409           refresh the service to apply property value changes
410
411
412
413       To  add  or remove properties (add-engine, remove-engine) the following
414       authorizations are required:
415
416       solaris.smf.modify.application
417
418           add or remove property group
419
420
421       solaris.manage.vscan
422
423           refresh the service to apply property value changes
424
425
426
427       All of these authorizations are included in the "VSCAN Management" pro‐
428       file.
429
430
431
432SunOS 5.11                        7 Jul 2009                      vscanadm(1M)