ADC NITRO APIs

appfwglobal_appfwpolicy_binding

May 23, 2024

Contributed by:

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

Properties

(click to see Operations )

Name	Permissions	Description
priority	Read-write	The priority of the policy.
globalbindtype	Read-write	. Default value: SYSTEM_GLOBAL Possible values = SYSTEM_GLOBAL, VPN_GLOBAL, RNAT_GLOBAL, APPFW_GLOBAL
policyname	Read-write	Name of the policy.
labelname	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.
state	Read-write	Enable or disable the binding to activate or deactivate the policy. This is applicable to classic policies only. Possible values = ENABLED, DISABLED
gotopriorityexpression	Read-write	Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
type	Read-write	Bind point to which to policy is bound. Possible values = REQ_OVERRIDE, REQ_DEFAULT, HTTPQUIC_REQ_OVERRIDE, HTTPQUIC_REQ_DEFAULT, NONE
invoke	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.
labeltype	Read-write	Type of policy label invocation. Possible values = reqvserver, policylabel
flowtype	Read-only	flowtype of the bound application firewall policy.
numpol	Read-only	The number of policies bound to the bindpoint.
policytype	Read-only	. Possible values = Classic Policy, Advanced Policy
__count	Read-only	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:// <netscaler-ip-address /nitro/v1/config/appfwglobal_appfwpolicy_binding HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{
"appfwglobal_appfwpolicy_binding":{
<b>"policyname":<String_value>,
</b><b>"priority":<Double_value>,
</b>"state":<String_value>,
"gotopriorityexpression":<String_value>,
"type":<String_value>,
"invoke":<Boolean_value>,
"labeltype":<String_value>,
"labelname":<String_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/appfwglobal_appfwpolicy_binding Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/appfwglobal_appfwpolicy_binding? args= policyname:<String_value>, type: <String_value> ,priority: <Double_value>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get

Use this query-parameter to get appfwglobal_appfwpolicy_binding resources based on additional properties.

filter http:// <netscaler-ip-address> /nitro/v1/config/appfwglobal_appfwpolicy_binding? filter=property-name1:property-value1,property-name2:property-value2

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

pagination http:// <netscaler-ip-address> /nitro/v1/config/appfwglobal_appfwpolicy_binding? pagesize=#no;pageno=#no

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "appfwglobal_appfwpolicy_binding": [ {
"priority":<Double_value>,
"globalbindtype":<String_value>,
"policyname":<String_value>,
"labelname":<String_value>,
"state":<String_value>,
"gotopriorityexpression":<String_value>,
"type":<String_value>,
"invoke":<Boolean_value>,
"labeltype":<String_value>,
"flowtype":<Double_value>,
"numpol":<Double_value>,
"policytype":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/appfwglobal_appfwpolicy_binding? count=yes HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "appfwglobal_appfwpolicy_binding": [ { "__count": "#no"} ] }

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

appfwglobal_appfwpolicy_binding

May 23, 2024

Contributed by:

May 23, 2024

Contributed by:

appfwglobal_appfwpolicy_binding

Properties

Operations

add

delete

get

count

In this article