Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

rewritepolicylabel

May 23, 2024
Contributed by: 
C

Configuration for rewrite policy label resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
labelname 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 Citrix ADC 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 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 - Citrix ADC clientless VPN requests
  • clientless_vpn_res - Citrix ADC 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
  • mqtt_req - MQTT requests
  • mqtt_res - MQTT 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, httpquic_req, httpquic_res, mqtt_req, mqtt_res
    		•
    comment Read-write Any comments to preserve information about this rewrite policy label.
    newname 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 Citrix ADC 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 Read-only Number of polices bound to label.
    hits Read-only Number of times policy label was invoked.
    priority Read-only Specifies the priority of the policy.
    gotopriorityexpression Read-only Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
    labeltype 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 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 Read-only Flowtype of the bound rewrite policy.
    description Read-only Description of the policylabel.
    isdefault 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
    feature Read-only The feature to be checked while applying this config.
    __count Read-only count parameter

    Operations

    (click to see Properties )

    • ADD
    • DELETE
    • GET (ALL)
    • GET
    • COUNT
    • RENAME

    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:// <netscaler-ip-address> /nitro/v1/config/rewritepolicylabel HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"rewritepolicylabel":{
<b>"labelname":<String_value>,
</b><b>"transform":<String_value>,
</b>"comment":<String_value>
}}

<!--NeedCopy-->

    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":{
<b>"labelname":<String_value>,
</b><b>"newname":<String_value>
</b>}}

<!--NeedCopy-->

    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

    Use this query-parameter to get the summary output of rewritepolicylabel resources configured on NetScaler.

    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 Header:

    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>,
"feature":<String_value>
}]}

<!--NeedCopy-->

    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

    Use this query-parameter to get the summary output of rewritepolicylabel resources configured on NetScaler.

    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 Header:

    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>,
"feature":<String_value>
}]}

<!--NeedCopy-->

    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 Header:

    Content-Type:application/json

    Response Payload: 

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

<!--NeedCopy-->
    rewritepolicylabel
    May 23, 2024
    Contributed by: 
    C
    May 23, 2024
    Contributed by: 
    C

    In this article

    Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
    © 1999- Cloud Software Group, Inc. All rights reserved.