Skip to content

appfwglobal_appfwpolicy_binding

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

Properties

(click to see Operations)

NameData TypePermissionsDescription
priority<Double>Read-writeThe priority of the policy.
globalbindtype<String>Read-write.
Default value: SYSTEM_GLOBAL
Possible values = SYSTEM_GLOBAL, VPN_GLOBAL, RNAT_GLOBAL
policyname<String>Read-writeName of the policy.
labelname<String>Read-writeName 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<String>Read-writeEnable or disable the binding to activate or deactivate the policy. This is applicable to classic policies only.
Possible values = ENABLED, DISABLED
gotopriorityexpression<String>Read-writeExpression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
type<String>Read-writeBind point to which to policy is bound.
Possible values = REQ_OVERRIDE, REQ_DEFAULT, NONE
invoke<Boolean>Read-writeIf 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<String>Read-writeType of policy label invocation.
Possible values = reqvserver, policylabel
flowtype<Double>Read-onlyflowtype of the bound application firewall policy.
numpol<Double>Read-onlyThe number of policies bound to the bindpoint.
policytype<String>Read-only.
Possible values = Classic Policy, Advanced Policy
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

ADD:| DELETE:| GET| GET (ALL)| 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

add:

URL:http://<Citrix-ADC-IP-address(NSIP)/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>
}}

Response:

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

delete:

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwglobal_appfwpolicy_binding

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the error

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwglobal_appfwpolicy_binding

Query-parameters:

filter

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC. Filtering can be done on any of the properties of the resource.

pagination

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

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

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwglobal_appfwpolicy_binding

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwglobal_appfwpolicy_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

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

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

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