transformpolicy¶

Configuration for URL Transformation policy resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
name	<String>	Read-write	Name for the URL Transformation policy. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Can be changed after the URL Transformation 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 transform policy or my transform policy). Minimum length = 1
rule	<String>	Read-write	Expression, or name of a named expression, against which to evaluate traffic. The following requirements apply only to the Citrix ADC CLI: * If the expression includes blank spaces, the entire expression must be enclosed in double quotation marks. * If the expression itself includes double quotation marks, you must 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.
profilename	<String>	Read-write	Name of the URL Transformation profile to use to transform requests and responses that match the policy. Minimum length = 1
comment	<String>	Read-write	Any comments to preserve information about this URL Transformation policy.
logaction	<String>	Read-write	Log server to use to log connections that match this policy.
newname	<String>	Read-write	New name for the policy. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), 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 transform policy or my transform policy). Minimum length = 1
hits	<Double>	Read-only	Number of hits.
isdefault	<Boolean>	Read-only	A value of true is returned if it is a default transform policy.
builtin	<String[]>	Read-only	Flag to determine if Transform policy is built-in or not. Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature	<String>	Read-only	The feature to be checked while applying this config.
__count	<Double>	Read-only	count parameter

Operations¶

(click to see Properties )

ADD
DELETE
UPDATE
UNSET
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/transformpolicy

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"transformpolicy":{
<b>      "name":<String_value>,
</b><b>      "rule":<String_value>,
</b><b>      "profilename":<String_value>,
</b>      "comment":<String_value>,
      "logaction":<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/transformpolicy/ 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 NetScaler-specific errors). The response payload provides details of the error

update¶

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"transformpolicy":{
<b>      "name":<String_value>,
</b>      "rule":<String_value>,
      "profilename":<String_value>,
      "comment":<String_value>,
      "logaction":<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

unset¶

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"transformpolicy":{
<b>      "name":<String_value>,
</b>      "comment":true,
      "logaction":true
}}

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/transformpolicy? action=rename

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"transformpolicy":{
<b>      "name":<String_value>,
</b><b>      "newname":<String_value>
</b>}}

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/transformpolicy

Query-parameters:

attrs

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

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

view

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

Use this query-parameter to get the summary output of transformpolicy 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/transformpolicy? pagesize=#no;pageno=#no

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

{ "transformpolicy": [ {
      "name":<String_value>,
      "rule":<String_value>,
      "profilename":<String_value>,
      "hits":<Double_value>,
      "comment":<String_value>,
      "logaction":<String_value>,
      "isdefault":<Boolean_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>
}]}

get¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/transformpolicy/ name_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/transformpolicy/ name_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/transformpolicy/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of transformpolicy 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:

{  "transformpolicy": [ {
      "name":<String_value>,
      "rule":<String_value>,
      "profilename":<String_value>,
      "hits":<Double_value>,
      "comment":<String_value>,
      "logaction":<String_value>,
      "isdefault":<Boolean_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>
}]}

count¶

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

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