Home > Configuration > Rewrite

Use this method to creates a rewrite action, which specifies exactly what modifications to make to a request or response before forwarding that request or response to the protected web server or to the user.
In addition to user-defined actions, the rewrite feature has the following three built-in actions:
* NOREWRITE - Sends the request or response to the user without rewriting it.
* RESET - Resets the connection and notifies the user's browser, so that the user can resend the request.
* DROP - Drops the connection without sending a response to the user.
One of the following three flow types is implicitly associated with every action:
* Request - Action applies to the request.
* Response - Action applies to the response.
* Neutral - Action applies to both requests and responses.

Use this method to creates a rewrite policy, which specifies which requests or responses to rewrite.

Use this method to creates a user-defined rewrite policy label.

Use this method to bind policy to rewrite global.

Use this method to bind policy to rewrite policylabel.

Use this method to get the current settings for the specified rewrite action.

Use this method to get the list of policies bound to the specified rewrite global policy bank. If no policy bank is specified, displays a list of all policies bound to rewrite global.

Use this method to get the Rewrite parameters.

Use this method to get the current settings for the specified rewrite policy.

Use this method to get the current settings for the specified rewrite policy label.

Use this method to renames a rewrite action.

Use this method to renames the specified rewrite policy. You must restart the Citrix ADC to put new name in effect.

Use this method to renames a rewrite policy label.

Use this method to removes a rewrite action.

Use this method to removes the specified rewrite policy.

Use this method to removes the specified rewrite policy label.

Use this method to set comment. Can be used to preserve information about this rewrite action.

Use this method to set specify additional criteria to refine the results of the search.
Always starts with the "extend(m,n)" operation, where 'm' specifies number of bytes to the left of selected data and 'n' specifies number of bytes to the right of selected data to extend the selected area.
You can use refineSearch only on body expressions, and for the INSERT_BEFORE_ALL, INSERT_AFTER_ALL, REPLACE_ALL, and DELETE_ALL action types.
Example: -refineSearch 'EXTEND(10, 20).REGEX_SELECT(re~0x[0-9a-zA-Z]+~).

Use this method to set search facility that is used to match multiple strings in the request or response. Used in the INSERT_BEFORE_ALL, INSERT_AFTER_ALL, REPLACE_ALL, and DELETE_ALL action types. The following search types are supported:
* Text ("text(string)") - A literal string. Example: -search text("hello")
* Regular expression ("regex(reregular exp)") - Pattern that is used to match multiple strings in the request or response. The pattern may be a PCRE-format regular expression with a delimiter that consists of any printable ASCII non-alphanumeric character except for the underscore (_) and space ( ) that is not otherwise used in the expression. Example: -search regex(re~^hello*~) The preceding regular expression can use the tilde (~) as the delimiter because that character does not appear in the regular expression itself.
* XPath ("xpath(xpxpath expression)") - An XPath expression to search XML. The delimiter has the same rules as for regex. Example: -search xpath(xp%/a/b%)
* JSON ("xpath_json(xpxpath expression)") - An XPath expression to search JSON. The delimiter has the same rules as for regex. Example: -search xpath_json(xp%/a/b%)
NOTE: JSON searches use the same syntax as XPath searches, but operate on JSON files instead of standard XML files.
* HTML ("xpath_html(xpxpath expression)") - An XPath expression to search HTML. The delimiter has the same rules as for regex. Example: -search xpath_html(xp%/html/body%)
NOTE: HTML searches use the same syntax as XPath searches, but operate on HTML files instead of standard XML files; HTML 5 rules for the file syntax are used; HTML 4 and later are supported.
* Patset ("patset(patset)") - A predefined pattern set. Example: -search patset("patset1").
* Datset ("dataset(dataset)") - A predefined dataset. Example: -search dataset("dataset1").
* AVP ("avp(avp number)") - AVP number that is used to match multiple AVPs in a Diameter/Radius Message. Example: -search avp(999)

Note: for all these the TARGET prefix can be used in the replacement expression to specify the text that was selected by the -search parameter, optionally adjusted by the -refineSearch parameter.
Example: TARGET.BEFORE_STR(",")

Use this method to set expression that specifies the content to insert into the request or response at the specified location, or that replaces the specified string.

Use this method to set expression that specifies which part of the connection to rewrite.

Use this method to set maximum time in milliseconds to allow for processing all the policies and their selected actions without interruption. If the timeout is reached then the evaluation causes an UNDEF to be raised and no further processing is performed. Note that some rewrites may have already been performed.

Use this method to set action to perform if the result of policy evaluation is undefined (UNDEF). An UNDEF event indicates an error condition in evaluating the expression.
Available settings function as follows:
* NOREWRITE - Do not modify the message.
* RESET - Reset the connection and notify the user's browser, so that the user can resend the request.
* DROP - Drop the message without sending a response to the user.

Use this method to set 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.

Use this method to set any comments to preserve information about this rewrite policy.

Use this method to set name of messagelog action to use when a request matches this policy.

Use this method to set expression against which traffic is evaluated.

The following requirements apply only to the Citrix ADC 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.

Use this method to set 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.

Use this method to unbind policy from rewrite global.

Use this method to unbind priority from rewrite global.

Use this method to unbind policy from rewrite policylabel.

Use this method to unbind priority from rewrite policylabel.

Remove rewrite action comment setting.

Remove rewrite action refinesearch setting.

Remove rewrite action stringbuilderexpr setting.

Remove rewrite param timeout setting.

Remove rewrite param undefaction setting.

Remove rewrite policy comment setting.

Remove rewrite policy logaction setting.

Remove rewrite policy undefaction setting.