-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
rewriteaction
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
rewriteaction
Configuration for rewrite action resource.
Properties
(click to see Operations)
Name | Data Type | Permissions | Description |
---|---|---|---|
name |
|
Read-write | Name for the user-defined rewrite action. 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 Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my rewrite action" or ‘my rewrite action’). |
type |
|
Read-write | Type of user-defined rewrite action. The information that you provide for, and the effect of, each type are as follows:: * REPLACE \* REPLACE\_ALL \* REPLACE\_HTTP\_RES <string\_builder\_expr>. Replaces the complete HTTP response with the string defined by the string-builder expression. \* REPLACE\_SIP\_RES \* INSERT\_HTTP\_HEADER <header\_string\_builder\_expr> <contents\_string\_builder\_expr>. Inserts the HTTP header specified by <header\_string\_builder\_expr> and header contents specified by <contents\_string\_builder\_expr>. \* DELETE\_HTTP\_HEADER \* CORRUPT\_HTTP\_HEADER \* INSERT\_BEFORE <string\_builder\_expr1> <string\_builder\_expr1>. Finds the string specified in <string\_builder\_expr1> and inserts the string in <string\_builder\_expr2> before it. \* INSERT\_BEFORE\_ALL \* INSERT\_AFTER <string\_builder\_expr1> <string\_builder\_expr2>. Finds the string specified in <string\_builder\_expr1>, and inserts the string specified in <string\_builder\_expr2> after it. \* INSERT\_AFTER\_ALL \* DELETE \* DELETE\_ALL \* REPLACE\_DIAMETER\_HEADER\_FIELD \* REPLACE\_DNS\_HEADER\_FIELD \* REPLACE\_DNS\_ANSWER\_SECTION Possible values = noop, delete, insert\_http\_header, delete\_http\_header, corrupt\_http\_header, insert\_before, insert\_after, replace, replace\_http\_res, delete\_all, replace\_all, insert\_before\_all, insert\_after\_all, clientless\_vpn\_encode, clientless\_vpn\_encode\_all, clientless\_vpn\_decode, clientless\_vpn\_decode\_all, insert\_sip\_header, delete\_sip\_header, corrupt\_sip\_header, replace\_sip\_res, replace\_diameter\_header\_field, replace\_dns\_header\_field, replace\_dns\_answer\_section |
target |
|
Read-write | Expression that specifies which part of the request or response to rewrite. Minimum length = 1 |
stringbuilderexpr |
|
Read-write | Expression that specifies the content to insert into the request or response at the specified location, or that replaces the specified string. |
pattern |
|
Read-write | DEPRECATED in favor of -search: Pattern that is used to match multiple strings in the request or response. The pattern may be a string literal (without quotes) or 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: re~https?://|HTTPS?://~ The preceding regular expression can use the tilde (~) as the delimiter because that character does not appear in the regular expression itself. Used in the INSERT_BEFORE_ALL, INSERT_AFTER_ALL, REPLACE_ALL, and DELETE_ALL action types. |
search |
|
Read-write | 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(re \* XPath \(\"xpath\(xp \* JSON \(\"xpath\_json\(xp NOTE: JSON searches use the same syntax as XPath searches, but operate on JSON files instead of standard XML files. \* HTML \(\"xpath\_html\(xp 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\(\",\"). |
bypasssafetycheck |
|
Read-write | Bypass the safety check and allow unsafe expressions. An unsafe expression is one that contains references to message elements that might not be present in all messages. If an expression refers to a missing request element, an empty string is used instead. Default value: NO Possible values = YES, NO |
refinesearch |
|
Read-write | 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]+~). |
comment |
|
Read-write | Comment. Can be used to preserve information about this rewrite action. |
newname |
|
Read-write | New name for the rewrite action. 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 Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my rewrite action" or ‘my rewrite action’). Minimum length = 1 |
hits |
|
Read-only | The number of times the action has been taken. |
undefhits |
|
Read-only | The number of times the action resulted in UNDEF. |
referencecount |
|
Read-only | The number of references to the action. |
description |
|
Read-only | Description of the action. |
isdefault |
|
Read-only | A value of true is returned if it is a default rewriteaction. |
__count |
|
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 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>.
add
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rewriteaction
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"rewriteaction":{
<b>"name":<String_value>,
</b><b>"type":<String_value>,
</b><b>"target":<String_value>,
</b>"stringbuilderexpr":<String_value>,
"pattern":<String_value>,
"search":<String_value>,
"bypasssafetycheck":<String_value>,
"refinesearch":<String_value>,
"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 Citrix ADC specific errors). The response payload provides details of the error
delete
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rewriteaction/name_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 Citrix ADC specific errors). The response payload provides details of the error
update
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rewriteaction
HTTP Method:PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"rewriteaction":{
<b>"name":<String_value>,
</b>"target":<String_value>,
"stringbuilderexpr":<String_value>,
"bypasssafetycheck":<String_value>,
"pattern":<String_value>,
"search":<String_value>,
"bypasssafetycheck":<String_value>,
"refinesearch":<String_value>,
"comment":<String_value>
}}
<!--NeedCopy-->
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 error
unset
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rewriteaction?action=unset
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"rewriteaction":{
<b>"name":<String_value>,
</b>"stringbuilderexpr":true,
"refinesearch":true,
"comment":true
}}
<!--NeedCopy-->
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 error
rename
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rewriteaction?action=rename
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"rewriteaction":{
<b>"name":<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 Citrix ADC specific errors). The response payload provides details of the error
get (all)
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rewriteaction
Query-parameters:
attrs
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rewriteaction?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/rewriteaction?filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of rewriteaction 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/rewriteaction?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/rewriteaction?pagesize=#no;pageno=#no
Use this query-parameter to get the rewriteaction 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:
{ "rewriteaction": [ {
"name":<String_value>,
"type":<String_value>,
"target":<String_value>,
"stringbuilderexpr":<String_value>,
"pattern":<String_value>,
"search":<String_value>,
"bypasssafetycheck":<String_value>,
"refinesearch":<String_value>,
"hits":<Double_value>,
"undefhits":<Double_value>,
"referencecount":<Double_value>,
"description":<String_value>,
"isdefault":<Boolean_value>,
"comment":<String_value>
}]}
<!--NeedCopy-->
get
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rewriteaction/name_value<String>
Query-parameters:
attrs
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rewriteaction/name_value<String>?attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
view
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rewriteaction/name_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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "rewriteaction": [ {
"name":<String_value>,
"type":<String_value>,
"target":<String_value>,
"stringbuilderexpr":<String_value>,
"pattern":<String_value>,
"search":<String_value>,
"bypasssafetycheck":<String_value>,
"refinesearch":<String_value>,
"hits":<Double_value>,
"undefhits":<Double_value>,
"referencecount":<Double_value>,
"description":<String_value>,
"isdefault":<Boolean_value>,
"comment":<String_value>
}]}
<!--NeedCopy-->
count
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/rewriteaction?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:
{ "rewriteaction": [ { "__count": "#no"} ] }
<!--NeedCopy-->
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.