Developer Documentation
Citrix ADC 12.1 NITRO API Reference
Current Release 13.1 13

tunneltrafficpolicy

August 17, 2023
Contributed by: 
C

Configuration for tunnel policy resource.

Properties

(click to see Operations)

Name Data Type Permissions Description
name Read-write Name for the tunnel traffic policy.
Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the policy is created.
The following requirement applies only to the Citrix ADC CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my policy” or ‘my policy)’.
Minimum length = 1
rule Read-write Expression, against which traffic is evaluated.
The following requirements apply only to the Citrix ADC CLI:
* If the expression includes blank spaces, the entire expression must be enclosed in double quotation marks.
* If the expression itself includes double quotation marks, you must escape the quotations by using the \ character.
* Alternatively, you can use single quotation marks to enclose the rule, in which case you do not have to escape the double quotation marks.
action Read-write Name of the built-in compression action to associate with the policy.
Minimum length = 1
comment Read-write Any comments to preserve information about this policy.
logaction Read-write Name of the messagelog action to use for requests that match this policy.
newname Read-write New name for the tunnel traffic policy. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), e
quals (=), and hyphen (-) characters.
Choose a name that reflects the function that the policy performs.

The following requirement applies only to the Citrix ADC CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my tunnel policy” or ‘my tunnel policy’).
Minimum length = 1
expressiontype Read-only Type of policy (Classic/Advanced).
Possible values = Classic Policy, Advanced Policy
hits Read-only No of hits.
undefhits Read-only Number of policy UNDEF hits.
txbytes Read-only Number of bytes transmitted.
rxbytes Read-only Number of bytes received.
clientttlb Read-only Total client TTLB value.
clienttransactions Read-only Number of client transactions.
serverttlb Read-only Total server TTLB value.
servertransactions Read-only Number of server transactions.
isdefault Read-only A value of true is returned if it is a default tunnelpolicy.
__count Read-only count parameter

Operations

(click to see Properties)

ADD DELETE UPDATE UNSET RENAME GET (ALL) 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 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/tunneltrafficpolicy

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"tunneltrafficpolicy":{
<b>"name":<String_value>,
</b><b>"rule":<String_value>,
</b><b>"action":<String_value>,
</b>"comment":<String_value>,
"logaction":<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 Citrix ADC specific errors). The response payload provides details of the error

delete

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

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

update

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

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"tunneltrafficpolicy":{
<b>"name":<String_value>,
</b>"rule":<String_value>,
"action":<String_value>,
"comment":<String_value>,
"logaction":<String_value>
}}

<!--NeedCopy-->

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

unset

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/tunneltrafficpolicy?action=unset

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"tunneltrafficpolicy":{
<b>"name":<String_value>,
</b>"comment":true,
"logaction":true
}}

<!--NeedCopy-->

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

rename

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/tunneltrafficpolicy?action=rename

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"tunneltrafficpolicy":{
<b>"name":<String_value>,
</b><b>"newname":<String_value>
</b>}}

<!--NeedCopy-->

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 (all)

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

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/tunneltrafficpolicy?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/tunneltrafficpolicy?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/tunneltrafficpolicy?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/tunneltrafficpolicy?pagesize=#no;pageno=#no

Use this query-parameter to get the tunneltrafficpolicy 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: 


{ "tunneltrafficpolicy": [ {
"name":<String_value>,
"expressiontype":<String_value>,
"rule":<String_value>,
"action":<String_value>,
"hits":<Double_value>,
"undefhits":<Double_value>,
"txbytes":<Double_value>,
"rxbytes":<Double_value>,
"clientttlb":<Double_value>,
"clienttransactions":<Double_value>,
"serverttlb":<Double_value>,
"servertransactions":<Double_value>,
"comment":<String_value>,
"logaction":<String_value>,
"isdefault":<Boolean_value>
}]}

<!--NeedCopy-->

get

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

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/tunneltrafficpolicy/name_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/tunneltrafficpolicy/name_value<String>?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

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: 


{ "tunneltrafficpolicy": [ {
"name":<String_value>,
"expressiontype":<String_value>,
"rule":<String_value>,
"action":<String_value>,
"hits":<Double_value>,
"undefhits":<Double_value>,
"txbytes":<Double_value>,
"rxbytes":<Double_value>,
"clientttlb":<Double_value>,
"clienttransactions":<Double_value>,
"serverttlb":<Double_value>,
"servertransactions":<Double_value>,
"comment":<String_value>,
"logaction":<String_value>,
"isdefault":<Boolean_value>
}]}

<!--NeedCopy-->

count

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


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

<!--NeedCopy-->
tunneltrafficpolicy
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.