Module `netapp_ontap.resources.anti_ransomware_auto_enable`

This file has been automatically generated based on the ONTAP REST API documentation.

Overview

This API provides details about the anti-ransomware auto enablement status including information about warm-up periods and auto settings.

from netapp_ontap import HostConnection
from netapp_ontap.resources import AntiRansomwareAutoEnable

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = AntiRansomwareAutoEnable()
    resource.get()
    print(resource)

Try it out

AntiRansomwareAutoEnable(
    {
        "_links": {"self": {"href": "/security/anti-ransomware/auto-enable"}},
        "warm_up_period_completed": False,
        "new_volume_auto_enable": True,
        "warm_up_period_applicable": True,
    }
)

Classes

class AntiRansomwareAutoEnable (*args, **kwargs)

Allows interaction with AntiRansomwareAutoEnable 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

Resource

Methods

def get (self, **kwargs) -> NetAppResponse

Retrieves the current anti-ransomware auto enablement values, including details about warm-up period and auto enablement setting for new and existing volumes.

Learn more

DOC /security/anti-ransomware/auto-enable

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 or if not all of the keys required are present and config.STRICT_GET has been set to True.

def patch (self, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse

API to modify the anti-ransomware auto enablement setting.

Learn more

DOC /security/anti-ransomware/auto-enable

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.
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 normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

Inherited members

Resource:
- from_dict
- get_collection_url
- get_connection
- instance_location
- path_keys
- poll
- set_connection
- to_dict
- validate_schema

class AntiRansomwareAutoEnableSchema (*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool | None = None, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)

The fields of the AntiRansomwareAutoEnable object

Ancestors

netapp_ontap.resource.ResourceSchema
marshmallow.schema.Schema
marshmallow.base.SchemaABC
abc.ABC

Class variables

links: SelfLink GET: The links field of the anti_ransomware_auto_enable.
new_volume_auto_enable: bool GET PATCH: Auto Anti-Ransomware Protection (ARP) setting for new volumes.
warm_up_period_applicable: bool GET: Indicates if the warm-up period is applicable.
warm_up_period_completed: bool GET: Indicates if warm-up period has completed.
warm_up_period_remaining_duration: str GET: Time remaining for warm-up period completion.
warm_up_period_total_duration: str GET PATCH: Duration of warm-up period.