Product Documentation

policyexpression

Sep 07, 2016

Configuration for expression resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Unique name for the expression. Not case sensitive. Must begin with an ASCII letter or underscore (_) character, and must consist only of ASCII alphanumeric or underscore characters. Must not begin with 're' or 'xp' or be a word reserved for use as a default syntax expression qualifier prefix (such as HTTP) or enumeration value (such as ASCII). Must not be the name of an existing named expression, pattern set, dataset, stringmap, or HTTP callout.
Minimum length = 1
value
<String>
Read-write
Expression string. For example: http.req.body(100).contains("this").
description
<String>
Read-write
Description for the expression.
comment
<String>
Read-write
Any comments associated with the expression. Displayed upon viewing the policy expression.
clientsecuritymessage
<String>
Read-write
Message to display if the expression fails. Allowed for classic end-point check expressions only.
Minimum length = 1
type
<String>
Read-write
Type of expression. Can be a classic or default syntax (advanced) expression.
Possible values = CLASSIC, ADVANCED
hits
<Double>
Read-only
The total number of hits.
pihits
<Double>
Read-only
The total number of hits.
type1
<String>
Read-only
The type of expression. This is for output only.
Possible values = CLASSIC, ADVANCED
isdefault
<Boolean>
Read-only
A value of true is returned if it is a default policy expression.
builtin
<String[]>
Read-only
Indicates that a variable is a built-in (SYSTEM INTERNAL) type.
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
__count
<Double>
Read-only
count parameter

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"policyexpression":{
      "name":<String_value>,
      "value":<String_value>,
      "description":<String_value>,
      "comment":<String_value>,
      "clientsecuritymessage":<String_value>
}}

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

HTTP Method: PUT

Request Headers:

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

Request Payload:

{"policyexpression":{
      "name":<String_value>,
      "value":<String_value>,
      "description":<String_value>,
      "comment":<String_value>,
      "clientsecuritymessage":<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/policyexpression?action=unset

HTTP Method: POST

Request Headers:

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

Request Payload:

{"policyexpression":{
      "name":<String_value>,
      "description":true,
      "comment":true,
      "clientsecuritymessage":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/policyexpression

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/config/policyexpression?args=name:<String_value>,type:<String_value>

Use this query-parameter to get policyexpression resources based on additional properties.

attrs

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

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

view

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

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

pagination

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

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

Content-Type:application/json

Response Payload:

{ "policyexpression": [ {
name:<String_value>,type:<String_value>      "value":<String_value>,
      "hits":<Double_value>,
      "pihits":<Double_value>,
      "type1":<String_value>,
      "clientsecuritymessage":<String_value>,
      "description":<String_value>,
      "comment":<String_value>,
      "isdefault":<Boolean_value>,
      "builtin":<String[]_value>
}]}

get

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

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/policyexpression/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/policyexpression/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 error

Response Headers:

Content-Type:application/json

Response Payload:

{ "policyexpression": [ {
name:<String_value>,type:<String_value>      "value":<String_value>,
      "hits":<Double_value>,
      "pihits":<Double_value>,
      "type1":<String_value>,
      "clientsecuritymessage":<String_value>,
      "description":<String_value>,
      "comment":<String_value>,
      "isdefault":<Boolean_value>,
      "builtin":<String[]_value>
}]}

count

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

Content-Type:application/json

Response Payload:

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