Home > Configuration > Responder

Use this method to creates a responder action, which specifies how to respond to a request.

Use this method to creates a responder policy, which specifies requests that the Citrix ADC intercepts and responds to directly instead of forwarding them to a protected server.

Use this method to creates a user-defined responder policy label, to which you can bind policies.
A policy label is a tool for evaluating a set of policies in a specified order. By using a policy label, you can configure the responder feature to choose the next policy, invoke a different policy label, or terminate policy evaluation completely by looking at whether the previous policy evaluated to TRUE or FALSE.

Use this method to bind policy to responder global.

Use this method to bind policy to responder policylabel.

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

Use this method to get the list of policies bound to the specified responder global bind point.

Use this method to get the specified HTML page object. If no HTML page object is specified, lists all HTML page objects on the Citrix ADC.

Use this method to get the Responder parameters.

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

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

Use this method to imports the specified HTML page to the Citrix ADC, assigns it the specified name, and stores it in the list of Responder HTML page objects. This page can be used as a HTTP response body using the Responder respondwithhtmlpage action type. The HTML page can contain expressions and the maximum number of expressions allowed is 1000.

Use this method to renames a responder action.

Use this method to renames the specified responder policy.

Use this method to renames the specified responder policy label.

Use this method to removes the specified responder action.

Use this method to removes the specified HTML page object.

Use this method to removes the specified responder policy.

Use this method to removes a responder policy label.

Use this method to set comment. Any type of information about this responder action.

Use this method to set one or more headers to insert into the HTTP response. Each header is specified as "name(expr)", where expr is an expression that is evaluated at runtime to provide the value for the named header. You can configure a maximum of eight headers for a responder action.

Use this method to set for respondwithhtmlpage policies, name of the HTML page object to use as the response. You must first import the page object.

Use this method to set expression specifying the reason phrase of the HTTP response. The reason phrase may be a string literal with quotes or a PI expression. For example: "Invalid URL: " + HTTP.REQ.URL

Use this method to set hTTP response status code, for example 200, 302, 404, etc. The default value for the redirect action type is 302 and for respondwithhtmlpage is 200

Use this method to set expression specifying what to respond with. Typically a URL for redirect policies or a default-syntax expression. In addition to Citrix ADC default-syntax expressions that refer to information in the request, a stringbuilder expression can contain text and HTML, and simple escape codes that define new lines and paragraphs. Enclose each stringbuilder expression element (either a Citrix ADC default-syntax expression or a string) in double quotation marks. Use the plus (+) character to join the elements.

Examples:
1) Respondwith expression that sends an HTTP 1.1 200 OK response:
"HTTP/1.1 200 OK\r\n\r\n"

2) Redirect expression that redirects user to the specified web host and appends the request URL to the redirect.
"http://backupsite2.com" + HTTP.REQ.URL

3) Respondwith expression that sends an HTTP 1.1 404 Not Found response with the request URL included in the response:
"HTTP/1.1 404 Not Found\r\n\r\n"+ "HTTP.REQ.URL.HTTP_URL_SAFE" + "does not exist on the web server."

The following requirement applies only to the Citrix ADC CLI:
Enclose the entire expression in single quotation marks. (Citrix ADC expression elements should be included inside the single quotation marks for the entire expression, but do not need to be enclosed in double quotation marks.)

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.

Use this method to set action to perform when policy evaluation creates an UNDEF condition. Available settings function as follows:
* NOOP - Send the request to the protected server.
* RESET - Reset the request and notify the user's browser, so that the user can resend the request.
* DROP - Drop the request without sending a response to the user.

Use this method to set name of the responder action to perform if the request matches this responder policy. There are also some built-in actions which can be used. These are:
* NOOP - Send the request to the protected server instead of responding to it.
* RESET - Reset 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 appFlow action to invoke for requests that match this policy.

Use this method to set any type of information about this responder policy.

Use this method to set name of the messagelog action to use for requests that match this policy.

Use this method to set expression that the policy uses to determine whether to respond to the specified request.

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 responder global.

Use this method to unbind priority from responder global.

Use this method to unbind policy from responder policylabel.

Use this method to unbind priority from responder policylabel.

Remove responder action comment setting.

Remove responder action headers setting.

Remove responder action reasonphrase setting.

Remove responder action responsestatuscode setting.

Remove responder param timeout setting.

Remove responder param undefaction setting.

Remove responder policy appflowaction setting.

Remove responder policy comment setting.

Remove responder policy logaction setting.

Remove responder policy undefaction setting.

Use this method to updates the specified HTML page object from the source.