Module netapp_ontap.resources.vscan_on_demand
Copyright © 2019 NetApp Inc. All rights reserved.
Overview
Vscan On-Demand scanning is used to check files for viruses on a schedule. For example, it can be used to run scans only in off-peak hours, or to scan very large files that are excluded from an on-access scan. Vscan On-Demand scanning can be used for any path in the SVM namespace.
Vscan On-Demand policy configurations define the scope of a Vscan On-Demand scan. The schedule parameter in the On-Demand policy configuration decides when to execute the task. Schedule can be created using the /api/clusters/schedule endpoint and can be assigned on policy create or policy modify. This API is used to retrieve and manage Vscan On-Demand policy configurations. It is also used to schedule the Vscan On-Demand scan.Examples
Retrieving all fields for all policies of an SVM
# The API:
/api/protocols/vscan/{svm.uuid}/on_demand_policies/
# The call:
curl -X GET "https://<mgmt-ip>/api/protocols/vscan/{svm.uuid}/on_demand_policies?fields=*" -H "accept: application/hal+json"
# The response:
{
"records": [
{
"svm": {
"uuid": "86fbc414-f140-11e8-8e22-0050568e0945",
"name": "vs1",
"_links": {
"self": {
"href": "/api/svm/svms/86fbc414-f140-11e8-8e22-0050568e0945"
}
}
},
"name": "on-demand-policy1",
"scan_paths": [
"/vol1/",
"/vol2/cifs/"
],
"log_path": "/vol0/report_dir",
"schedule": {
"uuid": "f6d0843e-f159-11e8-8e22-0050568e0945",
"name": "schedule",
"_links": {
"self": {
"href": "/api/cluster/schedules/f6d0843e-f159-11e8-8e22-0050568e0945"
}
}
},
"scope": {
"max_file_size": 10737418240,
"exclude_paths": [
"/vol1/cold-files/",
"/vol1/cifs/names"
],
"include_extensions": [
"vmdk",
"mp*"
],
"exclude_extensions": [
"mp3",
"mp4"
],
"scan_without_extension": false
},
"_links": {
"self": {
"href": "/api/protocols/vscan/86fbc414-f140-11e8-8e22-0050568e0945/on_demand_policies/policy1"
}
}
},
{
"svm": {
"uuid": "86fbc414-f140-11e8-8e22-0050568e0945",
"name": "vs1",
"_links": {
"self": {
"href": "/api/svm/svms/86fbc414-f140-11e8-8e22-0050568e0945"
}
}
},
"name": "on-demand-policy2",
"scan_paths": [
"/vol1/",
"/vol2/cifs/"
],
"log_path": "/report",
"scope": {
"max_file_size": 10737418240,
"include_extensions": [
"mp*"
],
"scan_without_extension": true
},
"_links": {
"self": {
"href": "/api/protocols/vscan/86fbc414-f140-11e8-8e22-0050568e0945/on_demand_policies/policy2"
}
}
}
],
"num_records": 2,
"_links": {
"self": {
"href": "/api/protocols/vscan/86fbc414-f140-11e8-8e22-0050568e0945/on_demand_policies?fields=*"
}
}
}
Retrieving a specific On-Demand policy associated with a specified SVM
# The API:
/api/protocols/vscan/{svm.uuid}/on_demand_policies/{name}
# The call:
curl -X GET "https://<mgmt-ip>/api/protocols/vscan/86fbc414-f140-11e8-8e22-0050568e0945/on_demand_policies/on-demand-task" -H "accept: application/json"
# The response:
{
"svm": {
"uuid": "86fbc414-f140-11e8-8e22-0050568e0945",
"name": "vs1",
"_links": {
"self": {
"href": "/api/svm/svms/86fbc414-f140-11e8-8e22-0050568e0945"
}
}
},
"name": "on-demand-policy",
"scan_paths": [
"/vol1/cifs"
],
"log_path": "/report",
"scope": {
"max_file_size": 10737418240,
"include_extensions": [
"vmdk",
"mp*"
],
"scan_without_extension": true
},
"_links": {
"self": {
"href": "/api/protocols/vscan/86fbc414-f140-11e8-8e22-0050568e0945/on_demand_policies/policy2"
}
}
}
Creating a Vscan On-Demand policy
The Vscan On-Demand policy POST endpoint creates an On-Demand policy for the specified SVM. Specify the schedule parameter to schedule an On-Demand scan.
# The API:
/api/protocols/vscan/{svm.uuid}/on_demand_policies
# The call:
curl -X POST "https://<mgmt-ip>/api/protocols/vscan/86fbc414-f140-11e8-8e22-0050568e0945/on_demand_policies?return_records=true" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"log_path\": \"/vol0/report_dir\", \"name\": \"on-demand-policy\", \"scan_paths\": [ \"/vol1/\", \"/vol2/cifs/\" ], \"schedule\": { \"name\": \"weekly\", \"uuid\": \"1cd8a442-86d1-11e0-ae1c-123478563412\" }, \"scope\": { \"exclude_extensions\": [ \"mp3\" ], \"exclude_paths\": [ \"/vol/cold-files/\" ], \"include_extensions\": [ \"vmdk\", \"mp*\" ], \"max_file_size\": 1073741824, \"scan_without_extension\": true }}"
# The response:
{
"num_records": 1,
"records": [
{
"svm": {
"name": "vs1"
},
"name": "on-demand-policy",
"scan_paths": [
"/vol1/",
"/vol2/cifs/"
],
"log_path": "/vol0/report_dir",
"schedule": {
"name": "weekly"
},
"scope": {
"max_file_size": 1073741824,
"exclude_paths": [
"/vol/cold-files/"
],
"include_extensions": [
"vmdk",
"mp*"
],
"exclude_extensions": [
"mp3"
],
"scan_without_extension": true
}
}
]
}
Creating a Vscan On-Demand policy where a number of optional fields are not specified
# The API:
/api/protocols/vscan/{svm.uuid}/on_demand_policies
# The call:
curl -X POST "https://<mgmt-ip>/api/protocols/vscan/86fbc414-f140-11e8-8e22-0050568e0945/on_demand_policies?return_records=true" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"log_path\": \"/report\", \"name\": \"on-demand-policy\", \"scan_paths\": [ \"/vol1/cifs/\" ], \"scope\": { \"include_extensions\": [ \"mp*\" ], \"scan_without_extension\": true }}"
# The response:
{
"num_records": 1,
"records": [
{
"svm": {
"name": "vs1"
},
"name": "on-demand-policy",
"scan_paths": [
"vol1/cifs/"
],
"log_path": "/report",
"scope": {
"max_file_size": 10737418240,
"include_extensions": [
"vmdk",
"mp*"
],
"scan_without_extension": true
}
}
]
}
Updating a Vscan On-Demand policy
The policy being modified is identified by the UUID of the SVM and the policy name.
# The API:
/api/protocols/vscan/{svm.uuid}/on_demand_policies/{name}
# The call:
curl -X PATCH "https://<mgmt-ip>/api/protocols/vscan/86fbc414-f140-11e8-8e22-0050568e0945/on_demand_policies/on-demand-policy" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"schedule\": { \"name\": \"weekly\" }, \"scope\": { \"exclude_extensions\": [ \"mp3\" ], \"exclude_paths\": [ \"/vol/\" ], \"include_extensions\": [ \"vmdk\", \"mp3\" ], \"scan_without_extension\": true }}"
Deleting a Vscan On-Demand policy
The policy to be deleted is identified by the UUID of the SVM and the policy name.
# The API:
/api/protocols/vscan/{svm.uuid}/on_demand_policies/{name}
# The call:
curl -X DELETE "https://<mgmt-ip>/api/protocols/vscan/86fbc414-f140-11e8-8e22-0050568e0945/on_demand_policies/on-demand-policy" -H "accept: application/hal+json"
Classes
class VscanOnDemand (*args, **kwargs)
-
Use On-Demand scanning to check files for viruses on a schedule. An On-Demand policy defines the scope of an On-Demand scan.
Initialize the instance of the resource.
Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:
MyResource(name='foo').name == 'foo'
Args
*args
- Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
**kwargs
- each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.
Ancestors
Static methods
def delete_collection(*args, connection: HostConnection = None, **kwargs) -> NetAppResponse
-
Deletes the Vscan On-Demand configuration.
Related ONTAP commands
vserver vscan on-demand-task delete
Learn more
Delete all objects in a collection which match the given query.
All records on the host which match the query will be deleted.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to delete the collection of bars for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. **kwargs
- Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400 def find(*args, connection: HostConnection = None, **kwargs) -> Resource
-
Retrieves the Vscan On-Demand policy.
Related ONTAP commands
vserver vscan on-demand-task show
Learn more
Find an instance of an object on the host given a query.
The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found or if more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. **kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A
Resource
object containing the details of the object.Raises
NetAppRestError
: If the API call did not return exactly 1 matching resource. def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> typing.Iterable
-
Retrieves the Vscan On-Demand policy.
Related ONTAP commands
vserver vscan on-demand-task show
Learn more
Fetch a list of all objects of this type from the host.
Args
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. max_records
- The maximum number of records to return per call
**kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A list of
Resource
objectsRaises
NetAppRestError
: If there is no connection available to use either passed in or on the library. def patch_collection(body: dict, *args, connection: HostConnection = None, **kwargs) -> NetAppResponse
-
Updates the Vscan On-Demand policy configuration of an SVM. Use schedule name or schedule UUID to schedule an On-Demand scan.
Related ONTAP commands
vserver vscan on-demand-task modify
vserver vscan on-demand-task schedule
vserver vscan on-demand-task unschedule
Learn more
Patch all objects in a collection which match the given query.
All records on the host which match the query will be patched with the provided body.
Args
body
- A dictionary of name/value pairs to set on all matching members of the collection.
*args
- Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to patch the collection of bars for a particular foo, the foo.name value should be passed.
connection
- The
HostConnection
object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context. **kwargs
- Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400
Methods
def delete(self, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Deletes the Vscan On-Demand configuration.
Related ONTAP commands
vserver vscan on-demand-task delete
Learn more
Send a deletion request to the host for this object.
Args
poll
- If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
- If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
- If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400 def get(self, **kwargs) -> NetAppResponse
-
Retrieves the Vscan On-Demand configuration of an SVM.
Related ONTAP commands
vserver vscan on-demand-task show
Learn more
Fetch the details of the object from the host.
Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400 def patch(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Updates the Vscan On-Demand policy configuration of an SVM. Use schedule name or schedule UUID to schedule an On-Demand scan.
Related ONTAP commands
vserver vscan on-demand-task modify
vserver vscan on-demand-task schedule
vserver vscan on-demand-task unschedule
Learn more
Send the difference in the object's state to the host as a modification request.
Calculates the difference in the object's state since the last time we interacted with the host and sends this in the request body.
Args
hydrate
- If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
poll
- If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
- If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
- If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400 def post(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Creates a Vscan On-Demand policy. Created only on a data SVM. Important notes: * Only one policy can be scheduled at a time on an SVM. Use schedule name or schedule uuid to schedule an On-Demand policy. * Scanning must be enabled on the SVM before the policy is scheduled to run. * The exclude_extensions setting overrides the include_extensions setting. Set scan_without_extension to true to scan files without extensions.
Required properties
svm.uuid
- Existing SVM in which to create the Vscan On-Demand policy.name
- Name of the Vscan On-Demand policy. Maximum length is 256 characters.log_path
- Path from the Vserver root where the On-Demand policy report is created.scan_paths
- List of paths that need to be scanned.
Recommended optional properties
schedule
- Scan schedule. It is recommended to set the schedule property, as it dictates when to scan for viruses.
Default property values
If not specified in POST, the following default property values are assigned: *
include_extensions
- * *max_file_size
- 10737418240 *scan_without_extension
- trueRelated ONTAP commands
vserver vscan on-demand-task create
vserver vscan on-demand-task schedule
Learn more
Send this object to the host as a creation request.
Args
hydrate
- If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
poll
- If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
- If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
- If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs
- Any key/value pairs passed will be sent as query parameters to the host.
Returns
A
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400
Inherited members
class VscanOnDemandSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
-
The fields of the VscanOnDemand object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.schema.BaseSchema
- marshmallow.base.SchemaABC
Class variables
var log_path
-
The path from the Vserver root where the task report is created.
Example: /vol0/report_dir
var name
-
On-Demand task name
Example: task-1
var opts
var scan_paths
-
List of paths that need to be scanned.
Example: ["/vol1/","/vol2/cifs/"]
var schedule
-
The schedule field of the vscan_on_demand.
var scope
-
The scope field of the vscan_on_demand.