APIs in Category: fpolicy | Vserver API version 1.20

fpolicy-disable-policy fpolicy-enable-policy fpolicy-policy-create fpolicy-policy-delete fpolicy-policy-event-create fpolicy-policy-event-delete fpolicy-policy-event-get-iter fpolicy-policy-event-modify fpolicy-policy-external-engine-create fpolicy-policy-external-engine-delete fpolicy-policy-external-engine-get-iter fpolicy-policy-external-engine-modify fpolicy-policy-get-iter fpolicy-policy-modify fpolicy-policy-scope-create fpolicy-policy-scope-delete fpolicy-policy-scope-get-iter fpolicy-policy-scope-modify fpolicy-policy-status-get-iter fpolicy-server-connect fpolicy-server-disconnect fpolicy-server-status-get-iter | This set of APIs enables programmatic control of policy life cycle including: creation, enablement, configuration, monitoring, and deletion. Also, it includes commands for server monitoring and control, as well as notification filtering based on file extension. FPolicy APIs provided for Data ONTAP Clustered-Mode environment enables in creating/modifying/deleting/retrieving following FPolicy entities: 1. Event: This collectively specifies the protocols, fileops, for which notification is generated. 2. Scope: This specifies the scope on which FPolicy will be working on. A scope can be on a volume, share, or a export policy. Scope also contains the file extensions. 3. External-Engine: This specifies the attributes required for a notification to be sent to external FPolicy servers. 4. Policy: Once an event and external engine is created, it can be attached to a policy. A scope has to be defined for a policy before it is enabled to run.

NetApp Manage ONTAP

fpolicy-disable-policy | [top]

> Disables a specific named policy.

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

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> ELOWMEMORY |  |
> EPOLICYNOTFOUND |  |

> Vfiler-enabled
> Yes

fpolicy-enable-policy | [top]

> Enables a specific named policy. The operation will fail if the policy doesn't exist.

> Input Name | Range | Type | Description
> policy-name |  | string | Name of the policy.
> sequence-number |  | integer | Policy Sequence Number

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> ELOWMEMORY |  |
> EPOLICYNOTFOUND |  |

> Vfiler-enabled
> Yes

fpolicy-policy-create | [top]

> Create a policy.

> Input Name | Range | Type | Description
> allow-privileged-access |  | boolean optional | Indicator if privileged access should be given to FPolicy servers registered for the policy. Default Value is no.
> engine-name |  | engine-name | Name of the Engine. Default Engine is 'native'.
> events |  | event-name[] | Events for file access monitoring.
> is-mandatory |  | boolean optional | Indicator if the screening with this policy is required, i.e. it will fail if no servers are able process the notification registered as a part of external engine. If set to true, the request will fail if there is no server to evaluate it. If it's false, the request will succeed. Default value is true.
> policy-name |  | policy-name | Name of the policy.
> privileged-user-name |  | string optional | User name for privileged access. No default value is set for this attribute.
> return-record |  | boolean optional | If set to true, returns the fpolicy-policy on successful creation. Default: false
> Output Name | Range | Type | Description
> result |  | fpolicy-policy-info optional | The fpolicy-policy created (keys or the entire object if requested)

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> EPOLICYEXISTS |  |
> EEVENTNOTFOUND |  |
> EENGINENOTFOUND |  |

fpolicy-policy-delete | [top]

> Delete a policy.

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

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

fpolicy-policy-event-create | [top]

> Create FPolicy Event.

> Input Name | Range | Type | Description
> event-name |  | event-name | Name of the Event.
> file-operations |  | fpolicy-operation[] optional | Name of file operations. By default no operations are monitored. Possible values: "close" - File close operation, "create" - File create operation, "create_dir" - File create directory operation, "delete" - File delete operation, "delete_dir" - Directory delete operation, "getattr" - Get attribute operation, "link" - Link operation, "lookup" - Lookup operation, "open" - File open operation, "read" - File read operation, "write" - File write operation, "rename" - File rename operation, "rename_dir" - Directory rename operation, "setattr" - Set attribute operation, "symlink" - Symbolic link operation
> filter-string |  | fpolicy-filter[] optional | Name of filters. It is notification filtering parameters. By default no filters are selected. Possible values: "monitor_ads" - Monitor alternate data stream, "close_with_modification" - Filter close with modification, "close_without_modification" - Filter close without modification, "first_read" - Filter first read, "first_write" - Filter first write, "offline_bit" - Filter offline bit set, "open_with_delete_intent" - Filter open with delete intent, "open_with_write_intent" - Filter open with write intent, "write_with_size_change" - Filter write with size change
> protocol |  | fpolicy-proto optional | Name of protocol for which event is created. By default no protocol is selected. Possible values: "cifs" - CIFS protocol, "nfsv3" - NFSv3 protocol, "nfsv4" - NFSv4 protocol
> return-record |  | boolean optional | If set to true, returns the fpolicy-policy-event on successful creation. Default: false
> volume-operation |  | boolean optional | Indicator if the volume operation required for the event.Default Value is false.
> Output Name | Range | Type | Description
> result |  | fpolicy-event-options-config optional | The fpolicy-policy-event created (keys or the entire object if requested)

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

fpolicy-policy-event-delete | [top]

> Delete FPolicy event.

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

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

fpolicy-policy-event-get-iter | [top]

> Get a list of rows for FPolicy event options. FPolicy event is consist of protocol, file operations, vo lume operation and filters.

> Input Name | Range | Type | Description
> desired-attributes |  | fpolicy-event-options-config 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 |  | fpolicy-event-options-config optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the fpolicy-policy-event object. All fpolicy-policy-event 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 |  | fpolicy-event-options-config[] optional | The list of attributes of fpolicy-policy-event objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more fpolicy-policy-event objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

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

fpolicy-policy-event-modify | [top]

> Set FPolicy event options. FPolicy event is consist of protocol, file operation, volume operation and f ilters.

> Input Name | Range | Type | Description
> event-name |  | event-name | Name of the Event.
> file-operations |  | fpolicy-operation[] optional | Name of file operations. By default no operations are monitored. Possible values: "close" - File close operation, "create" - File create operation, "create_dir" - File create directory operation, "delete" - File delete operation, "delete_dir" - Directory delete operation, "getattr" - Get attribute operation, "link" - Link operation, "lookup" - Lookup operation, "open" - File open operation, "read" - File read operation, "write" - File write operation, "rename" - File rename operation, "rename_dir" - Directory rename operation, "setattr" - Set attribute operation, "symlink" - Symbolic link operation
> filter-string |  | fpolicy-filter[] optional | Name of filters. It is notification filtering parameters. By default no filters are selected. Possible values: "monitor_ads" - Monitor alternate data stream, "close_with_modification" - Filter close with modification, "close_without_modification" - Filter close without modification, "first_read" - Filter first read, "first_write" - Filter first write, "offline_bit" - Filter offline bit set, "open_with_delete_intent" - Filter open with delete intent, "open_with_write_intent" - Filter open with write intent, "write_with_size_change" - Filter write with size change
> protocol |  | fpolicy-proto optional | Name of protocol for which event is created. By default no protocol is selected. Possible values: "cifs" - CIFS protocol, "nfsv3" - NFSv3 protocol, "nfsv4" - NFSv4 protocol
> volume-operation |  | boolean optional | Indicator if the volume operation required for the event.Default Value is false.

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

fpolicy-policy-external-engine-create | [top]

> Create an external engine.

> Input Name | Range | Type | Description
> certificate-ca |  | string optional | Certificate authority name. No default value is set for this field.
> certificate-common-name |  | common-name optional | FQDN or custom common name of certificate. No default value is set for this field.
> certificate-serial |  | string optional | Serial number of certificate. No default value is set for this field.
> engine-name |  | engine-name | Name of the external engine.
> extern-engine-type |  | external-engine-type optional | External engine type. If the engine is asynchronous, no reply is sent from FPolicy servers. Default value set for this field is synchronous. Possible values: "synchronous" - Synchronous External Engine, "asynchronous" - Asynchronous External Engine
> keep-alive-interval | [0..2^32-1] | integer optional | Interval time in seconds for storage appliance to send keep-alive message to FPolicy server. Default value set for this field is 10 seconds.
> max-connection-retries | [0..2^32-1] | integer optional | Number of times storage appliance will attempt to establish a broken connection to FPolicy server. Default value set for this field is 5.
> max-server-requests | [0..2^32-1] | integer optional | Maximum number of outstanding screen requests that will be queued for an FPolicy Server. Default value set for this field is 50.
> port-number | [1..65535] | integer | Port number of the FPolicy server application.
> primary-servers |  | ip-address[] | Primary FPolicy servers.
> request-abort-timeout | [0..2^32-1] | integer optional | Timeout in seconds for a screen request to be aborted by storage appliance. Default value set for this field is 40 seconds.
> request-cancel-timeout | [0..2^32-1] | integer optional | Timeout in seconds for a screen request to be processed by an FPolicy server. Default value set for this field is 20 seconds.
> return-record |  | boolean optional | If set to true, returns the fpolicy-policy-external-engine on successful creation. Default: false
> secondary-servers |  | ip-address[] optional | Secondary FPolicy servers. No default value is set for this field.
> server-progress-timeout | [0..2^32-1] | integer optional | Timeout in seconds in which a throttled FPolicy server must complete at least one screen request. If no request is processed within the timeout, connection to FPolicy server is terminated. Default value set for this field is 60 seconds.
> ssl-option |  | fpolicy-ssl-opts | SSL option for external communication. No default value is set for this field. Possible values: "no_auth" - Communication over TCP, "server_auth" - Authentication of FPolicy server only, "mutual_auth" - Mutual authentication of storage system and FPolicy server
> status-request-interval | [0..2^32-1] | integer optional | Interval time in seconds for storage appliance to query status request from FPolicy server. Default value set for this field is 10 seconds.
> Output Name | Range | Type | Description
> result |  | fpolicy-external-engine-info optional | The fpolicy-policy-external-engine created (keys or the entire object if requested)

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

fpolicy-policy-external-engine-delete | [top]

> Delete an external engine.

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

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> EENGINENOTFOUND |  |
> EPOLICYNOTFOUND |  |
> ERESOURCEINUSE |  |

fpolicy-policy-external-engine-get-iter | [top]

> Returns information on external engines.

> Input Name | Range | Type | Description
> desired-attributes |  | fpolicy-external-engine-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 |  | fpolicy-external-engine-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the fpolicy-policy-external-engine object. All fpolicy-policy-external-engine 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 |  | fpolicy-external-engine-info[] optional | The list of attributes of fpolicy-policy-external-engine objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more fpolicy-policy-external-engine objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

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

fpolicy-policy-external-engine-modify | [top]

> Modify an engine.

> Input Name | Range | Type | Description
> certificate-ca |  | string optional | Certificate authority name. No default value is set for this field.
> certificate-common-name |  | common-name optional | FQDN or custom common name of certificate. No default value is set for this field.
> certificate-serial |  | string optional | Serial number of certificate. No default value is set for this field.
> engine-name |  | engine-name | Name of the external engine.
> extern-engine-type |  | external-engine-type optional | External engine type. If the engine is asynchronous, no reply is sent from FPolicy servers. Default value set for this field is synchronous. Possible values: "synchronous" - Synchronous External Engine, "asynchronous" - Asynchronous External Engine
> keep-alive-interval | [0..2^32-1] | integer optional | Interval time in seconds for storage appliance to send keep-alive message to FPolicy server. Default value set for this field is 10 seconds.
> max-connection-retries | [0..2^32-1] | integer optional | Number of times storage appliance will attempt to establish a broken connection to FPolicy server. Default value set for this field is 5.
> max-server-requests | [0..2^32-1] | integer optional | Maximum number of outstanding screen requests that will be queued for an FPolicy Server. Default value set for this field is 50.
> port-number | [1..65535] | integer optional | Port number of the FPolicy server application.
> primary-servers |  | ip-address[] optional | Primary FPolicy servers.
> request-abort-timeout | [0..2^32-1] | integer optional | Timeout in seconds for a screen request to be aborted by storage appliance. Default value set for this field is 40 seconds.
> request-cancel-timeout | [0..2^32-1] | integer optional | Timeout in seconds for a screen request to be processed by an FPolicy server. Default value set for this field is 20 seconds.
> secondary-servers |  | ip-address[] optional | Secondary FPolicy servers. No default value is set for this field.
> server-progress-timeout | [0..2^32-1] | integer optional | Timeout in seconds in which a throttled FPolicy server must complete at least one screen request. If no request is processed within the timeout, connection to FPolicy server is terminated. Default value set for this field is 60 seconds.
> ssl-option |  | fpolicy-ssl-opts optional | SSL option for external communication. No default value is set for this field. Possible values: "no_auth" - Communication over TCP, "server_auth" - Authentication of FPolicy server only, "mutual_auth" - Mutual authentication of storage system and FPolicy server
> status-request-interval | [0..2^32-1] | integer optional | Interval time in seconds for storage appliance to query status request from FPolicy server. Default value set for this field is 10 seconds.

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

fpolicy-policy-get-iter | [top]

> Returns information about policies.

> Input Name | Range | Type | Description
> desired-attributes |  | fpolicy-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 |  | fpolicy-policy-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the fpolicy-policy object. All fpolicy-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 |  | fpolicy-policy-info[] optional | The list of attributes of fpolicy-policy objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more fpolicy-policy objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

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

fpolicy-policy-modify | [top]

> Modify a policy.

> Input Name | Range | Type | Description
> allow-privileged-access |  | boolean optional | Indicator if privileged access should be given to FPolicy servers registered for the policy. Default Value is no.
> engine-name |  | engine-name optional | Name of the Engine. Default Engine is 'native'.
> events |  | event-name[] optional | Events for file access monitoring.
> is-mandatory |  | boolean optional | Indicator if the screening with this policy is required, i.e. it will fail if no servers are able process the notification registered as a part of external engine. If set to true, the request will fail if there is no server to evaluate it. If it's false, the request will succeed. Default value is true.
> policy-name |  | policy-name | Name of the policy.
> privileged-user-name |  | string optional | User name for privileged access. No default value is set for this attribute.

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

fpolicy-policy-scope-create | [top]

> Set FPolicy scope options. FPolicy Scope is consist of share, volume, export policy, volume, file extention.

> Input Name | Range | Type | Description
> check-extensions-on-directories |  | boolean optional | Indicates whether directory names are also subjected to extensions check, similar to file names. By default, the value is false.
> export-policies-to-exclude |  | string[] optional | Export Policies to exclude for file access monitoring. By default no export policy is selected.
> export-policies-to-include |  | string[] optional | Export policies to include for file access monitoring. By default no export policy is selected.
> file-extensions-to-exclude |  | string[] optional | File extensions excluded for screening. By default no file extension is selected.
> file-extensions-to-include |  | string[] optional | File extensions included for screening. By default no file extension is selected.
> policy-name |  | policy-name | Name of the policy.
> return-record |  | boolean optional | If set to true, returns the fpolicy-policy-scope on successful creation. Default: false
> shares-to-exclude |  | string[] optional | Shares to exclude for file access monitoring. By default no share is selected.
> shares-to-include |  | string[] optional | Shares to include for file access monitoring. By default no share is selected.
> volumes-to-exclude |  | string[] optional | Volumes that are inactive for the file policy. The list can include items which are regular expressions, such as 'vol*' or 'user?'. Note that if a policy has both an exclude list and an include list, the include list is ignored by the filer when processing user requests. By default no volume is selected.
> volumes-to-include |  | string[] optional | Volumes that are active for the file policy. The list can include items which are regular expressions, such as 'vol*' or 'user?'. By default no volume is selected.
> Output Name | Range | Type | Description
> result |  | fpolicy-scope-config optional | The fpolicy-policy-scope created (keys or the entire object if requested)

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

fpolicy-policy-scope-delete | [top]

> Delete a scope.

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

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

fpolicy-policy-scope-get-iter | [top]

> Get a list of rows for FPolicy scope options. FPolicy Scope consists of share, volume, export policy, volume, file extention.

> Input Name | Range | Type | Description
> desired-attributes |  | fpolicy-scope-config 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 |  | fpolicy-scope-config optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the fpolicy-policy-scope object. All fpolicy-policy-scope 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 |  | fpolicy-scope-config[] optional | The list of attributes of fpolicy-policy-scope objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more fpolicy-policy-scope objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

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

fpolicy-policy-scope-modify | [top]

> Set FPolicy scope options. FPolicy Scope is consist of share, volume, export policy, volume, file extention.

> Input Name | Range | Type | Description
> check-extensions-on-directories |  | boolean optional | Indicates whether directory names are also subjected to extensions check, similar to file names. By default, the value is false.
> export-policies-to-exclude |  | string[] optional | Export Policies to exclude for file access monitoring. By default no export policy is selected.
> export-policies-to-include |  | string[] optional | Export policies to include for file access monitoring. By default no export policy is selected.
> file-extensions-to-exclude |  | string[] optional | File extensions excluded for screening. By default no file extension is selected.
> file-extensions-to-include |  | string[] optional | File extensions included for screening. By default no file extension is selected.
> policy-name |  | policy-name | Name of the policy.
> shares-to-exclude |  | string[] optional | Shares to exclude for file access monitoring. By default no share is selected.
> shares-to-include |  | string[] optional | Shares to include for file access monitoring. By default no share is selected.
> volumes-to-exclude |  | string[] optional | Volumes that are inactive for the file policy. The list can include items which are regular expressions, such as 'vol*' or 'user?'. Note that if a policy has both an exclude list and an include list, the include list is ignored by the filer when processing user requests. By default no volume is selected.
> volumes-to-include |  | string[] optional | Volumes that are active for the file policy. The list can include items which are regular expressions, such as 'vol*' or 'user?'. By default no volume is selected.

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

fpolicy-policy-status-get-iter | [top]

> Returns FPolicy policy status information.

> Input Name | Range | Type | Description
> desired-attributes |  | fpolicy-policy-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 |  | fpolicy-policy-status-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the fpolicy-policy-status object. All fpolicy-policy-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 |  | fpolicy-policy-status-info[] optional | The list of attributes of fpolicy-policy-status objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more fpolicy-policy-status objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

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

fpolicy-server-connect | [top]

> Make a connection to FPolicy server

> Input Name | Range | Type | Description
> node |  | string | Cluster node name.
> policy-name |  | policy-name | Name of the policy.
> server |  | ip-address | FPolicy server.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> EPOLICYNOTFOUND |  |
> ESERVERNOTFOUND |  |

fpolicy-server-disconnect | [top]

> Terminate connection to FPolicy server

> Input Name | Range | Type | Description
> node |  | string | Cluster node name.
> policy-name |  | policy-name | Name of the policy.
> server |  | ip-address | FPolicy server.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> EPOLICYNOTFOUND |  |
> ESERVERNOTFOUND |  |

fpolicy-server-status-get-iter | [top]

> Returns FPolicy server status information.

> Input Name | Range | Type | Description
> desired-attributes |  | fpolicy-server-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 |  | fpolicy-server-status-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the fpolicy-server-status object. All fpolicy-server-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 |  | fpolicy-server-status-info[] optional | The list of attributes of fpolicy-server-status objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more fpolicy-server-status objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVSERVERNOTFOUND |  |
> ESERVERNOTFOUND |  |
> ENODENOTFOUND |  |
> EPOLICYNOTFOUND |  |

Element definition: common-name | [top]

> Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).

> [none]

Element definition: engine-name | [top]

> Engine name

> [none]

Element definition: event-name | [top]

> Event name

> [none]

Element definition: external-engine-type | [top]

> External Engine Type Possible values: "synchronous" - Synchronous External Engine, "asynchronous" - Asynchronous External Engine

> [none]

Element definition: fpolicy-event-options-config | [top]

> Vserver FPolicy Event configuration and management on name 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
> event-name |  | event-name optional | Name of the Event. Attributes: key, required-for-create, non-modifiable
> file-operations |  | fpolicy-operation[] optional | Name of file operations. By default no operations are monitored. Attributes: optional-for-create, modifiable Possible values: "close" - File close operation, "create" - File create operation, "create_dir" - File create directory operation, "delete" - File delete operation, "delete_dir" - Directory delete operation, "getattr" - Get attribute operation, "link" - Link operation, "lookup" - Lookup operation, "open" - File open operation, "read" - File read operation, "write" - File write operation, "rename" - File rename operation, "rename_dir" - Directory rename operation, "setattr" - Set attribute operation, "symlink" - Symbolic link operation
> filter-string |  | fpolicy-filter[] optional | Name of filters. It is notification filtering parameters. By default no filters are selected. Attributes: optional-for-create, modifiable Possible values: "monitor_ads" - Monitor alternate data stream, "close_with_modification" - Filter close with modification, "close_without_modification" - Filter close without modification, "first_read" - Filter first read, "first_write" - Filter first write, "offline_bit" - Filter offline bit set, "open_with_delete_intent" - Filter open with delete intent, "open_with_write_intent" - Filter open with write intent, "write_with_size_change" - Filter write with size change
> protocol |  | fpolicy-proto optional | Name of protocol for which event is created. By default no protocol is selected. Attributes: optional-for-create, modifiable Possible values: "cifs" - CIFS protocol, "nfsv3" - NFSv3 protocol, "nfsv4" - NFSv4 protocol
> volume-operation |  | boolean optional | Indicator if the volume operation required for the event.Default Value is false. Attributes: optional-for-create, modifiable
> vserver |  | string optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: fpolicy-external-engine-info | [top]

> External engine configuration and management. 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
> certificate-ca |  | string optional | Certificate authority name. No default value is set for this field. Attributes: optional-for-create, modifiable
> certificate-common-name |  | common-name optional | FQDN or custom common name of certificate. No default value is set for this field. Attributes: optional-for-create, modifiable
> certificate-serial |  | string optional | Serial number of certificate. No default value is set for this field. Attributes: optional-for-create, modifiable
> engine-name |  | engine-name optional | Name of the external engine. Attributes: key, required-for-create, non-modifiable
> extern-engine-type |  | external-engine-type optional | External engine type. If the engine is asynchronous, no reply is sent from FPolicy servers. Default value set for this field is synchronous. Attributes: optional-for-create, modifiable Possible values: "synchronous" - Synchronous External Engine, "asynchronous" - Asynchronous External Engine
> keep-alive-interval | [0..2^32-1] | integer optional | Interval time in seconds for storage appliance to send keep-alive message to FPolicy server. Default value set for this field is 10 seconds. Attributes: optional-for-create, modifiable
> max-connection-retries | [0..2^32-1] | integer optional | Number of times storage appliance will attempt to establish a broken connection to FPolicy server. Default value set for this field is 5. Attributes: optional-for-create, modifiable
> max-server-requests | [0..2^32-1] | integer optional | Maximum number of outstanding screen requests that will be queued for an FPolicy Server. Default value set for this field is 50. Attributes: optional-for-create, modifiable
> port-number | [1..65535] | integer optional | Port number of the FPolicy server application. Attributes: required-for-create, modifiable
> primary-servers |  | ip-address[] optional | Primary FPolicy servers. Attributes: required-for-create, modifiable
> request-abort-timeout | [0..2^32-1] | integer optional | Timeout in seconds for a screen request to be aborted by storage appliance. Default value set for this field is 40 seconds. Attributes: optional-for-create, modifiable
> request-cancel-timeout | [0..2^32-1] | integer optional | Timeout in seconds for a screen request to be processed by an FPolicy server. Default value set for this field is 20 seconds. Attributes: optional-for-create, modifiable
> secondary-servers |  | ip-address[] optional | Secondary FPolicy servers. No default value is set for this field. Attributes: optional-for-create, modifiable
> server-progress-timeout | [0..2^32-1] | integer optional | Timeout in seconds in which a throttled FPolicy server must complete at least one screen request. If no request is processed within the timeout, connection to FPolicy server is terminated. Default value set for this field is 60 seconds. Attributes: optional-for-create, modifiable
> ssl-option |  | fpolicy-ssl-opts optional | SSL option for external communication. No default value is set for this field. Attributes: required-for-create, modifiable Possible values: "no_auth" - Communication over TCP, "server_auth" - Authentication of FPolicy server only, "mutual_auth" - Mutual authentication of storage system and FPolicy server
> status-request-interval | [0..2^32-1] | integer optional | Interval time in seconds for storage appliance to query status request from FPolicy server. Default value set for this field is 10 seconds. Attributes: optional-for-create, modifiable
> vserver |  | string optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: fpolicy-filter | [top]

> Filter Possible values: "monitor_ads" - Monitor alternate data stream, "close_with_modification" - Filter close with modification, "close_without_modification" - Filter close without modification, "first_read" - Filter first read, "first_write" - Filter first write, "offline_bit" - Filter offline bit set, "open_with_delete_intent" - Filter open with delete intent, "open_with_write_intent" - Filter open with write intent, "write_with_size_change" - Filter write with size change

> [none]

Element definition: fpolicy-operation | [top]

> File Operation Possible values: "close" - File close operation, "create" - File create operation, "create_dir" - File create directory operation, "delete" - File delete operation, "delete_dir" - Directory delete operation, "getattr" - Get attribute operation, "link" - Link operation, "lookup" - Lookup operation, "open" - File open operation, "read" - File read operation, "write" - File write operation, "rename" - File rename operation, "rename_dir" - Directory rename operation, "setattr" - Set attribute operation, "symlink" - Symbolic link operation

> [none]

Element definition: fpolicy-policy-info | [top]

> FPolicy 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
> allow-privileged-access |  | boolean optional | Indicator if privileged access should be given to FPolicy servers registered for the policy. Default Value is no. Attributes: optional-for-create, modifiable
> engine-name |  | engine-name optional | Name of the Engine. Default Engine is 'native'. Attributes: required-for-create, modifiable
> events |  | event-name[] optional | Events for file access monitoring. Attributes: required-for-create, modifiable
> is-mandatory |  | boolean optional | Indicator if the screening with this policy is required, i.e. it will fail if no servers are able process the notification registered as a part of external engine. If set to true, the request will fail if there is no server to evaluate it. If it's false, the request will succeed. Default value is true. Attributes: optional-for-create, modifiable
> policy-name |  | policy-name optional | Name of the policy. Attributes: key, required-for-create, non-modifiable
> privileged-user-name |  | string optional | User name for privileged access. No default value is set for this attribute. Attributes: optional-for-create, modifiable
> vserver |  | string optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: fpolicy-policy-status-info | [top]

> FPolicy Policy 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
> policy-name |  | policy-name optional | Name of the policy. Attributes: key, non-creatable, non-modifiable
> sequence-number | [1..10] | integer optional | Sequence number(or priority) of the policy. 1 being highest and 10 being smallest. Default value is 1. Attributes: non-creatable, non-modifiable
> status |  | boolean optional | Status of the policy. When on, policy is active. Attributes: non-creatable, non-modifiable
> vserver |  | string optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: fpolicy-proto | [top]

> Protocol Possible values: "cifs" - CIFS protocol, "nfsv3" - NFSv3 protocol, "nfsv4" - NFSv4 protocol

> [none]

Element definition: fpolicy-scope-config | [top]

> Vserver FPolicy Scope configuration and management on name 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
> check-extensions-on-directories |  | boolean optional | Indicates whether directory names are also subjected to extensions check, similar to file names. By default, the value is false. Attributes: optional-for-create, modifiable
> export-policies-to-exclude |  | string[] optional | Export Policies to exclude for file access monitoring. By default no export policy is selected. Attributes: optional-for-create, modifiable
> export-policies-to-include |  | string[] optional | Export policies to include for file access monitoring. By default no export policy is selected. Attributes: optional-for-create, modifiable
> file-extensions-to-exclude |  | string[] optional | File extensions excluded for screening. By default no file extension is selected. Attributes: optional-for-create, modifiable
> file-extensions-to-include |  | string[] optional | File extensions included for screening. By default no file extension is selected. Attributes: optional-for-create, modifiable
> policy-name |  | policy-name optional | Name of the policy. Attributes: key, required-for-create, non-modifiable
> shares-to-exclude |  | string[] optional | Shares to exclude for file access monitoring. By default no share is selected. Attributes: optional-for-create, modifiable
> shares-to-include |  | string[] optional | Shares to include for file access monitoring. By default no share is selected. Attributes: optional-for-create, modifiable
> volumes-to-exclude |  | string[] optional | Volumes that are inactive for the file policy. The list can include items which are regular expressions, such as 'vol*' or 'user?'. Note that if a policy has both an exclude list and an include list, the include list is ignored by the filer when processing user requests. By default no volume is selected. Attributes: optional-for-create, modifiable
> volumes-to-include |  | string[] optional | Volumes that are active for the file policy. The list can include items which are regular expressions, such as 'vol*' or 'user?'. By default no volume is selected. Attributes: optional-for-create, modifiable
> vserver |  | string optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: fpolicy-server-status-info | [top]

> External engine configuration and management. 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 | Date and time since FPolicy server is connected. Attributes: non-creatable, non-modifiable
> disconnect-reason |  | string optional | Reason for FPolicy server disconnection. Attributes: non-creatable, non-modifiable
> disconnected-since |  | datetime optional | Date and time since FPolicy server is disconnected. Attributes: non-creatable, non-modifiable
> fpolicy-server |  | ip-address optional | FPolicy server. Attributes: key, non-creatable, non-modifiable
> node |  | node-name optional | Cluster node name. Attributes: key, non-creatable, non-modifiable
> policy-name |  | policy-name optional | Name of the policy. Attributes: key, non-creatable, non-modifiable
> server-status |  | fpolicy-server-status optional | Status of the connection. Attributes: non-creatable, non-modifiable Possible values: "connected" - Server Connected, "disconnected" - Server Disconnected, "connecting" - Connecting Server, "disconnecting" - Disconnecting Server
> server-type |  | fpolicy-server-type optional | FPolicy server type. FPolicy server can be registered as primary or secondary server. Attributes: non-creatable, non-modifiable Possible values: "primary" - Primary Server, "secondary" - Secondary Server
> vserver |  | string optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: fpolicy-ssl-opts | [top]

> no-auth|server-auth|mutual-auth Possible values: "no_auth" - Communication over TCP, "server_auth" - Authentication of FPolicy server only, "mutual_auth" - Mutual authentication of storage system and FPolicy server

> [none]

Element definition: ip-address | [top]

> IPv4 and IPv6 address

> [none]

Element definition: policy-name | [top]

> Policy name

> [none]

Element definition: common-name | [top]

> Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).

> [none]

Element definition: datetime | [top]

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

> [none]

Element definition: engine-name | [top]

> Engine name

> [none]

Element definition: event-name | [top]

> Event name

> [none]

Element definition: external-engine-type | [top]

> External Engine Type Possible values: "synchronous" - Synchronous External Engine, "asynchronous" - Asynchronous External Engine

> [none]

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

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

> [none]

Element definition: fpolicy-server-type | [top]

> Server Type Possible values: "primary" - Primary Server, "secondary" - Secondary Server

> [none]

Element definition: node-name | [top]

> The node's name

> [none]