Module netapp_ontap.resources.fpolicy_policy

Copyright © 2022 NetApp Inc. All rights reserved.

Overview

The FPolicy policy acts as a container for different constituents of the FPolicy such as FPolicy events and the FPolicy engine. It also provides a platform for policy management functions, such as policy enabling and disabling. As part of FPolicy policy configuration, you can specifiy the name of policy, the SVM to which it belongs, the FPolicy events to monitor, the FPolicy engine to which the generated notifications are sent and the policy priority. FPolicy policy configuration also allows to you to configure the file access behaviour when the primary and secondary servers are down. Under such circumstances, if the "mandatory" field is set to true, file access is denied.
Each FPolicy policy is associated with a scope which allows you to restrain the scope of the policy to specified storage objects such as volume, shares and export or to a set of file extensions such as .txt, .jpeg. An FPolicy policy can be configured to send notifications, to the FPolicy server or for native file blocking which uses the file extension specified in the policy scope. An SVM can have multiple FPolicy policies which can be enabled or disabled independently of each other.

Examples

Creating an FPolicy policy

Use the following API to create an FPolicy policy configuration. Note that the return_records=true query parameter used to obtain the newly created entry in the response.


from netapp_ontap import HostConnection
from netapp_ontap.resources import FpolicyPolicy

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = FpolicyPolicy("a00fac5d-0164-11e9-b64a-0050568eeb34")
    resource.engine = {"name": "engine1"}
    resource.events = [{"name": "cifs"}, {"name": "nfs"}]
    resource.mandatory = True
    resource.name = "FPolicy_policy_0"
    resource.passthrough_read = True
    resource.privileged_user = "mydomain\testuser"
    resource.scope = {
        "exclude_export_policies": ["export_pol1"],
        "exclude_extension": ["txt", "png"],
        "exclude_shares": ["sh1"],
        "exclude_volumes": ["vol0"],
        "include_export_policies": ["export_pol10"],
        "include_extension": ["pdf"],
        "include_shares": ["sh2", "sh3"],
        "include_volumes": ["vol1", "vol2"],
    }
    resource.post(hydrate=True)
    print(resource)

FpolicyPolicy(
    {
        "passthrough_read": True,
        "scope": {
            "exclude_export_policies": ["export_pol1"],
            "include_export_policies": ["export_pol10"],
            "include_extension": ["pdf"],
            "include_volumes": ["vol1", "vol2"],
            "include_shares": ["sh2", "sh3"],
            "exclude_extension": ["txt", "png"],
            "exclude_volumes": ["vol0"],
            "exclude_shares": ["sh1"],
        },
        "events": [{"name": "cifs"}, {"name": "nfs"}],
        "mandatory": True,
        "engine": {"name": "engine1"},
        "name": "FPolicy_policy_0",
        "privileged_user": "mydomain\\testuser",
    }
)


Creating and enable an FPolicy policy


from netapp_ontap import HostConnection
from netapp_ontap.resources import FpolicyPolicy

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = FpolicyPolicy("a00fac5d-0164-11e9-b64a-0050568eeb34")
    resource.priority = 1
    resource.engine = {"name": "engine1"}
    resource.events = [{"name": "cifs"}, {"name": "nfs"}]
    resource.mandatory = True
    resource.name = "FPolicy_policy_on"
    resource.passthrough_read = False
    resource.scope = {
        "exclude_export_policies": ["export_pol1"],
        "exclude_extension": ["txt", "png"],
        "exclude_shares": ["sh1"],
        "exclude_volumes": ["vol0"],
        "include_export_policies": ["export_pol10"],
        "include_extension": ["pdf"],
        "include_shares": ["sh2", "sh3"],
        "include_volumes": ["vol1", "vol2"],
    }
    resource.post(hydrate=True)
    print(resource)

FpolicyPolicy(
    {
        "passthrough_read": True,
        "priority": 1,
        "scope": {
            "exclude_export_policies": ["export_pol1"],
            "include_export_policies": ["export_pol10"],
            "include_extension": ["pdf"],
            "include_volumes": ["vol1", "vol2"],
            "include_shares": ["sh2", "sh3"],
            "exclude_extension": ["txt", "png"],
            "exclude_volumes": ["vol0"],
            "exclude_shares": ["sh1"],
        },
        "events": [{"name": "cifs"}, {"name": "nfs"}],
        "mandatory": True,
        "engine": {"name": "engine1"},
        "name": "FPolicy_policy_0",
        "privileged_user": "mydomain\\testuser",
    }
)


Creating an FPolicy policy with the minimum required fields and a native engine


from netapp_ontap import HostConnection
from netapp_ontap.resources import FpolicyPolicy

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = FpolicyPolicy("a00fac5d-0164-11e9-b64a-0050568eeb34")
    resource.events = [{"name": "cifs"}, {"name": "nfs"}]
    resource.name = "pol_minimum_fields"
    resource.scope = {"include_volumes": ["vol1", "vol2"]}
    resource.post(hydrate=True)
    print(resource)

FpolicyPolicy(
    {
        "scope": {"include_volumes": ["vol1", "vol2"]},
        "events": [{"name": "cifs"}, {"name": "nfs"}],
        "name": "pol_minimum_fields",
    }
)


Retrieving all the FPolicy policy configurations for an SVM


from netapp_ontap import HostConnection
from netapp_ontap.resources import FpolicyPolicy

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(
        list(
            FpolicyPolicy.get_collection(
                "a00fac5d-0164-11e9-b64a-0050568eeb34", fields="*", return_timeout=15
            )
        )
    )

[
    FpolicyPolicy(
        {
            "passthrough_read": False,
            "enabled": False,
            "scope": {
                "exclude_export_policies": ["export_pol1"],
                "include_export_policies": ["export_pol10"],
                "include_extension": ["pdf"],
                "include_volumes": ["vol1", "vol2"],
                "include_shares": ["sh2", "sh3"],
                "exclude_extension": ["txt", "png"],
                "exclude_volumes": ["vol0"],
                "exclude_shares": ["sh1"],
            },
            "svm": {"uuid": "a00fac5d-0164-11e9-b64a-0050568eeb34"},
            "events": [{"name": "cifs"}, {"name": "nfs"}],
            "mandatory": True,
            "engine": {"name": "engine1"},
            "name": "pol0",
        }
    ),
    FpolicyPolicy(
        {
            "passthrough_read": False,
            "priority": 1,
            "enabled": True,
            "scope": {
                "exclude_export_policies": ["export_pol1"],
                "include_export_policies": ["export_pol10"],
                "include_extension": ["pdf"],
                "include_volumes": ["vol1", "vol2"],
                "include_shares": ["sh2", "sh3"],
                "exclude_extension": ["txt", "png"],
                "exclude_volumes": ["vol0"],
                "exclude_shares": ["sh1"],
            },
            "svm": {"uuid": "a00fac5d-0164-11e9-b64a-0050568eeb34"},
            "events": [{"name": "cifs"}, {"name": "nfs"}],
            "mandatory": True,
            "engine": {"name": "engine1"},
            "name": "FPolicy_policy_on",
        }
    ),
    FpolicyPolicy(
        {
            "passthrough_read": False,
            "enabled": False,
            "svm": {"uuid": "a00fac5d-0164-11e9-b64a-0050568eeb34"},
            "events": [{"name": "cluster"}],
            "mandatory": True,
            "engine": {"name": "native"},
            "name": "cluster_pol",
        }
    ),
    FpolicyPolicy(
        {
            "passthrough_read": False,
            "enabled": False,
            "scope": {"include_volumes": ["vol1", "vol2"]},
            "svm": {"uuid": "a00fac5d-0164-11e9-b64a-0050568eeb34"},
            "events": [{"name": "cifs"}, {"name": "nfs"}],
            "mandatory": True,
            "engine": {"name": "native"},
            "name": "pol_minimum_fields",
        }
    ),
]


Retrieving all of the FPolicy policy configurations for the FPolicy engine "engine1" for an SVM


from netapp_ontap import HostConnection
from netapp_ontap.resources import FpolicyPolicy

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(
        list(
            FpolicyPolicy.get_collection(
                "a00fac5d-0164-11e9-b64a-0050568eeb34",
                fields="*",
                return_timeout=15,
                **{"engine.name": "engine1"}
            )
        )
    )

[
    FpolicyPolicy(
        {
            "passthrough_read": False,
            "enabled": False,
            "scope": {
                "exclude_export_policies": ["export_pol1"],
                "include_export_policies": ["export_pol10"],
                "include_extension": ["pdf"],
                "exclude_extension": ["txt", "png"],
            },
            "svm": {"uuid": "a00fac5d-0164-11e9-b64a-0050568eeb34"},
            "events": [{"name": "cifs"}, {"name": "nfs"}],
            "mandatory": True,
            "engine": {"name": "engine1"},
            "name": "pol0",
        }
    ),
    FpolicyPolicy(
        {
            "passthrough_read": False,
            "priority": 1,
            "enabled": True,
            "scope": {
                "exclude_export_policies": ["export_pol1"],
                "include_export_policies": ["export_pol10"],
                "include_extension": ["pdf"],
                "include_volumes": ["vol1", "vol2"],
                "include_shares": ["sh2", "sh3"],
                "exclude_extension": ["txt", "png"],
                "exclude_volumes": ["vol0"],
                "exclude_shares": ["sh1"],
            },
            "svm": {"uuid": "a00fac5d-0164-11e9-b64a-0050568eeb34"},
            "events": [{"name": "cifs"}, {"name": "nfs"}],
            "mandatory": True,
            "engine": {"name": "engine1"},
            "name": "FPolicy_policy_on",
        }
    ),
]


Retrieving a particular FPolicy policy configuration for an SVM


from netapp_ontap import HostConnection
from netapp_ontap.resources import FpolicyPolicy

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = FpolicyPolicy("a00fac5d-0164-11e9-b64a-0050568eeb34", name="pol0")
    resource.get()
    print(resource)

FpolicyPolicy(
    {
        "passthrough_read": False,
        "enabled": False,
        "scope": {
            "exclude_export_policies": ["export_pol1"],
            "include_export_policies": ["export_pol10"],
            "include_extension": ["pdf"],
            "include_volumes": ["vol1", "vol2"],
            "include_shares": ["sh2", "sh3"],
            "exclude_extension": ["txt", "png"],
            "exclude_volumes": ["vol0"],
            "exclude_shares": ["sh1"],
        },
        "svm": {"uuid": "a00fac5d-0164-11e9-b64a-0050568eeb34"},
        "events": [{"name": "cifs"}, {"name": "nfs"}],
        "mandatory": True,
        "engine": {"name": "engine1"},
        "name": "pol0",
    }
)


Updating a particular FPolicy policy


from netapp_ontap import HostConnection
from netapp_ontap.resources import FpolicyPolicy

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = FpolicyPolicy("a00fac5d-0164-11e9-b64a-0050568eeb34", name="pol0")
    resource.engine = {"name": "native"}
    resource.events = [{"name": "cifs"}]
    resource.mandatory = False
    resource.scope = {"include_volumes": ["*"]}
    resource.patch()


Enabling a particular FPolicy policy


from netapp_ontap import HostConnection
from netapp_ontap.resources import FpolicyPolicy

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = FpolicyPolicy("a00fac5d-0164-11e9-b64a-0050568eeb34", name="pol0")
    resource.enabled = True
    resource.priority = 3
    resource.patch()


Disabling a particular FPolicy policy


from netapp_ontap import HostConnection
from netapp_ontap.resources import FpolicyPolicy

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = FpolicyPolicy("a00fac5d-0164-11e9-b64a-0050568eeb34", name="pol0")
    resource.enabled = True
    resource.patch()


Classes

class FpolicyPolicy (*args, **kwargs)

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

Fetch a count of all objects of this type from the host.

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 delete_collection(*args, records: Iterable[_ForwardRef('FpolicyPolicy')] = None, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse

Deletes a particular FPolicy policy configuration for a specified SVM. To delete a policy, you must first disable the policy.

  • fpolicy policy scope delete
  • fpolicy policy 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.
records
Can be provided in place of a query. If so, this list of objects will be deleted from the host.
body
The body of the delete request. This could be a Resource instance or a dictionary 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 be sent as query parameters to the host. Only resources matching this query will be deleted.

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 FPolicy policy configuration of an SVM. ONTAP allows the creation of a cluster level FPolicy policy that acts as a template for all the data SVMs belonging to the cluster. This cluster level FPolicy policy is also retrieved for the specified SVM.

  • fpolicy policy show
  • fpolicy policy scope 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, 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 the FPolicy policy configuration of an SVM. ONTAP allows the creation of a cluster level FPolicy policy that acts as a template for all the data SVMs belonging to the cluster. This cluster level FPolicy policy is also retrieved for the specified SVM.

  • fpolicy policy show
  • fpolicy policy scope show

Learn more


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 objects

Raises

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.

def patch_collection(body: dict, *args, records: Iterable[_ForwardRef('FpolicyPolicy')] = None, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse

Updates a particular FPolicy policy configuration for a specified SVM. PATCH can be used to enable or disable the policy. When enabling a policy, you must specify the policy priority. The policy priority of the policy is not required when disabling the policy. If the policy is enabled, the FPolicy policy engine cannot be modified.

  • fpolicy policy modify
  • fpolicy policy scope modify
  • fpolicy enable
  • fpolicy disable

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. The body argument will be ignored if records is provided.
*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.
records
Can be provided in place of a query. If so, this list of objects will be patched on the host.
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 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 post_collection(records: Iterable[_ForwardRef('FpolicyPolicy')], *args, hydrate: bool = False, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, connection: HostConnection = None, **kwargs) -> Union[List[FpolicyPolicy], NetAppResponse]

Creates an FPolicy policy configuration for the specified SVM. To create an FPolicy policy, you must specify the policy scope and the FPolicy events to be monitored.
Important notes: * A single policy can monitor multiple events. * An FPolicy engine is an optional field whose default value is set to native. A native engine can be used to simply block the file access based on the file extensions specified in the policy scope. * To enable a policy, the policy priority must be specified. If the priority is not specified, the policy is created but it is not enabled. * The "mandatory" field, if set to true, blocks the file access when the primary or secondary FPolicy servers are down.

Required properties

  • svm.uuid - Existing SVM in which to create the FPolicy policy.
  • events - Name of the events to monitior.
  • name - Name of the FPolicy policy.
  • scope - Scope of the policy. Can be limited to exports, volumes, shares or file extensions.
  • priority- Priority of the policy (ranging from 1 to 10).

Default property values

  • mandatory - true
  • engine - native
  • fpolicy policy scope create
  • fpolicy policy create
  • fpolicy enable

Learn more


Send this collection of objects to the host as a creation request.

Args

records
A list of Resource objects to send to the server to be created.
*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 create a bar for a particular foo, the foo.name value should be passed.
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 each object. When hydrate is set to True, poll must also be set to True.
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 be sent as query parameters to the host. Only resources matching this query will be patched.

Returns

A list of Resource objects matching the provided
type which have been created by the host and returned. This is _not_
 
the same list that was provided, so to continue using the object, you
 

should save this list. If poll is set to False, then a NetAppResponse object is returned instead.

Raises

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

Methods

def delete(self, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, **kwargs) -> NetAppResponse

Deletes a particular FPolicy policy configuration for a specified SVM. To delete a policy, you must first disable the policy.

  • fpolicy policy scope delete
  • fpolicy policy delete

Learn more


Send a deletion request to the host for this object.

Args

body
The body of the delete request. This could be a Resource instance or a dictionary 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 get(self, **kwargs) -> NetAppResponse

Retrieves a particular FPolicy policy configuration for a specified SVM. Cluster-level FPolicy policy configuration details cannot be retrieved for a data SVM.

  • fpolicy policy show
  • fpolicy policy scope show
  • fpolicy 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: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, **kwargs) -> NetAppResponse

Updates a particular FPolicy policy configuration for a specified SVM. PATCH can be used to enable or disable the policy. When enabling a policy, you must specify the policy priority. The policy priority of the policy is not required when disabling the policy. If the policy is enabled, the FPolicy policy engine cannot be modified.

  • fpolicy policy modify
  • fpolicy policy scope modify
  • fpolicy enable
  • fpolicy disable

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 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

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

Creates an FPolicy policy configuration for the specified SVM. To create an FPolicy policy, you must specify the policy scope and the FPolicy events to be monitored.
Important notes: * A single policy can monitor multiple events. * An FPolicy engine is an optional field whose default value is set to native. A native engine can be used to simply block the file access based on the file extensions specified in the policy scope. * To enable a policy, the policy priority must be specified. If the priority is not specified, the policy is created but it is not enabled. * The "mandatory" field, if set to true, blocks the file access when the primary or secondary FPolicy servers are down.

Required properties

  • svm.uuid - Existing SVM in which to create the FPolicy policy.
  • events - Name of the events to monitior.
  • name - Name of the FPolicy policy.
  • scope - Scope of the policy. Can be limited to exports, volumes, shares or file extensions.
  • priority- Priority of the policy (ranging from 1 to 10).

Default property values

  • mandatory - true
  • engine - native
  • fpolicy policy scope create
  • fpolicy policy create
  • fpolicy enable

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 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

class FpolicyPolicySchema (*, 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 FpolicyPolicy object

Ancestors

  • netapp_ontap.resource.ResourceSchema
  • marshmallow.schema.Schema
  • marshmallow.base.SchemaABC

Class variables

enabled GET PATCH

Specifies if the policy is enabled on the SVM or not. If no value is mentioned for this field but priority is set, then this policy will be enabled.

engine GET POST PATCH

The engine field of the fpolicy_policy.

events GET POST PATCH

The events field of the fpolicy_policy.

Example: ["event_nfs_close","event_open"]

mandatory GET POST PATCH

Specifies what action to take on a file access event in a case when all primary and secondary servers are down or no response is received from the FPolicy servers within a given timeout period. When this parameter is set to true, file access events will be denied under these circumstances.

name GET POST

Specifies the name of the policy.

Example: fp_policy_1

passthrough_read GET POST PATCH

Specifies whether passthrough-read should be allowed for FPolicy servers registered for the policy. Passthrough-read is a way to read data for offline files without restoring the files to primary storage. Offline files are files that have been moved to secondary storage.

priority GET POST PATCH

Specifies the priority that is assigned to this policy.

privileged_user GET POST PATCH

Specifies the privileged user name for accessing files on the cluster using a separate data channel with privileged access. The input for this field should be in "domain\username" format.

Example: mydomain\testuser

scope GET POST PATCH

The scope field of the fpolicy_policy.

svm GET POST PATCH

The svm field of the fpolicy_policy.