ADC CLI Commands

appqoe-action

The following operations can be performed on “appqoe-action”:

set add rm unset show

set appqoe action

Set the argument of specified AppQoE action.

Synopsis

set appqoe action [-priority ] [-altContentSvcName ] [-altContentPath ] [-polqDepth ] [-priqDepth ] [-maxConn ] [-delay ] [-dosTrigExpression ] [-dosAction ( SimpleResponse | HICResponse )] [-tcpprofile ] [-retryOnReset ( YES | NO )] [-retryOnTimeout ] [-numretries ]

Arguments

name Name for the AppQoE action. Must begin with a letter, number, or the underscore symbol (_). Other characters allowed, after the first character, are the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), and colon (:) characters. This is a mandatory argument

priority Priority for queuing the request. If server resources are not available for a request that matches the configured rule, this option specifies a priority for queuing the request until the server resources are available again. If priority is not configured then Lowest priority will be used to queue the request.

Possible values: HIGH, MEDIUM, LOW, LOWEST

altContentSvcName Name of the alternative content service to be used in the ACS

altContentPath Path to the alternative content service to be used in the ACS

polqDepth Policy queue depth threshold value. When the policy queue size (number of requests queued for the policy binding this action is attached to) increases to the specified polqDepth value, subsequent requests are dropped to the lowest priority level. Minimum value: 0 Maximum value: 4294967294

priqDepth Queue depth threshold value per priorirty level. If the queue size (number of requests in the queue of that particular priorirty) on the virtual server to which this policy is bound, increases to the specified qDepth value, subsequent requests are dropped to the lowest priority level. Minimum value: 0 Maximum value: 4294967294

maxConn Maximum number of concurrent connections that can be open for requests that matches with rule. Minimum value: 1 Maximum value: 4294967294

delay Delay threshold, in microseconds, for requests that match the policy’s rule. If the delay statistics gathered for the matching request exceed the specified delay, configured action triggered for that request, if there is no action then requests are dropped to the lowest priority level Minimum value: 1 Maximum value: 599999999

dosTrigExpression Optional expression to add second level check to trigger DoS actions. Specifically used for Analytics based DoS response generation

dosAction DoS Action to take when vserver will be considered under DoS attack and corresponding rule matches. Mandatory if AppQoE actions are to be used for DoS attack prevention.

Possible values: SimpleResponse, HICResponse

tcpprofile Bind TCP Profile based on L2/L3/L7 parameters.

retryOnReset Retry on TCP Reset

Possible values: YES, NO Default value: NO

retryOnTimeout Retry on request Timeout(in millisec) upon sending request to backend servers Minimum value: 30 Maximum value: 2000

numretries Retry count Default value: 3 Minimum value: 0 Maximum value: 7

add appqoe action

Add a new AppQoE action for triggering

Synopsis

add appqoe action [-priority ] [-respondWith ( ACS | NS ) [] [-altContentSvcName ] [-altContentPath ] [-maxConn ] [-delay ]] [-polqDepth ] [-priqDepth ] [-dosTrigExpression ] [-dosAction ( SimpleResponse | HICResponse )] [-tcpprofile ] [-retryOnReset ( YES | NO ) [-numretries ]] [-retryOnTimeout ]

Arguments

name Name for the AppQoE action. Must begin with a letter, number, or the underscore symbol (_). Other characters allowed, after the first character, are the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), and colon (:) characters. This is a mandatory argument

priority Priority for queuing the request. If server resources are not available for a request that matches the configured rule, this option specifies a priority for queuing the request until the server resources are available again. If priority is not configured then Lowest priority will be used to queue the request.

Possible values: HIGH, MEDIUM, LOW, LOWEST

respondWith Responder action to be taken when the threshold is reached. Available settings function as follows: ACS - Serve content from an alternative content service Threshold : maxConn or delay NS - Serve from the Citrix ADC (built-in response) Threshold : maxConn or delay

Possible values: ACS, NS

CustomFile name of the HTML page object to use as the response

altContentSvcName Name of the alternative content service to be used in the ACS

altContentPath Path to the alternative content service to be used in the ACS

polqDepth Policy queue depth threshold value. When the policy queue size (number of requests queued for the policy binding this action is attached to) increases to the specified polqDepth value, subsequent requests are dropped to the lowest priority level. Minimum value: 0 Maximum value: 4294967294

priqDepth Queue depth threshold value per priorirty level. If the queue size (number of requests in the queue of that particular priorirty) on the virtual server to which this policy is bound, increases to the specified qDepth value, subsequent requests are dropped to the lowest priority level. Minimum value: 0 Maximum value: 4294967294

maxConn Maximum number of concurrent connections that can be open for requests that matches with rule. Minimum value: 1 Maximum value: 4294967294

delay Delay threshold, in microseconds, for requests that match the policy’s rule. If the delay statistics gathered for the matching request exceed the specified delay, configured action triggered for that request, if there is no action then requests are dropped to the lowest priority level Minimum value: 1 Maximum value: 599999999

dosTrigExpression Optional expression to add second level check to trigger DoS actions. Specifically used for Analytics based DoS response generation

dosAction DoS Action to take when vserver will be considered under DoS attack and corresponding rule matches. Mandatory if AppQoE actions are to be used for DoS attack prevention.

Possible values: SimpleResponse, HICResponse

tcpprofile Bind TCP Profile based on L2/L3/L7 parameters.

retryOnReset Retry on TCP Reset

Possible values: YES, NO Default value: NO

retryOnTimeout Retry on request Timeout(in millisec) upon sending request to backend servers Minimum value: 30 Maximum value: 2000

numretries Retry count Default value: 3 Minimum value: 0 Maximum value: 7

rm appqoe action

Removes the specified AppQoE action.

Synopsis

rm appqoe action

Arguments

name Name of the action to be removed.

unset appqoe action

Use this command to remove appqoe action settings.Refer to the set appqoe action command for meanings of the arguments.

Synopsis

unset appqoe action [-priority] [-altContentSvcName] [-altContentPath] [-polqDepth] [-priqDepth] [-maxConn] [-delay] [-dosAction] [-tcpprofile] [-retryOnReset] [-retryOnTimeout] [-numretries]

show appqoe action

Display configured AppQoE action(s).

Synopsis

show appqoe action []

Arguments

name Name for the AppQoE action. Must begin with a letter, number, or the underscore symbol (_). Other characters allowed, after the first character, are the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), and colon (:) characters. This is a mandatory argument

Output

stateflag hits priority Priority for queuing the request. If server resources are not available for a request that matches the configured rule, this option specifies a priority for queuing the request until the server resources are available again. If priority is not configured then Lowest priority will be used to queue the request.

respondWith Responder action to be taken when the threshold is reached. Available settings function as follows: ACS - Serve content from an alternative content service Threshold : maxConn or delay NS - Serve from the Citrix ADC (built-in response) Threshold : maxConn or delay

polqDepth Policy queue depth threshold value. When the policy queue size (number of requests queued for the policy binding this action is attached to) increases to the specified polqDepth value, subsequent requests are dropped to the lowest priority level.

priqDepth Queue depth threshold value per priorirty level. If the queue size (number of requests in the queue of that particular priorirty) on the virtual server to which this policy is bound, increases to the specified qDepth value, subsequent requests are dropped to the lowest priority level.

altContentSvcName Name of the alternative content service to be used in the ACS

altContentPath Path to the alternative content service to be used in the ACS

maxConn Maximum number of concurrent connections that can be open for requests that matches with rule.

delay Delay threshold, in microseconds, for requests that match the policy’s rule. If the delay statistics gathered for the matching request exceed the specified delay, configured action triggered for that request, if there is no action then requests are dropped to the lowest priority level

CustomFile name of the HTML page object to use as the response

dosTrigExpression Optional expression to add second level check to trigger DoS actions. Specifically used for Analytics based DoS response generation

dosAction DoS Action to take when vserver will be considered under DoS attack and corresponding rule matches. Mandatory if AppQoE actions are to be used for DoS attack prevention.

tcpprofile Bind TCP Profile based on L2/L3/L7 parameters.

retryOnReset Retry on TCP Reset

retryOnTimeout Retry on request Timeout(in millisec) upon sending request to backend servers

numretries Retry count

devno count

appqoe-action