vpntrafficpolicy
Configuration for VPN traffic policy resource.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| name | <String> | Read-write | Name for the traffic policy. 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 the policy is created. The following requirement applies only to the NetScaler 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).<br>Minimum length = 1 |
| rule | <String> | Read-write | Expression, or name of a named expression, against which traffic is evaluated. Written in the classic or default syntax. Note: 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: ";lt;string of 255 characters;gt;" + ";lt;string of 245 characters;gt;" 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-write | Action to apply to traffic that matches the policy.<br>Minimum length = 1 |
| __count | <Double> | 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://<NSIP>/nitro/v1/config/
HTTP Method: POST
Request Payload:
object={
"params":{
"warning":<String_value>,
"onerror":<String_value>
},
"sessionid":"##sessionid",
"vpntrafficpolicy":{
"name":<String_value>,
"rule":<String_value>,
"action":<String_value>,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
delete
URL: http://<NSIP>/nitro/v1/config/vpntrafficpolicy/name_value<String>
Query-parameters:
warning
http://<NS_IP>/nitro/v1/config/vpntrafficpolicy/name_value<String>?warning=yes
Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a
HTTP Method: DELETE
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
update
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: PUT
Request Payload:
{
"params": {
"warning":<String_value>,
"onerror":<String_value>"
},
sessionid":"##sessionid",
"vpntrafficpolicy":{
"name":<String_value>,
"rule":<String_value>,
"action":<String_value>,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
unset
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: POST
Request Payload:
object={
"params":{
"warning":<String_value>,
"onerror":<String_value>,
"action":"unset"
},
"sessionid":"##sessionid",
"vpntrafficpolicy":{
"name":<String_value>,
"rule":true,
"action":true,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
get (all)
URL: http://<NSIP>/nitro/v1/config/vpntrafficpolicy
Query-parameters:
filter
http://<NSIP>/nitro/v1/config/vpntrafficpolicy?filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of vpntrafficpolicy resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http://<NS_IP>/nitro/v1/config/vpntrafficpolicy?view=summary
Use this query-parameter to get the summary output of vpntrafficpolicy resources configured on NetScaler.
pagesize=#no;pageno=#no
http://<NS_IP>/nitro/v1/config/vpntrafficpolicy?pagesize=#no;pageno=#no
Use this query-parameter to get the vpntrafficpolicy resources in chunks.
warning
http://<NS_IP>/nitro/v1/config/vpntrafficpolicy?warning=yes
Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": <String_value>, "vpntrafficpolicy": [ {
"name":<String_value>,
"rule":<String_value>,
"action":<String_value>
}]}
get
URL: http://<NS_IP>/nitro/v1/config/vpntrafficpolicy/name_value<String>
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done", "vpntrafficpolicy": [ {
"name":<String_value>,
"rule":<String_value>,
"action":<String_value>
}]}
count
URL: http://<NS_IP>/nitro/v1/config/vpntrafficpolicy?count=yes
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done",vpntrafficpolicy: [ { "__count": "#no"} ] }