Download full document:

appfwpolicylabel_appfwpolicy_binding

Binding object showing the appfwpolicy that can be bound to appfwpolicylabel.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
priority	<Double>	Read-write	Positive integer specifying the priority of the policy. A lower number specifies a higher priority. Must be unique within a group of policies that are bound to the same bind point or label. Policies are evaluated in the order of their priority numbers.
gotopriorityexpression	<String>	Read-write	Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
policyname	<String>	Read-write	Name of the application firewall policy to bind to the policy label.
labeltype	<String>	Read-write	Type of policy label to invoke if the current policy evaluates to TRUE and the invoke parameter is set. Available settings function as follows: * reqvserver. Invoke the unnamed policy label associated with the specified request virtual server. * policylabel. Invoke the specified user-defined policy label.<br>Possible values = reqvserver, policylabel
labelname	<String>	Read-write	Name of the application firewall policy label.
invoke_labelname	<String>	Read-write	Name of the policy label to invoke if the current policy evaluates to TRUE, the invoke parameter is set, and Label Type is set to Policy Label.
invoke	<Boolean>	Read-write	If the current policy evaluates to TRUE, terminate evaluation of policies bound to the current policy label, and then forward the request to the specified virtual server or evaluate the specified policy label.
__count	<Double>	Read-write	count parameter

Operations

(click to see Properties)

ADD: | DELETE: | GET | COUNT

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: http://NS_IP/nitro/v1/config

HTTP Method: PUT

Request Payload:

{
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
sessionid":"##sessionid","appfwpolicylabel_appfwpolicy_binding":{
      "labelname":<String_value>,
      "policyname":<String_value>,
                  "priority":<Double_value>,
                  "gotopriorityexpression":<String_value>,
                  "invoke":<Boolean_value>,
                  "labeltype":<String_value>,
                  "invoke_labelname":<String_value>,

}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete:

URL: http://<NS_IP>/nitro/v1/config/appfwpolicylabel_appfwpolicy_binding/labelname_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/appfwpolicylabel_appfwpolicy_binding/labelname_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get

URL: http://<NS_IP>/nitro/v1/config/appfwpolicylabel_appfwpolicy_binding/labelname_value<String>

Query-parameters:

filter

http://<NS_IP>/nitro/v1/config/appfwpolicylabel_appfwpolicy_binding/labelname_value<String>?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of appfwpolicylabel_appfwpolicy_binding resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/appfwpolicylabel_appfwpolicy_binding/labelname_value<String>?pagesize=#no;pageno=#no

Use this query-parameter to get the appfwpolicylabel_appfwpolicy_binding resources in chunks.

warning

http://<NS_IP>/nitro/v1/config/appfwpolicylabel_appfwpolicy_binding?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "appfwpolicylabel_appfwpolicy_binding": [ {
      "priority":<Double_value>,
      "gotopriorityexpression":<String_value>,
      "policyname":<String_value>,
      "labeltype":<String_value>,
      "labelname":<String_value>,
      "invoke_labelname":<String_value>,
      "invoke":<Boolean_value>,

}]}

count

URL: http://<NS_IP>/nitro/v1/config/appfwpolicylabel_appfwpolicy_binding/labelname_value<String>?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",appfwpolicylabel_appfwpolicy_binding: [ { "__count": "#no"} ] }