Download full document:

ns_filterpolicy_template

Configuration for NS Filter Policy Configure Task resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
priority<Integer>Read-writePolicy Priority.
device_groups<String[]>Read-writeDevice Group Array on which for which template is applied.
name<String>Read-writeName of Policy.
variables<variable_values[]>Read-writeValues of Variables used in commands of the configuration template.
state<String>Read-writeState of the Policy: enabled/disabled.
devices<String[]>Read-writeDevice IP Address Array on which template is applied.
actionType<String>Read-writeAction Type of the Policy.
actionName<String>Read-writeAction Name of the Policy.
expression<String>Read-writeExpression of the Policy.

Operations

(click to see Properties)

ADD| GET (ALL)

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: https://<MGMT-IP>/nitro/v1/config/ns_filterpolicy_template?onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_filterpolicy_template: {
"priority":<Integer_value>,
"variables":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"parent_id":<String_value>}],
"default_value":<String_value>,
"id":<String_value>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"description":<String_value>,
"display_name":<String_value>,
"type":<String_value>}],
"state":<String_value>,
"actionType":<String_value>,
"actionName":<String_value>,
"expression":<String_value>,
"device_groups":<String_value[]>,
"name":<String_value>,
"devices":<String_value[]>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_filterpolicy_template":[{
"priority":<Integer_value>,
"device_groups":<String_value>,
"name":<String_value>,
"variables":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"device_group":<String_value>,
"device":<String_value>,
"parent_id":<String_value>}],
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>}],
"state":<String_value>,
"devices":<String_value>,
"actionType":<String_value>,
"actionName":<String_value>,
"expression":<String_value>}]}

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/ns_filterpolicy_template

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_filterpolicy_template":[{
"priority":<Integer_value>,
"device_groups":<String_value>,
"name":<String_value>,
"variables":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"device_group":<String_value>,
"device":<String_value>,
"parent_id":<String_value>}],
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>}],
"state":<String_value>,
"devices":<String_value>,
"actionType":<String_value>,
"actionName":<String_value>,
"expression":<String_value>}]}