Skip to content

policyevaluation

Configuration for expr evaluation resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
expression<String>Read-writeExpression string. For example: http.req.body(100).contains("this").
action<String>Read-writeRewrite action name. Supported rewrite action types are:
-delete
-delete_all
-delete_http_header
-insert_after
-insert_after_all
-insert_before
-insert_before_all
-insert_http_header
-replace
-replace_all
.
Minimum length = 1
type<String>Read-writeIndicates request or response input packet.
Possible values = HTTP_REQ, HTTP_RES, TEXT
input<String>Read-writeText representation of input packet.
pitmodifiedinputdata<String>Read-onlyText representation of packet after evaluating expression or rewrite action.
pitboolresult<Boolean>Read-onlyResult of the expression in bool format.
pitnumresult<Double>Read-onlyResult of the expression in num format.
pitdoubleresult<Double>Read-onlyResult of the expression in double format.
pitulongresult<Double>Read-onlyResult of the expression in unsigned long format.
pitrefresult<String>Read-onlyResult of the expression in string format.
pitoffsetresult<Double>Read-onlyOffset of the resultant sting.
pitoffsetresultlen<Double>Read-onlyOffset length of the resultant sting.
istruncatedrefresult<Boolean>Read-onlyIdentify whether ref result is truncated result.
pitboolevaltime<Double>Read-onlyAverage evaluation time of bool type expression in nanoseconds.
pitnumevaltime<Double>Read-onlyAverage evaluation time of num type expression in nanoseconds.
pitdoubleevaltime<Double>Read-onlyAverage evaluation time of double type expression in nanoseconds.
pitulongevaltime<Double>Read-onlyAverage evaluation time of unsigned long type expression in nanoseconds.
pitrefevaltime<Double>Read-onlyAverage evaluation time of string type expression in nanoseconds.
pitoffsetevaltime<Double>Read-onlyAverage evaluation time in finding offset of the resultant string in the input. Time is in nanoseconds.
pitactionevaltime<Double>Read-onlyAverage evaluation time of rewrite action in nanoseconds.
pitoperationperformerarray<String[]>Read-onlyDetails of the operation Citrix ADC performed at various offsets during applying of rewrite action on input data. Operation can be insertion, modfication or deletion.
Possible values = INSERT, MODIFY, DELETE
pitoldoffsetarray<Double[]>Read-onlyDetails of the offsets in the input data at which Citrix ADC either inserted or modified or deleted data during applying of rewrite action.
pitnewoffsetarray<Double[]>Read-onlyDetails of the offsets in the output data at which Citrix ADC either inserted or modified or deleted data during applying of rewrite action.
pitoffsetlengtharray<Integer[]>Read-onlyDetails of the lengths of the data which Citrix ADC either inserted or modified or deleted during applying of rewrite action.
pitboolerrorresult<String>Read-onlyResult of the bool type expression if any error occurs during evaluation. Result will be in string format.
pitnumerrorresult<String>Read-onlyResult of the num type expression if any error occurs during evaluation. Result will be in string format.
pitdoubleerrorresult<String>Read-onlyResult of the double type expression if any error occurs during evaluation. Result will be in string format.
pitulongerrorresult<String>Read-onlyResult of the unsigned long type expression if any error occurs during evaluation. Result will be in string format.
pitreferrorresult<String>Read-onlyResult of the ref type expression if any error occurs during evaluation. Result will be in string format.
pitoffseterrorresult<String>Read-onlyResult of the expression if any error occurs in calculating offset. Result will be in string format.
pitactionerrorresult<String>Read-onlyResult of the action if any error occurs in evaluation. Result will be in string format.
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

GET (ALL)| 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/policyevaluation

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/policyevaluation?args=expression:<String_value>,action:<String_value>,type:<String_value>,input:<String_value>,

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

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/policyevaluation?attrs=property-name1,property-name2

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

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/policyevaluation?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/policyevaluation?view=summary

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

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/policyevaluation?pagesize=#no;pageno=#no

Use this query-parameter to get the policyevaluation 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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "policyevaluation": [ {
expression:<String_value>,action:<String_value>,<b>type:<String_value>,</b><b>input:<String_value>,</b>"pitmodifiedinputdata":<String_value>,
"pitboolresult":<Boolean_value>,
"pitnumresult":<Double_value>,
"pitdoubleresult":<Double_value>,
"pitulongresult":<Double_value>,
"pitrefresult":<String_value>,
"pitoffsetresult":<Double_value>,
"pitoffsetresultlen":<Double_value>,
"istruncatedrefresult":<Boolean_value>,
"pitboolevaltime":<Double_value>,
"pitnumevaltime":<Double_value>,
"pitdoubleevaltime":<Double_value>,
"pitulongevaltime":<Double_value>,
"pitrefevaltime":<Double_value>,
"pitoffsetevaltime":<Double_value>,
"pitactionevaltime":<Double_value>,
"pitoperationperformerarray":<String[]_value>,
"pitoldoffsetarray":<Double[]_value>,
"pitnewoffsetarray":<Double[]_value>,
"pitoffsetlengtharray":<Integer[]_value>,
"pitboolerrorresult":<String_value>,
"pitnumerrorresult":<String_value>,
"pitdoubleerrorresult":<String_value>,
"pitulongerrorresult":<String_value>,
"pitreferrorresult":<String_value>,
"pitoffseterrorresult":<String_value>,
"pitactionerrorresult":<String_value>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/policyevaluation?args=expression:<String_value>,action:<String_value>,type:<String_value>,input:<String_value>,;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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

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