ADC NITRO APIs

vpntrafficaction

August 17, 2023

Contributed by:

Configuration for VPN traffic action resource.

Properties

(click to see Operations )

Name	Permissions	Description
name	Read-write	Name for the traffic action. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after a traffic action 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 action” or ‘my action’). Minimum length = 1
qual	Read-write	Protocol, either HTTP or TCP, to be used with the action. Possible values = http, tcp
apptimeout	Read-write	Maximum amount of time, in minutes, a user can stay logged on to the web application. Minimum value = 1 Maximum value = 715827
sso	Read-write	Provide single sign-on to the web application. NOTE : Authentication mechanisms like Basic-authentication require the user credentials to be sent in plaintext which is not secure if the server is running on HTTP (instead of HTTPS). Possible values = ON, OFF
hdx	Read-write	Provide hdx proxy to the ICA traffic. Possible values = ON, OFF
formssoaction	Read-write	Name of the form-based single sign-on profile. Form-based single sign-on allows users to log on one time to all protected applications in your network, instead of requiring them to log on separately to access each one.
fta	Read-write	Specify file type association, which is a list of file extensions that users are allowed to open. Possible values = ON, OFF
wanscaler	Read-write	Use the Repeater Plug-in to optimize network traffic. Possible values = ON, OFF
kcdaccount	Read-write	Kerberos constrained delegation account name. Default value: “Default” Minimum length = 1 Maximum length = 32
samlssoprofile	Read-write	Profile to be used for doing SAML SSO to remote relying party. Minimum length = 1
proxy	Read-write	IP address and Port of the proxy server to be used for HTTP access for this request. Minimum length = 1
userexpression	Read-write	expression that will be evaluated to obtain username for SingleSignOn. Maximum length = 256
passwdexpression	Read-write	expression that will be evaluated to obtain password for SingleSignOn. Maximum length = 256
__count	Read-only	count parameter

Operations

(click to see Properties )

ADD
DELETE
UPDATE
UNSET
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 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/vpntrafficaction

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"vpntrafficaction":{
<b>      "name":<String_value>,
</b><b>      "qual":<String_value>,
</b>      "apptimeout":<Double_value>,
      "sso":<String_value>,
      "hdx":<String_value>,
      "formssoaction":<String_value>,
      "fta":<String_value>,
      "wanscaler":<String_value>,
      "kcdaccount":<String_value>,
      "samlssoprofile":<String_value>,
      "proxy":<String_value>,
      "userexpression":<String_value>,
      "passwdexpression":<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/vpntrafficaction/ 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 NetScaler-specific errors). The response payload provides details of the error

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpntrafficaction

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"vpntrafficaction":{
<b>      "name":<String_value>,
</b>      "apptimeout":<Double_value>,
      "sso":<String_value>,
      "hdx":<String_value>,
      "formssoaction":<String_value>,
      "fta":<String_value>,
      "wanscaler":<String_value>,
      "kcdaccount":<String_value>,
      "samlssoprofile":<String_value>,
      "proxy":<String_value>,
      "userexpression":<String_value>,
      "passwdexpression":<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 NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpntrafficaction? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"vpntrafficaction":{
<b>      "name":<String_value>,
</b>      "wanscaler":true,
      "kcdaccount":true,
      "proxy":true,
      "userexpression":true,
      "passwdexpression":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 NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpntrafficaction

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/vpntrafficaction? attrs=property-name1,property-name2

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

filter

http:// <netscaler-ip-address> /nitro/v1/config/vpntrafficaction? filter=property-name1:property-val1,property-name2:property-val2

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

view

http:// <netscaler-ip-address> /nitro/v1/config/vpntrafficaction? view=summary

Use this query-parameter to get the summary output of vpntrafficaction resources configured on NetScaler.

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

pagination

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

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

{ "vpntrafficaction": [ {
      "name":<String_value>,
      "qual":<String_value>,
      "apptimeout":<Double_value>,
      "sso":<String_value>,
      "formssoaction":<String_value>,
      "hdx":<String_value>,
      "fta":<String_value>,
      "wanscaler":<String_value>,
      "kcdaccount":<String_value>,
      "samlssoprofile":<String_value>,
      "proxy":<String_value>,
      "userexpression":<String_value>,
      "passwdexpression":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpntrafficaction/ name_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/vpntrafficaction/ name_value<String> ? attrs=property-name1,property-name2

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

view

http:// <netscaler-ip-address> /nitro/v1/config/vpntrafficaction/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of vpntrafficaction resources configured on NetScaler.

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 NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "vpntrafficaction": [ {
      "name":<String_value>,
      "qual":<String_value>,
      "apptimeout":<Double_value>,
      "sso":<String_value>,
      "formssoaction":<String_value>,
      "hdx":<String_value>,
      "fta":<String_value>,
      "wanscaler":<String_value>,
      "kcdaccount":<String_value>,
      "samlssoprofile":<String_value>,
      "proxy":<String_value>,
      "userexpression":<String_value>,
      "passwdexpression":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpntrafficaction? 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:

{ "vpntrafficaction": [ { "__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

vpntrafficaction

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

vpntrafficaction

Properties

Operations

add

delete

update

unset

get (all)

get

count

In this article