Developer Documentation
ADC CLI Commands
Current Release 13.1 13.0 12.1

cs-policy

May 28, 2024
Contributed by: 
C

The following operations can be performed on “cs-policy”:

set unset rename add rm show

set cs policy

Changes an existing content switching policy.

Synopsis

set cs policy [-rule ] [-action ] [-logAction ]

Arguments

policyName Name of the content switching policy.

rule The condition for applying this policy.

action The content switching action name.

logAction The log action associated with the content switching policy

unset cs policy

Unset logaction for existing content swtching policy..Refer to the set cs policy command for meanings of the arguments.

Synopsis

unset cs policy -logAction

Example

unset cs policy pol9 -logAction

rename cs policy

Rename a content switching policy.

Synopsis

rename cs policy @ @

Arguments

policyName The name of the content switching policy.

newName The new name of the content switching policy.

Example

rename cs policy oldname newname

add cs policy

Creates a new content switching policy. You use this policy to manage content switching on a virtual server.

Synopsis

add cs policy -rule [-action ] [-logAction ]

Arguments

policyName Name for the content switching policy. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. Cannot be changed after a policy is created. 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 policy” or ‘my policy’).

rule Expression, or name of a named 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.

action Content switching action that names the target load balancing virtual server to which the traffic is switched.

logAction The log action associated with the content switching policy

Example

To match the requests that have URL “.html”, you would enter the following command: add cs policy -rule http.req.url.eq(".html") -action To match with all URLs that start with "/sports.html", you would enter the following command: add cs policy -rule http.req.url.startswith("/sports.html") -action To match requests with the URL "/sports/tennis/index.html", you would enter the following command: add cs policy -rule http.req.url.eq("/sports/tennis/index.html") -action To match requests that have URLs with the extension "jsp", you would enter the following command: add cs policy -rule http.req.url.suffix.eq("jsp") -action To match requests with URLs that start with "/sports.html" and the file extension "jsp", you would enter the following command: add cs policy -rule "http.req.url.startswith(\"/sports/\") && http.req.url.suffix.eq(\"jsp\")" -action To match requests with URLs that contain "sports", you would enter the following commands: add pol expression sports_url http.req.url.contains("sports") add cs policy -rule sports_url -action To match requests with URL queries that contain "gold" or cookie headers that contain "gold", you would enter the following commands: add pol expression gold_query "http.req.url.query.contains(\"gold\")" add pol expression gold_cookie "http.req.header(\"cookie\").contains(\"gold\")" add cs policy -rule \"\(gold\_query \||gold\_cookie)\" -action To match requests with the domain name www.domainxyz.com, you enter the following command: add cs policy -rule "http.req.hostname.eq(\"www.domainxyz.com\")" -action To match requests with the domain name www.domainxyz.com and URLs with the extension "jsp", you would enter the following command: add cs policy -rule "http.req.hostname.eq(\"www.domainxyz.com\") && http.req.url.suffix.eq(\"jsp\")" -action To match requests with the domain name www.domainxyz.com and URLs that contain "sports", you would enter the following commands: add pol expression sports_url http.req.url.contains("sports") add cs policy -rule "sports_url && http.req.hostname.eq(\"www.domainxyz.com\")" -action To match a policy with a rule and provide action: add cs policy -rule "http.req.method.eq(GET)" -action

rm cs policy

Removes a content switching policy. You can delete a user-defined content switching policy that is not bound to a content switching virtual server. If the policy is bound to a virtual server, you must first unbind the policy, and then remove it.

Synopsis

rm cs policy

Arguments

policyName Name of the content switching policy to be removed.

show cs policy

Displays all existing content switching policies, or just the specified policy.

Synopsis

show cs policy []

Arguments

policyName Name of the content switching policy to display. If this parameter is omitted, details of all the policies are displayed.

Output

rule The condition for applying this policy.

action The CS action name.

vstype Virtual server type.

hits Total number of hits.

bindHits Total number of bind hits.

labelName Name of the label invoked.

labelType The invocation type.

target Target flag

priority priority of bound policy

flag stateflag activePolicy Indicates whether policy is bound or not.

logAction The log action associated with the content switching policy

gslbBindings boundTo Location where policy is bound

gotoPriorityExpression Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.

devno count

cs-policy
May 28, 2024
Contributed by: 
C
May 28, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.