Product Documentation

rewritepolicylabel

Sep 07, 2016

Configuration for rewrite policy label resource.

Properties (click to see Operations)

Name Data Type Permissions Description
labelname
<String>
Read-write
Name for the rewrite policy label. 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. Cannot be changed after the rewrite policy label 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 label" or ?my rewrite policy label?).
transform
<String>
Read-write
Types of transformations allowed by the policies bound to the label. For Rewrite, the following types are supported:
* http_req - HTTP requests
* http_res - HTTP responses
* othertcp_req - Non-HTTP TCP requests
* othertcp_res - Non-HTTP TCP responses
* url - URLs
* text - Text strings
* clientless_vpn_req - NetScaler clientless VPN requests
* clientless_vpn_res - NetScaler clientless VPN responses
* sipudp_req - SIP requests
* sipudp_res - SIP responses
* diameter_req - DIAMETER requests
* diameter_res - DIAMETER responses
* radius_req - RADIUS requests
* radius_res - RADIUS responses
* dns_req - DNS requests
* dns_res - DNS responses.
Possible values = http_req, http_res, othertcp_req, othertcp_res, url, text, clientless_vpn_req, clientless_vpn_res, sipudp_req, sipudp_res, siptcp_req, siptcp_res, diameter_req, diameter_res, radius_req, radius_res, dns_req, dns_res
comment
<String>
Read-write
Any comments to preserve information about this rewrite policy label.
newname
<String>
Read-write
New name for the rewrite policy label.
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 policy label" or ?my policy label?).
Minimum length = 1
numpol
<Double>
Read-only
Number of polices bound to label.
hits
<Double>
Read-only
Number of times policy label was invoked.
priority
<Double>
Read-only
Specifies the priority of the policy.
gotopriorityexpression
<String>
Read-only
Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
labeltype
<String>
Read-only
Type of invocation. Available settings function as follows:
* reqvserver - Forward the request to the specified request virtual server.
* resvserver - Forward the response to the specified response virtual server.
* policylabel - Invoke the specified policy label.
Possible values = reqvserver, resvserver, policylabel
invoke_labelname
<String>
Read-only
* If labelType is policylabel, name of the policy label to invoke.
* If labelType is reqvserver or resvserver, name of the virtual server to which to forward the request or response.
flowtype
<Double>
Read-only
Flowtype of the bound rewrite policy.
description
<String>
Read-only
Description of the policylabel.
isdefault
<Boolean>
Read-only
A value of true is returned if it is a default rewritepolicylabel.
builtin
<String[]>
Read-only
Flag to determine if rewrite policy label is built-in or not.
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/rewritepolicylabel

HTTP Method: POST

Request Headers:

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

Request Payload:

{"rewritepolicylabel":{
      "labelname":<String_value>,
      "transform":<String_value>,
      "comment":<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/rewritepolicylabel/labelname_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

rename

URL: http://<netscaler-ip-address>/nitro/v1/config/rewritepolicylabel?action=rename

HTTP Method: POST

Request Headers:

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

Request Payload:

{"rewritepolicylabel":{
      "labelname":<String_value>,
      "newname":<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

get (all)

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

Query-parameters:

attrs

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

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

view

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

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

pagination

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

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

{ "rewritepolicylabel": [ {
      "labelname":<String_value>,
      "transform":<String_value>,
      "numpol":<Double_value>,
      "hits":<Double_value>,
      "priority":<Double_value>,
      "gotopriorityexpression":<String_value>,
      "labeltype":<String_value>,
      "invoke_labelname":<String_value>,
      "flowtype":<Double_value>,
      "description":<String_value>,
      "isdefault":<Boolean_value>,
      "comment":<String_value>,
      "builtin":<String[]_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/rewritepolicylabel/labelname_value<String>

Query-parameters:

attrs

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

{ "rewritepolicylabel": [ {
      "labelname":<String_value>,
      "transform":<String_value>,
      "numpol":<Double_value>,
      "hits":<Double_value>,
      "priority":<Double_value>,
      "gotopriorityexpression":<String_value>,
      "labeltype":<String_value>,
      "invoke_labelname":<String_value>,
      "flowtype":<Double_value>,
      "description":<String_value>,
      "isdefault":<Boolean_value>,
      "comment":<String_value>,
      "builtin":<String[]_value>
}]}

count

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

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