rewritepolicy
Configuration for rewrite policy resource.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| name | <String> | Read-write | Name for the rewrite policy. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Can be changed after the rewrite policy is added. 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 rewrite policy" or ?my rewrite policy?). |
| rule | <String> | Read-write | Expression against which traffic is evaluated. Written in 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;" (Classic expressions are not supported in the cluster build.) 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 | Name of the rewrite action to perform if the request or response matches this rewrite policy. There are also some built-in actions which can be used. These are: * NOREWRITE - Send the request from the client to the server or response from the server to the client without making any changes in the message. * RESET - Resets the client connection by closing it. The client program, such as a browser, will handle this and may inform the user. The client may then resend the request if desired. * DROP - Drop the request without sending a response to the user. |
| undefaction | <String> | Read-write | Action to perform if the result of policy evaluation is undefined (UNDEF). An UNDEF event indicates an internal error condition. Only the above built-in actions can be used. |
| comment | <String> | Read-write | Any comments to preserve information about this rewrite policy. |
| logaction | <String> | Read-write | Name of messagelog action to use when a request matches this policy. |
| newname | <String> | Read-write | New name for the rewrite policy. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters. 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 rewrite policy" or ?my rewrite policy?).<br>Minimum length = 1 |
| hits | <Double> | Read-only | Number of hits. |
| undefhits | <Double> | Read-only | Number of Undef hits. |
| description | <String> | Read-only | Description of the policy. |
| isdefault | <Boolean> | Read-only | A value of true is returned if it is a default rewritepolicy. |
| builtin | <String[]> | Read-only | Flag to determine if rewrite policy is built-in or not.<br>Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL |
| __count | <Double> | Read-only | count parameter |
Operations
(click to see Properties)
ADD | DELETE | UPDATE | UNSET | RENAME | 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",
"rewritepolicy":{
"name":<String_value>,
"rule":<String_value>,
"action":<String_value>,
"undefaction":<String_value>,
"comment":<String_value>,
"logaction":<String_value>,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
delete
URL: http://<NSIP>/nitro/v1/config/rewritepolicy/name_value<String>
Query-parameters:
warning
http://<NS_IP>/nitro/v1/config/rewritepolicy/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",
"rewritepolicy":{
"name":<String_value>,
"rule":<String_value>,
"action":<String_value>,
"undefaction":<String_value>,
"comment":<String_value>,
"logaction":<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",
"rewritepolicy":{
"name":<String_value>,
"undefaction":true,
"comment":true,
"logaction":true,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
rename
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: POST
Request Payload:
object={
"params":{
"warning":<String_value>,
"onerror":<String_value>,
"action":"rename"
},
"sessionid":"##sessionid",
"rewritepolicy":{
"name":<String_value>,
"newname":<String_value>,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
get (all)
URL: http://<NSIP>/nitro/v1/config/rewritepolicy
Query-parameters:
filter
http://<NSIP>/nitro/v1/config/rewritepolicy?filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of rewritepolicy resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http://<NS_IP>/nitro/v1/config/rewritepolicy?view=summary
Use this query-parameter to get the summary output of rewritepolicy resources configured on NetScaler.
pagesize=#no;pageno=#no
http://<NS_IP>/nitro/v1/config/rewritepolicy?pagesize=#no;pageno=#no
Use this query-parameter to get the rewritepolicy resources in chunks.
warning
http://<NS_IP>/nitro/v1/config/rewritepolicy?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>, "rewritepolicy": [ {
"name":<String_value>,
"rule":<String_value>,
"action":<String_value>,
"undefaction":<String_value>,
"hits":<Double_value>,
"undefhits":<Double_value>,
"description":<String_value>,
"comment":<String_value>,
"logaction":<String_value>,
"isdefault":<Boolean_value>,
"builtin":<String[]_value>
}]}
get
URL: http://<NS_IP>/nitro/v1/config/rewritepolicy/name_value<String>
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done", "rewritepolicy": [ {
"name":<String_value>,
"rule":<String_value>,
"action":<String_value>,
"undefaction":<String_value>,
"hits":<Double_value>,
"undefhits":<Double_value>,
"description":<String_value>,
"comment":<String_value>,
"logaction":<String_value>,
"isdefault":<Boolean_value>,
"builtin":<String[]_value>
}]}
count
URL: http://<NS_IP>/nitro/v1/config/rewritepolicy?count=yes
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done",rewritepolicy: [ { "__count": "#no"} ] }