APIs in Category: vscan | Vserver API version 1.21

vscan-active-scanner-pool-get-iter vscan-connection-extended-stats-get-iter vscan-connection-status-all-get-iter vscan-on-access-policy-create vscan-on-access-policy-delete vscan-on-access-policy-get-iter vscan-on-access-policy-modify vscan-on-access-policy-status-modify vscan-reset vscan-scanner-pool-apply-policy vscan-scanner-pool-create vscan-scanner-pool-delete vscan-scanner-pool-get-iter vscan-scanner-pool-modify vscan-status-get-iter vscan-status-modify | This set of APIs allow configuring and managing Vscan on Data ONTAP Cluster-Mode environment. This includes the APIs to retrieve the connection-status and other diagnostic information of active Vscan servers.

NetApp Manage ONTAP

vscan-active-scanner-pool-get-iter | [top]

> Returns active scanner pool configuration of a vserver.

> Input Name | Range | Type | Description
> desired-attributes |  | vscan-active-scanner-pool-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | vscan-active-scanner-pool-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the vscan-active-scanner-pool object. All vscan-active-scanner-pool objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | vscan-active-scanner-pool-info[] optional | The list of attributes of vscan-active-scanner-pool objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more vscan-active-scanner-pool objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |

vscan-connection-extended-stats-get-iter | [top]

> Returns connection status.

> Input Name | Range | Type | Description
> desired-attributes |  | vscan-connection-extended-stats-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | vscan-connection-extended-stats-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the vscan-connection-extended-stats object. All vscan-connection-extended-stats objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | vscan-connection-extended-stats-info[] optional | The list of attributes of vscan-connection-extended-stats objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more vscan-connection-extended-stats objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> ENODENOTFOUND |  |
> E_SCANNER_POOL_NOT_FOUND |  |

vscan-connection-status-all-get-iter | [top]

> Returns connection status.

> Input Name | Range | Type | Description
> desired-attributes |  | vscan-connection-status-all-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | vscan-connection-status-all-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the vscan-connection-status-all object. All vscan-connection-status-all objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | vscan-connection-status-all-info[] optional | The list of attributes of vscan-connection-status-all objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more vscan-connection-status-all objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> ENODENOTFOUND |  |
> E_SCANNER_POOL_NOT_FOUND |  |

vscan-on-access-policy-create | [top]

> Create an On-Access policy.

> Input Name | Range | Type | Description
> file-ext-to-exclude |  | file-extension[] optional | File-Extensions for which On-Access scanning must not be performed.
> filters |  | vscan-on-access-policy-filter[] optional | Filters. Possible values: "scan_mandatory" - Enable mandatory scan, "scan_ro_volume" - Enable scans for read-only volume, "scan_execute_access" - Scan only files opened with execute-access (CIFS only)
> max-file-size |  | size optional | Max file-size (in bytes) allowed for scanning. The default value of 2147483648 (2GB) is taken if not provided at the time of creating a policy.
> paths-to-exclude |  | file-path[] optional | File-paths for which On-Access scanning must not be performed.
> policy-name |  | policy-name | Name of the policy.
> protocol |  | vscan-protocol | File-Access protocol to monitor for On-Access scanning. Possible values: "cifs" - CIFS Protocol
> return-record |  | boolean optional | If set to true, returns the vscan-on-access-policy on successful creation. Default: false
> Output Name | Range | Type | Description
> result |  | vscan-on-access-policy-info optional | The vscan-on-access-policy created (keys or the entire object if requested)

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EOPNOTSUPPORTED |  |
> E_VSERVER_TYPE_NOT_SUPPORTED |  |
> EVSERVERNOTFOUND |  |
> E_OA_POLICY_EXISTS |  |
> E_OA_POLICY_CANNOT_CREATE_MAX_LIMIT |  |

vscan-on-access-policy-delete | [top]

> Delete an On-Access policy.

> Input Name | Range | Type | Description
> policy-name |  | policy-name | Name of the policy.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> E_OA_POLICY_NOT_FOUND |  |
> EAPIPRIVILEGE |  |
> E_OA_POLICY_CANNOT_DELETE |  |
> ERESOURCEINUSE |  |

vscan-on-access-policy-get-iter | [top]

> Returns list of On-Access policies.

> Input Name | Range | Type | Description
> desired-attributes |  | vscan-on-access-policy-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | vscan-on-access-policy-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the vscan-on-access-policy object. All vscan-on-access-policy objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | vscan-on-access-policy-info[] optional | The list of attributes of vscan-on-access-policy objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more vscan-on-access-policy objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> E_OA_POLICY_NOT_FOUND |  |

vscan-on-access-policy-modify | [top]

> Modify an On-Access policy.

> Input Name | Range | Type | Description
> file-ext-to-exclude |  | file-extension[] optional | File-Extensions for which On-Access scanning must not be performed.
> filters |  | vscan-on-access-policy-filter[] optional | Filters. Possible values: "scan_mandatory" - Enable mandatory scan, "scan_ro_volume" - Enable scans for read-only volume, "scan_execute_access" - Scan only files opened with execute-access (CIFS only)
> max-file-size |  | size optional | Max file-size (in bytes) allowed for scanning. The default value of 2147483648 (2GB) is taken if not provided at the time of creating a policy.
> paths-to-exclude |  | file-path[] optional | File-paths for which On-Access scanning must not be performed.
> policy-name |  | policy-name | Name of the policy.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> E_OA_POLICY_NOT_FOUND |  |
> EAPIPRIVILEGE |  |

vscan-on-access-policy-status-modify | [top]

> Modify On-Access policy status.

> Input Name | Range | Type | Description
> policy-name |  | policy-name | Name of the policy.
> policy-status |  | boolean | Policy Status

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EOPNOTSUPPORTED |  |
> E_VSERVER_TYPE_NOT_SUPPORTED |  |
> EVSERVERNOTFOUND |  |
> E_OA_POLICY_NOT_FOUND |  |
> ERESOURCEINUSE |  |

vscan-reset | [top]

> Discard cached information of files that have been successfully scanned.

> Errno | Description
> EINTERNALERROR |  |
> EOPNOTSUPPORTED |  |
> E_VSERVER_TYPE_NOT_SUPPORTED |  |
> EVSERVERNOTFOUND |  |

vscan-scanner-pool-apply-policy | [top]

> Apply scanner-policy to a scanner pool.

> Input Name | Range | Type | Description
> scanner-policy |  | scanner-policy | Scanner Policy
> scanner-pool |  | scanner-pool | Name of the virus scanner pool.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EOPNOTSUPPORTED |  |
> E_VSERVER_TYPE_NOT_SUPPORTED |  |
> EVSERVERNOTFOUND |  |
> E_SCANNER_POOL_NOT_FOUND |  |
> E_ONLY_SCANNER_POOL_ACTIVE |  |

vscan-scanner-pool-create | [top]

> Create a virus scanner pool, which is used for validating and managing connections between clustered Data ONTAP and Vscan servers.

> Input Name | Range | Type | Description
> max-session-setup-retries | [0..2^32-1] | integer optional | Maximum number of consecutive session-setup attempts. The default value of 5 is taken if not provided while creating a scanner pool.
> privileged-users |  | privileged-user[] | List of privileged users.
> request-timeout | [0..2^32-1] | integer optional | Total request-service time-limit in seconds. The default value of 30 is taken if not provided while creating a scanner pool.
> return-record |  | boolean optional | If set to true, returns the vscan-scanner-pool on successful creation. Default: false
> scan-queue-timeout | [0..2^32-1] | integer optional | Scan-queue wait-time-limit in seconds. The default value of 20 is taken if not provided while creating a scanner pool.
> scanner-pool |  | scanner-pool | Name of the virus scanner pool.
> servers |  | ip-address[] | List of IP addresses of Vscan servers which are allowed to connect to clustered Data ONTAP.
> session-setup-timeout | [0..2^32-1] | integer optional | Total session-setup time-limit in seconds. The default value of 10 is taken if not provided while creating a scanner pool.
> session-teardown-timeout | [0..2^32-1] | integer optional | Total session-teardown time-limit in seconds. The default value of 10 is taken if not provided while creating a scanner pool.
> Output Name | Range | Type | Description
> result |  | vscan-scanner-pool-info optional | The vscan-scanner-pool created (keys or the entire object if requested)

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EOPNOTSUPPORTED |  |
> E_VSERVER_TYPE_NOT_SUPPORTED |  |
> EVSERVERNOTFOUND |  |
> E_SCANNER_POOL_EXISTS |  |
> E_SCANNER_POOL_CANNOT_CREATE_MAX_LIMIT |  |

vscan-scanner-pool-delete | [top]

> Delete a scanner pool.

> Input Name | Range | Type | Description
> scanner-pool |  | scanner-pool | Name of the virus scanner pool.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> E_SCANNER_POOL_NOT_FOUND |  |
> EAPIPRIVILEGE |  |
> E_ONLY_SCANNER_POOL_ACTIVE |  |
> ERESOURCEINUSE |  |

vscan-scanner-pool-get-iter | [top]

> Returns list of scanner pools. Scanner pool is a set of attributes which are used to validate and manage connections between clustered Data ONTAP and Vscan servers (virus scanners).

> Input Name | Range | Type | Description
> desired-attributes |  | vscan-scanner-pool-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | vscan-scanner-pool-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the vscan-scanner-pool object. All vscan-scanner-pool objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | vscan-scanner-pool-info[] optional | The list of attributes of vscan-scanner-pool objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more vscan-scanner-pool objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> E_SCANNER_POOL_NOT_FOUND |  |

vscan-scanner-pool-modify | [top]

> Modify a scanner pool.

> Input Name | Range | Type | Description
> max-session-setup-retries | [0..2^32-1] | integer optional | Maximum number of consecutive session-setup attempts. The default value of 5 is taken if not provided while creating a scanner pool.
> privileged-users |  | privileged-user[] optional | List of privileged users.
> request-timeout | [0..2^32-1] | integer optional | Total request-service time-limit in seconds. The default value of 30 is taken if not provided while creating a scanner pool.
> scan-queue-timeout | [0..2^32-1] | integer optional | Scan-queue wait-time-limit in seconds. The default value of 20 is taken if not provided while creating a scanner pool.
> scanner-pool |  | scanner-pool | Name of the virus scanner pool.
> servers |  | ip-address[] optional | List of IP addresses of Vscan servers which are allowed to connect to clustered Data ONTAP.
> session-setup-timeout | [0..2^32-1] | integer optional | Total session-setup time-limit in seconds. The default value of 10 is taken if not provided while creating a scanner pool.
> session-teardown-timeout | [0..2^32-1] | integer optional | Total session-teardown time-limit in seconds. The default value of 10 is taken if not provided while creating a scanner pool.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> E_SCANNER_POOL_NOT_FOUND |  |
> EAPIPRIVILEGE |  |

vscan-status-get-iter | [top]

> Returns Vscan status information.

> Input Name | Range | Type | Description
> desired-attributes |  | vscan-status-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | vscan-status-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the vscan-status object. All vscan-status objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | vscan-status-info[] optional | The list of attributes of vscan-status objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more vscan-status objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |

vscan-status-modify | [top]

> Modify Vscan status.

> Input Name | Range | Type | Description
> is-vscan-enabled |  | boolean | Vscan status. When true, Vscan feature is enabled for the Vserver.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EOPNOTSUPPORTED |  |
> E_VSERVER_TYPE_NOT_SUPPORTED |  |
> EVSERVERNOTFOUND |  |
> ECIFSERVERNOTFOUND |  |
> E_NO_SCANNER_POOL_ACTIVE |  |
> E_VSCAN_CAPABILITY_NOT_ENABLED |  |
> E_VSCAN_JOB_QUEUE_FAILED |  |
> E_VSCAN_JOB_DELETE_FAILED |  |

Element definition: file-extension | [top]

> File extension

> [none]

Element definition: file-path | [top]

> File path

> [none]

Element definition: ip-address | [top]

> IPv4 and IPv6 address

> [none]

Element definition: policy-name | [top]

> Policy name

> [none]

Element definition: privileged-user | [top]

> Privileged user

> [none]

Element definition: scanner-policy | [top]

> Policy applied to a Vscan scanner pool

> [none]

Element definition: scanner-pool | [top]

> Scanner pool is a set of attributes which are used to validate and manage connections between clustered ONTAP and Vscan servers (virus scanners).

> [none]

Element definition: size | [top]

> Size in bytes Range : [0..2^63-1].

> [none]

Element definition: vscan-active-scanner-pool-info | [top]

> Vscan active scanner pool information. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> max-session-setup-retries | [0..2^32-1] | integer optional | Maximum number of consecutive session-setup attempts. This is set to the max of max-session-setup-retries of all active scanner pools on a vserver. Attributes: non-creatable, non-modifiable
> privileged-users |  | privileged-user[] optional | List of privileged users for a vserver. Vscan server is given privileged access to the clustered Data ONTAP only if it uses one of these users. Attributes: non-creatable, non-modifiable
> request-timeout | [0..2^32-1] | integer optional | Total request-service time-limit in seconds. This is set to the max of the request-timeouts of all active scanner pools on a vserver. Attributes: non-creatable, non-modifiable
> scan-queue-timeout | [0..2^32-1] | integer optional | Scan-queue wait-time-limit in seconds. This is set to the max of the scan-queue-timeouts of all active scanner pools on a vserver. Attributes: non-creatable, non-modifiable
> scanner-pools |  | scanner-pool[] optional | List of active scanner pools on a vserver. Attributes: non-creatable, non-modifiable
> servers |  | ip-address[] optional | List of allowed Vscan servers IP for a vserver. A Vscan server is allowed to connect to the clustered Data ONTAP only if its IP is part of this list. Attributes: non-creatable, non-modifiable
> session-setup-timeout | [0..2^32-1] | integer optional | Total session-setup time-limit in seconds. This is set to the max of the session-setup-timeouts of all active scanner pools on a vserver. Attributes: non-creatable, non-modifiable
> session-teardown-timeout | [0..2^32-1] | integer optional | Total session-teardown time-limit in seconds. This is set to the max of the session-teardown-timeouts of all active scanner pools on a vserver. Attributes: non-creatable, non-modifiable
> vserver |  | string optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: vscan-connection-extended-stats-info | [top]

> Vscan connection extended statistics. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> extended-stats |  | string[] optional | Vscanner's extended statistics. Attributes: non-creatable, non-modifiable
> node |  | node-name optional | Cluster node to which this connection is applicable. Attributes: key, non-creatable, non-modifiable
> server |  | ip-address optional | IP of the Vscan server. Attributes: key, non-creatable, non-modifiable
> server-status |  | vscan-server-status optional | Status of the connection. Attributes: non-creatable, non-modifiable Possible values: "disconnected" - Disconnected, "disconnecting" - Disconnecting, "connecting" - Connecting, "connected" - Connected
> server-type |  | vscan-scanner-type optional | Server type. Attributes: non-creatable, non-modifiable Possible values: "primary" - Primary, "backup" - Backup
> vendor |  | string optional | Name of virus-scanner vendor. Attributes: non-creatable, non-modifiable
> version |  | string optional | Version of virus-scanner. Attributes: non-creatable, non-modifiable
> vserver |  | string optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: vscan-connection-status-all-info | [top]

> Vscan connection status information. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> connected-since |  | datetime optional | Time when Vscan server was connected. Attributes: non-creatable, non-modifiable
> disconnect-reason |  | vscan-disconnect-reason optional | Reason for disconnection. Attributes: non-creatable, non-modifiable Possible values: "na" - Not applicable, "vscan_disabled" - Vscan disabled on the vserver, "no_data_lif" - Vserver does not have data lif on the node, "session_uninitialized" - Session not initialized, "remote_closed" - Closure from Server, "invalid_protocol_msg" - Invalid protocol-message received, "invalid_session_id" - Invalid session-id received, "inactive_connection" - No activity on connection
> disconnected-since |  | datetime optional | Time when Vscan server was disconnected. Attributes: non-creatable, non-modifiable
> node |  | node-name optional | Cluster node to which this connection is applicable. Attributes: key, non-creatable, non-modifiable
> privileged-user |  | string optional | Privileged user, which is used for the connection between clustered Data ONTAP and the Vscan server. Attributes: non-creatable, non-modifiable
> server |  | ip-address optional | IP of the Vscan server. Attributes: key, non-creatable, non-modifiable
> server-status |  | vscan-server-status optional | Status of the connection. Attributes: non-creatable, non-modifiable Possible values: "disconnected" - Disconnected, "disconnecting" - Disconnecting, "connecting" - Connecting, "connected" - Connected
> server-type |  | vscan-scanner-type optional | Server type. Attributes: non-creatable, non-modifiable Possible values: "primary" - Primary, "backup" - Backup
> vendor |  | string optional | Name of virus-scanner vendor. Attributes: non-creatable, non-modifiable
> version |  | string optional | Version of virus-scanner. Attributes: non-creatable, non-modifiable
> vserver |  | string optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: vscan-on-access-policy-filter | [top]

> Filters to to define the scope of On-Access scanning more precisely. Possible values: "scan_mandatory" - Enable mandatory scan, "scan_ro_volume" - Enable scans for read-only volume, "scan_execute_access" - Scan only files opened with execute-access (CIFS only)

> [none]

Element definition: vscan-on-access-policy-info | [top]

> Vscan On-Access policy information. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> admin-owner |  | vscan-config-owner optional | Owner of the policy. Attributes: non-creatable, non-modifiable Possible values: "vserver" - Vserver Admin, "cluster" - Cluter Admin
> file-ext-to-exclude |  | file-extension[] optional | File-Extensions for which On-Access scanning must not be performed. Attributes: optional-for-create, modifiable
> filters |  | vscan-on-access-policy-filter[] optional | Filters. Attributes: optional-for-create, modifiable Possible values: "scan_mandatory" - Enable mandatory scan, "scan_ro_volume" - Enable scans for read-only volume, "scan_execute_access" - Scan only files opened with execute-access (CIFS only)
> is-policy-enabled |  | boolean optional | Policy status. Attributes: non-creatable, non-modifiable
> max-file-size |  | size optional | Max file-size (in bytes) allowed for scanning. The default value of 2147483648 (2GB) is taken if not provided at the time of creating a policy. Attributes: optional-for-create, modifiable
> paths-to-exclude |  | file-path[] optional | File-paths for which On-Access scanning must not be performed. Attributes: optional-for-create, modifiable
> policy-name |  | policy-name optional | Name of the policy. Attributes: key, required-for-create, non-modifiable
> protocol |  | vscan-protocol optional | File-Access protocol to monitor for On-Access scanning. Attributes: required-for-create, non-modifiable Possible values: "cifs" - CIFS Protocol
> vserver |  | string optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: vscan-protocol | [top]

> CIFS Possible values: "cifs" - CIFS Protocol

> [none]

Element definition: vscan-scanner-pool-info | [top]

> Vscan scanner pool information. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> admin-owner |  | vscan-config-owner optional | Owner of the scanner pool. Attributes: non-creatable, non-modifiable Possible values: "vserver" - Vserver Admin, "cluster" - Cluter Admin
> is-currently-active |  | boolean optional | Current status of a scanner pool. Attributes: non-creatable, non-modifiable
> max-session-setup-retries | [0..2^32-1] | integer optional | Maximum number of consecutive session-setup attempts. The default value of 5 is taken if not provided while creating a scanner pool. Attributes: optional-for-create, modifiable
> privileged-users |  | privileged-user[] optional | List of privileged users. Attributes: required-for-create, modifiable
> request-timeout | [0..2^32-1] | integer optional | Total request-service time-limit in seconds. The default value of 30 is taken if not provided while creating a scanner pool. Attributes: optional-for-create, modifiable
> scan-queue-timeout | [0..2^32-1] | integer optional | Scan-queue wait-time-limit in seconds. The default value of 20 is taken if not provided while creating a scanner pool. Attributes: optional-for-create, modifiable
> scanner-policy |  | scanner-policy optional | Scanner policy. Currently only system policies are supported. Possible values: 'primary' - Makes it active always, 'secondary' - Makes it active only when no primary Vscan server is connected, 'idle' - Makes it inactive always Attributes: non-creatable, non-modifiable
> scanner-pool |  | scanner-pool optional | Scanner pool is a set of attributes which are used to validate and manage connections between clustered Data ONTAP and Vscan servers (virus scanners). Attributes: key, required-for-create, non-modifiable
> servers |  | ip-address[] optional | List of IP addresses of Vscan servers which are allowed to connect to clustered Data ONTAP. Attributes: required-for-create, modifiable
> session-setup-timeout | [0..2^32-1] | integer optional | Total session-setup time-limit in seconds. The default value of 10 is taken if not provided while creating a scanner pool. Attributes: optional-for-create, modifiable
> session-teardown-timeout | [0..2^32-1] | integer optional | Total session-teardown time-limit in seconds. The default value of 10 is taken if not provided while creating a scanner pool. Attributes: optional-for-create, modifiable
> vserver |  | string optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: vscan-status-info | [top]

> Vscan status information. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> is-vscan-enabled |  | boolean optional | Vscan status. When true, Vscan feature is enabled for the Vserver. Attributes: non-creatable, non-modifiable
> vserver |  | string optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: datetime | [top]

> The number of seconds since January 1, 1970. Range : [0..2^31-1].

> [none]

Element definition: file-extension | [top]

> File extension

> [none]

Element definition: file-path | [top]

> File path

> [none]

Element definition: ip-address | [top]

> IPv4 and IPv6 address

> [none]

Element definition: node-name | [top]

> The node's name

> [none]

Element definition: policy-name | [top]

> Policy name

> [none]

Element definition: privileged-user | [top]

> Privileged user

> [none]

Element definition: scanner-policy | [top]

> Policy applied to a Vscan scanner pool

> [none]

Element definition: scanner-pool | [top]

> Scanner pool is a set of attributes which are used to validate and manage connections between clustered ONTAP and Vscan servers (virus scanners).

> [none]

Element definition: size | [top]

> Size in bytes Range : [0..2^63-1].

> [none]

Element definition: vscan-config-owner | [top]

> Configuration owner Possible values: "vserver" - Vserver Admin, "cluster" - Cluter Admin

> [none]

Element definition: vscan-disconnect-reason | [top]

> reason Possible values: "na" - Not applicable, "vscan_disabled" - Vscan disabled on the vserver, "no_data_lif" - Vserver does not have data lif on the node, "session_uninitialized" - Session not initialized, "remote_closed" - Closure from Server, "invalid_protocol_msg" - Invalid protocol-message received, "invalid_session_id" - Invalid session-id received, "inactive_connection" - No activity on connection

> [none]

Element definition: vscan-on-access-policy-filter | [top]

> Filters to to define the scope of On-Access scanning more precisely. Possible values: "scan_mandatory" - Enable mandatory scan, "scan_ro_volume" - Enable scans for read-only volume, "scan_execute_access" - Scan only files opened with execute-access (CIFS only)

> [none]

Element definition: vscan-scanner-type | [top]

> Server type Possible values: "primary" - Primary, "backup" - Backup

> [none]

Element definition: vscan-server-status | [top]

> Status Possible values: "disconnected" - Disconnected, "disconnecting" - Disconnecting, "connecting" - Connecting, "connected" - Connected

> [none]