ADC NITRO APIs

vpnclientlessaccessprofile

August 17, 2023

Contributed by:

Configuration for Clientless VPN rewrite profile resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
profilename		Read-write	Name for the Citrix Gateway clientless access profile. Must begin with an ASCII alphabetic or underscore (_) character, and must consist only of ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the profile 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 profile” or ‘my profile’). Minimum length = 1
urlrewritepolicylabel		Read-write	Name of the configured URL rewrite policy label. If you do not specify a policy label name, then URLs are not rewritten. Minimum length = 1
javascriptrewritepolicylabel		Read-write	Name of the configured JavaScript rewrite policy label. If you do not specify a policy label name, then JAVA scripts are not rewritten. Minimum length = 1
reqhdrrewritepolicylabel		Read-write	Name of the configured Request rewrite policy label. If you do not specify a policy label name, then requests are not rewritten. Minimum length = 1
reshdrrewritepolicylabel		Read-write	Name of the configured Response rewrite policy label. Minimum length = 1
regexforfindingurlinjavascript		Read-write	Name of the pattern set that contains the regular expressions, which match the URL in Java script. Minimum length = 1
regexforfindingurlincss		Read-write	Name of the pattern set that contains the regular expressions, which match the URL in the CSS. Minimum length = 1
regexforfindingurlinxcomponent		Read-write	Name of the pattern set that contains the regular expressions, which match the URL in X Component. Minimum length = 1
regexforfindingurlinxml		Read-write	Name of the pattern set that contains the regular expressions, which match the URL in XML. Minimum length = 1
regexforfindingcustomurls		Read-write	Name of the pattern set that contains the regular expressions, which match the URLs in the custom content type other than HTML, CSS, XML, XCOMP, and JavaScript. The custom content type should be included in the patset ns_cvpn_custom_content_types. Minimum length = 1
clientconsumedcookies		Read-write	Specify the name of the pattern set containing the names of the cookies, which are allowed between the client and the server. If a pattern set is not specified, Citrix Gateway does not allow any cookies between the client and the server. A cookie that is not specified in the pattern set is handled by Citrix Gateway on behalf of the client. Minimum length = 1
requirepersistentcookie		Read-write	Specify whether a persistent session cookie is set and accepted for clientless access. If this parameter is set to ON, COM objects, such as MSOffice, which are invoked by the browser can access the files using clientless access. Use caution because the persistent cookie is stored on the disk. Default value: OFF Possible values = ON, OFF
cssrewritepolicylabel		Read-only	The configured CSS rewrite policylabel. Minimum length = 1
xmlrewritepolicylabel		Read-only	The configured XML rewrite policylabel. Minimum length = 1
xcomponentrewritepolicylabel		Read-only	The configured X-Component rewrite policylabel. Minimum length = 1
isdefault		Read-only	A value of true is returned if it is a default vpnclientlessrwprofile.
description		Read-only	Description of the clientless access profile.
builtin	<String[]>	Read-only	Flag to determine if vpn clientless rewrite profile is built-in or not. Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature		Read-only	The feature to be checked while applying this config.
__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/vpnclientlessaccessprofile

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"vpnclientlessaccessprofile":{
<b>      "profilename":<String_value>
</b>}}

<!--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/vpnclientlessaccessprofile/ profilename_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/vpnclientlessaccessprofile

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"vpnclientlessaccessprofile":{
<b>      "profilename":<String_value>,
</b>      "urlrewritepolicylabel":<String_value>,
      "javascriptrewritepolicylabel":<String_value>,
      "reqhdrrewritepolicylabel":<String_value>,
      "reshdrrewritepolicylabel":<String_value>,
      "regexforfindingurlinjavascript":<String_value>,
      "regexforfindingurlincss":<String_value>,
      "regexforfindingurlinxcomponent":<String_value>,
      "regexforfindingurlinxml":<String_value>,
      "regexforfindingcustomurls":<String_value>,
      "clientconsumedcookies":<String_value>,
      "requirepersistentcookie":<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/vpnclientlessaccessprofile? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"vpnclientlessaccessprofile":{
<b>      "profilename":<String_value>,
</b>      "urlrewritepolicylabel":true,
      "javascriptrewritepolicylabel":true,
      "reqhdrrewritepolicylabel":true,
      "reshdrrewritepolicylabel":true,
      "regexforfindingurlinjavascript":true,
      "regexforfindingurlincss":true,
      "regexforfindingurlinxcomponent":true,
      "regexforfindingurlinxml":true,
      "regexforfindingcustomurls":true,
      "clientconsumedcookies":true,
      "requirepersistentcookie":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/vpnclientlessaccessprofile

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/vpnclientlessaccessprofile? 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/vpnclientlessaccessprofile? filter=property-name1:property-val1,property-name2:property-val2

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

view

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

Use this query-parameter to get the summary output of vpnclientlessaccessprofile 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/vpnclientlessaccessprofile? pagesize=#no;pageno=#no

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

{ "vpnclientlessaccessprofile": [ {
      "profilename":<String_value>,
      "urlrewritepolicylabel":<String_value>,
      "javascriptrewritepolicylabel":<String_value>,
      "cssrewritepolicylabel":<String_value>,
      "xmlrewritepolicylabel":<String_value>,
      "xcomponentrewritepolicylabel":<String_value>,
      "reqhdrrewritepolicylabel":<String_value>,
      "reshdrrewritepolicylabel":<String_value>,
      "regexforfindingurlinjavascript":<String_value>,
      "regexforfindingurlincss":<String_value>,
      "regexforfindingurlinxcomponent":<String_value>,
      "regexforfindingurlinxml":<String_value>,
      "regexforfindingcustomurls":<String_value>,
      "clientconsumedcookies":<String_value>,
      "requirepersistentcookie":<String_value>,
      "isdefault":<Boolean_value>,
      "description":<String_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnclientlessaccessprofile/ profilename_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/vpnclientlessaccessprofile/ profilename_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/vpnclientlessaccessprofile/ profilename_value<String> ? view=summary

Use this query-parameter to get the summary output of vpnclientlessaccessprofile 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:

{  "vpnclientlessaccessprofile": [ {
      "profilename":<String_value>,
      "urlrewritepolicylabel":<String_value>,
      "javascriptrewritepolicylabel":<String_value>,
      "cssrewritepolicylabel":<String_value>,
      "xmlrewritepolicylabel":<String_value>,
      "xcomponentrewritepolicylabel":<String_value>,
      "reqhdrrewritepolicylabel":<String_value>,
      "reshdrrewritepolicylabel":<String_value>,
      "regexforfindingurlinjavascript":<String_value>,
      "regexforfindingurlincss":<String_value>,
      "regexforfindingurlinxcomponent":<String_value>,
      "regexforfindingurlinxml":<String_value>,
      "regexforfindingcustomurls":<String_value>,
      "clientconsumedcookies":<String_value>,
      "requirepersistentcookie":<String_value>,
      "isdefault":<Boolean_value>,
      "description":<String_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>
}]}

<!--NeedCopy-->

count

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

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

vpnclientlessaccessprofile

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

vpnclientlessaccessprofile

Properties

Operations

add

delete

update

unset

get (all)

get

count

In this article