APIs in Category: fpolicy | API version 1.5

fpolicy-create-policy fpolicy-destroy-policy fpolicy-disable fpolicy-disable-policy fpolicy-enable fpolicy-enable-policy fpolicy-extensions fpolicy-extensions-list-info fpolicy-get-required-info fpolicy-get-secondary-servers-info fpolicy-list-info fpolicy-server-list-info fpolicy-server-stop fpolicy-set-required fpolicy-set-secondary-servers fpolicy-status | 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.

NetApp Manage ONTAP

fpolicy-create-policy | [top]

> Creates a new policy.

> Input Name | Range | Type | Description
> policy-name |  | string | Name of the policy.
> policy-type |  | string | Type of the policy. Possible values: "screen".

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

fpolicy-destroy-policy | [top]

> Destroys existing policy.

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

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

fpolicy-disable | [top]

> Sets options fpolicy enable to on.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

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

fpolicy-enable | [top]

> Sets options fpolicy enable to on.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

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.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

fpolicy-extensions | [top]

> Manipulates with list of extensions in exclude or include set. Exlude set defines extension patterns that won't trigger fpolicy processing.

> Input Name | Range | Type | Description
> command |  | string | Command to be applied on the specified set. Supported values: "add", "remove", "set", "reset".
> extensions |  | extension-list-info[] | List of extensions.
> policy-name |  | string | Name of the policy.
> set-name |  | string | Defines to which set (exclude or include) a command (add, remove, etc) will be applied to. For instance, command = add, set-name = include will add specified list of extensions to the include set. Possible values: "exclude", "include".

> Errno | Description
> EINVALIDINPUTERROR |  |
> EOPNOTSUPPORTED |  |
> EINTERNALERROR |  |

fpolicy-extensions-list-info | [top]

> Returns information on existing extension sets.

> Input Name | Range | Type | Description
> policy-name |  | string | Name of the policy.
> Output Name | Range | Type | Description
> exclude-extensions |  | extension-list-info[] | List of file extensions that are excluded from the file policy.
> include-extensions |  | extension-list-info[] | List of file extensions that are included in the file policy.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

fpolicy-get-required-info | [top]

> Shows current options for the policy.

> Input Name | Range | Type | Description
> policy-name |  | string | Name of the policy.
> Output Name | Range | Type | Description
> is-required |  | boolean | Indicator if the policy is required, i.e. will it fail if the server is not responding. If set to true, the request will fail if there is no server to evaluate it. If it's false, the request will succeed.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

fpolicy-get-secondary-servers-info | [top]

> Shows current options for the policy.

> Input Name | Range | Type | Description
> policy-name |  | string | Name of the policy.
> Output Name | Range | Type | Description
> secondary-servers |  | secondary-server-info[] | List of servers' IP addresses. Currently maximum of two servers are supported.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

fpolicy-list-info | [top]

> Returns a list of existing policies.

> Input Name | Range | Type | Description
> policy-name |  | string optional | Name of the policy. If this parameter is set, policies will have information pertaining to the policy named. If there is no such a policy, policies will be empty.
> Output Name | Range | Type | Description
> policies |  | policy-info[] | List of policies.

> Errno | Description
> EINTERNALERROR |  |

fpolicy-server-list-info | [top]

> Shows a list of primary servers serving the policy.

> Input Name | Range | Type | Description
> policy-name |  | string | Name of the policy.
> Output Name | Range | Type | Description
> number-of-screen-failures |  | integer | Number of failed (denaid) screens since server registrations.
> servers |  | server-info[] | List of the servers' IP addresses.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

fpolicy-server-stop | [top]

> Stops specific primary server serving the policy. Effectively, this will unregistered fpolicy server.

> Input Name | Range | Type | Description
> policy-name |  | string | Name of the policy.
> server-ip |  | ip-address | The ip address, in dotted-decimal format, of the server.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

fpolicy-set-required | [top]

> Sets policy's "required" option to on/off.

> Input Name | Range | Type | Description
> policy-name |  | string | Name of the policy.
> required |  | boolean | Indicator if the policy is required. If set to true, the request will fail if there is no server to evaluate it. If it's false, the request will succeed.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

fpolicy-set-secondary-servers | [top]

> Sets secondary servers information in a form of a list of ip addresses. These servers will be used if all primary servers are not available, thus increasing system availabilty.

> Input Name | Range | Type | Description
> policy-name |  | string | Name of the policy.
> secondary-servers |  | secondary-server-info[] | List of servers' IP addresses. Currently maximum of two servers are supported.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

fpolicy-status | [top]

> Returns status of options fpolicy enable.

> Output Name | Range | Type | Description
> is-enabled |  | boolean | Shows if the fpolicy mechanism is enabled or not.

> Errno | Description
> EINTERNALERROR |  |

Element definition: extension-list-info | [top]

> Structure containing extension information.

> Name | Range | Type | Description
> name-spec |  | string | Extension specification (including wild cards). Allowed are only DOS like, three character long extensions. The extensions are case insensitive. Supported wild card values: "???" to match any extension and "?" to match any character. Examples of allowed extension specifications: EXE ??? ?XT P??

Element definition: ip-address | [top]

> One ip address, in dotted-decimal format (for example, "192.168.11.12").

> [none]

Element definition: policy-info | [top]

> Structure containing information pertaining to policy.

> Name | Range | Type | Description
> is-enabled |  | boolean | Policy status.
> monitored-operations |  | monitored-operation-info[] | List of monitored operations.
> monitored-protocols |  | monitored-protocol-info[] | List of monitored protocols.
> name |  | string | Policy name.
> number-of-screen-failures |  | integer | Number of failed (denaid) screen requests. This value is reset each time the filer is rebooted or the policy is disabled.
> number-of-screened-files |  | integer | Number of screened files since policy has been enabled. This value is reset each time the filer is rebooted or the policy is disabled.

Element definition: secondary-server-info | [top]

> Structure containing information pertaining to secondary servers.

> Name | Range | Type | Description
> server-ip |  | ip-address | The ip address, in dotted-decimal format, of the server.

Element definition: server-info | [top]

> Structure containing information pertaining to servers.

> Name | Range | Type | Description
> is-asynchronous |  | boolean optional | Shows if the server is registered as asynchrnous, i.e. doesn't send reply to the filer.
> number-of-screened-files |  | integer | Number of screened files since server registration.
> offline-filter-bit |  | string optional | Shows the setting of offline filter. Supported values: "none", "on-set", "on-not-set".
> server-ip |  | ip-address | The ip address, in dotted-decimal format, of the server.

Element definition: ip-address | [top]

> One ip address, in dotted-decimal format (for example, "192.168.11.12").

> [none]

Element definition: monitored-operation-info | [top]

> Structure containing information pertaining to monitored operations.

> Name | Range | Type | Description
> operation |  | string | Supported values: "file-create", "file- delete", "file-open", "file-close", "file-rename", "directory-create", "directory-delete", "directory-rename", "getattr", "setattr", "lookup", "read", "write", "link", "symlink"

Element definition: monitored-protocol-info | [top]

> Structure containing information pertaining to monitored operations' protocols.

> Name | Range | Type | Description
> protocol |  | string | Supported values: "nfs", "cifs".