Module netapp_ontap.resources.vscan_event
Copyright © 2023 NetApp Inc. All rights reserved.
This file has been automatically generated based on the ONTAP REST API documentation.
Classes
class VscanEvent (*args, **kwargs)
-
Allows interaction with VscanEvent objects on the host
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 count_collection (*args, connection: HostConnection = None, **kwargs) -> int
-
Returns a count of all VscanEvent resources that match the provided query
This calls GET on the object to determine the number of records. It is more efficient than calling get_collection() because it will not construct any objects. Query parameters can be passed in as kwargs to determine a count of objects that match some filtered criteria.
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 count 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. These query parameters can affect the count. A return_records query param will be ignored.
Returns
On success, returns an integer count of the objects of this type. On failure, returns -1.
Raises
NetAppRestError
: If the API call returned a status code >= 400, or if there is no connection available to use either passed in or on the library. def find (*args, connection: HostConnection = None, **kwargs) -> Resource
-
Retrieves Vscan events, which are generated by the cluster to capture important events.
Related ONTAP commands
vserver vscan show-events
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, None will be returned. 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 or None if no matches were found.Raises
NetAppRestError
: If the API call returned more than 1 matching resource. def get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[Resource]
-
Retrieves Vscan events, which are generated by the cluster to capture important events.
Related ONTAP commands
vserver vscan show-events
Fetch a list of all objects of this type from the host.
This is a lazy fetch, making API calls only as necessary when the result of this call is iterated over. For instance, if max_records is set to 5, then iterating over the collection causes an API call to be sent to the server once for every 5 records. If the client stops iterating before getting to the 6th record, then no additional API calls are made.
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. This would be not be raised when get_collection() is called, but rather when the result is iterated.
Inherited members
class VscanEventSchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)
-
The fields of the VscanEvent object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.base.SchemaABC
Class variables
-
disconnect_reason: str GET
-
Specifies the reason of the Vscan server disconnection. The available values are:
- na Not applicable
- vscan_disabled Vscan disabled on the SVM
- no_data_lif SVM 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
- invalid_user Connection request by invalid user
- server_removed Server removed from the active scanner-pool
Valid choices:
- na
- vscan_disabled
- no_data_lif
- session_uninitialized
- remote_closed
- invalid_protocol_msg
- invalid_session_id
- inactive_connection
- invalid_user
- server_removed
-
event_time: ImpreciseDateTime GET POST PATCH
-
Specifies the Timestamp of the event.
Example: 2021-11-25T04:29:41.606+0000
-
file_path: str GET POST PATCH
-
Specifies the file for which event happened.
Example: /1
-
interface: IpInterface GET POST PATCH
-
The interface field of the vscan_event.
-
node: Node GET POST PATCH
-
The node field of the vscan_event.
-
server: str GET POST PATCH
-
Specifies the IP address of the Vscan server.
Example: 192.168.1.1
-
svm: Svm GET POST PATCH
-
The svm field of the vscan_event.
-
type: str GET POST PATCH
-
Specifies the event type.
Valid choices:
- scanner_connected
- scanner_disconnected
- scanner_updated
- scan_internal_error
- scan_failed
- scan_timedout
- file_infected
- file_renamed
- file_quarantined
- file_deleted
- scanner_busy
-
vendor: str GET POST PATCH
-
Specifies the scan-engine vendor.
Example: mighty master anti-evil scanner
-
version: str GET POST PATCH
-
Specifies the scan-engine version.
Example: 1.0