Download full document:

vpnsessionpolicy

Configuration for VPN session policy resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeName for the new session policy that is applied after the user logs on to NetScaler Gateway.
Minimum length = 1
rule<String>Read-writeExpression, or name of a named expression, specifying the traffic that matches the policy. Can be written in either default or classic syntax.
Maximum length of a string literal in the expression is 255 characters. A longer string can be split into smaller strings of up to 255 characters each, and the smaller strings concatenated with the + operator. For example, you can create a 500-character string as follows: '"<string of 255 characters>" + "<string of 245 characters>"'

The following requirements apply only to the NetScaler CLI:
* If the expression includes one or more spaces, enclose the entire expression in double quotation marks.
* If the expression itself includes double quotation marks, 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<String>Read-writeAction to be applied by the new session policy if the rule criteria are met.
Minimum length = 1
builtin<String[]>Read-onlyIndicates that a variable is a built-in (SYSTEM INTERNAL) type.
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
expressiontype<String>Read-onlyType of policy (Classic/Advanced) .
Possible values = Classic Policy, Advanced Policy
hits<Double>Read-onlyNumber of hits.
__count<Double>Read-onlycount 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 redand placeholder content is marked in <green>.

add

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

HTTP Method:POST

Request Headers:

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

Request Payload:

{"vpnsessionpolicy":{
<b>"name":<String_value>,
</b><b>"rule":<String_value>,
</b><b>"action":<String_value>
</b>}}

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/vpnsessionpolicy/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/vpnsessionpolicy

HTTP Method:PUT

Request Headers:

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

Request Payload:

{"vpnsessionpolicy":{
<b>"name":<String_value>,
</b>"rule":<String_value>,
"action":<String_value>
}}

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/vpnsessionpolicy?action=unset

HTTP Method:POST

Request Headers:

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

Request Payload:

{"vpnsessionpolicy":{
<b>"name":<String_value>,
</b>"rule":true,
"action":true
}}

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/vpnsessionpolicy

Query-parameters:

attrs

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

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

view

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

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

pagination

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

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

Content-Type:application/json

Response Payload:

{ "vpnsessionpolicy": [ {
"name":<String_value>,
"rule":<String_value>,
"action":<String_value>,
"builtin":<String[]_value>,
"expressiontype":<String_value>,
"hits":<Double_value>
}]}

get

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

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/vpnsessionpolicy/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/vpnsessionpolicy/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 NetScaler-specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "vpnsessionpolicy": [ {
"name":<String_value>,
"rule":<String_value>,
"action":<String_value>,
"builtin":<String[]_value>,
"expressiontype":<String_value>,
"hits":<Double_value>
}]}

count

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

Content-Type:application/json

Response Payload:

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