tunnelglobal_tunneltrafficpolicy_binding

Last published : Oct 30, 2026
Binding object showing the tunneltrafficpolicy that can be bound to tunnelglobal.

Properties

(click to see Operations)
Name Data Type Permissions Description
priority <Double> Read-write Priority.
globalbindtype <String> Read-write .
Default value: SYSTEM_GLOBAL
Possible values = SYSTEM_GLOBAL, VPN_GLOBAL, RNAT_GLOBAL
policyname <String> Read-write Policy name.
gotopriorityexpression <String> Read-write Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
type <String> Read-write Bind point to which the policy is bound.
Possible values = REQ_OVERRIDE, REQ_DEFAULT, RES_OVERRIDE, RES_DEFAULT
state <String> Read-write Current state of the binding. If the binding is enabled, the policy is active.
Possible values = ENABLED, DISABLED
numpol <Double> Read-only The number of policies bound to the bindpoint.
policytype <String> Read-only Policy type (Classic/Advanced) to be bound.Used for display.
Possible values = Classic Policy, Advanced Policy
__count <Double> Read-only count parameter

Operations

(click to see Properties)
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/tunnelglobal_tunneltrafficpolicy_binding
HTTP Method:PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:

{
"tunnelglobal_tunneltrafficpolicy_binding":{
<b>"policyname":<String_value>,
</b>"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"state":<String_value>,
"type":<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/tunnelglobal_tunneltrafficpolicy_binding
Query-parameters:
args
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/tunnelglobal_tunneltrafficpolicy_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/tunnelglobal_tunneltrafficpolicy_binding
Query-parameters:
filter
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/tunnelglobal_tunneltrafficpolicy_binding?filter=property-name1:property-value1,property-name2:property-value2
Use this query-parameter to get the filtered set of tunnelglobal_tunneltrafficpolicy_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/tunnelglobal_tunneltrafficpolicy_binding?pagesize=#no;pageno=#no
Use this query-parameter to get the tunnelglobal_tunneltrafficpolicy_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:

{ "tunnelglobal_tunneltrafficpolicy_binding": [ {
"priority":<Double_value>,
"globalbindtype":<String_value>,
"policyname":<String_value>,
"gotopriorityexpression":<String_value>,
"type":<String_value>,
"state":<String_value>,
"numpol":<Double_value>,
"policytype":<String_value>
}]}

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/tunnelglobal_tunneltrafficpolicy_binding
Query-parameters:
bulkbindings
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/tunnelglobal_tunneltrafficpolicy_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:

{ "tunnelglobal_tunneltrafficpolicy_binding": [ {
"priority":<Double_value>,
"globalbindtype":<String_value>,
"policyname":<String_value>,
"gotopriorityexpression":<String_value>,
"type":<String_value>,
"state":<String_value>,
"numpol":<Double_value>,
"policytype":<String_value>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/tunnelglobal_tunneltrafficpolicy_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:

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