Table of Contents
Command Referencedfp
agent
manager
ft group
failover
heartbeat-time
preempt
priority
ip slb mode
map cookie
match protocol http cookie
map header
match protocol http header
map retcode
match protocol http retcode
map url
match protocol http url
module csm
natpool
policy
client-group
cookie-map
header-map
serverfarm
set ip dscp
sticky-group
url-map
probe
address (dns)
address (icmp)
credentials
expect status
failed
header
interval
name
open
receive
request
retries
real
inservice
maxconns
minconns
redirect-vserver
weight
redirect-vserver
advertise
client
idle
inservice
replicate csrp
ssl
virtual
vlan
webhost backup
webhost relocation
serverfarm
bindid
failaction purge
health
nat client
nat server
predictor
probe
retcode-map
static
real
sticky
vlan
alias
gateway
ip address
route
vserver
advertise
client
idle
inservice
parse-length
pending
persistent rebalance
replicate csrp
serverfarm
slb-policy
sticky
url-hash
virtual
vlan
show module csm arp
show module csm conns
show module csm dfp
show module csm ft
show module csm map
show module csm memory
show module csm natpool
show module csm policy
show module csm probe
show module csm real
show module csm real retcode
show module csm serverfarm
show module csm static
show module csm static server
show module csm stats
show module csm status
show module csm sticky
show module csm tech-support
show module csm vlan
show module csm vserver redirect
Command Reference
This appendix describes the Content Switching Module (CSM) commands that are unique to server load-balancing (SLB) and Layer 3 switching.
The following commands allow you to set up and monitor SLB on the CSM:
| Command | Submode Command |
|---|---|
dfp
Use the dfp command to enter the DFP submode and configure DFP. Use the no form of this command to remove the DFP configuration.
- dfp [password password [timeout]]
- no dfp
Syntax Description
Defaults
The default timeout value is 180 seconds.
Command Modes
Module CSM configuration submode.
Command History
Usage Guidelines
The timeout option allows you to change the password without stopping messages between the DFP agent and its manager.
During a timeout, the agent sends packets with the old password (or null, if there is no old password), and receives packets with either the old or new password. After a timeout expires, the agent sends and receives packets with only the new password; received packets that use the old password are discarded.
If you are changing the password for an entire load-balanced environment, set a longer timeout. The extended timeout allows enough time for you to update the password on all agents and servers before the timeout expires. It also prevents mismatches between agents and servers that have the new password and agents and servers that have the old password.
Examples
This example shows how to initiate DFP agent configuration mode, configure DFP, set the password to flounder, and configure a 60-second timeout:
Related Commands
agent
Use the agent command in the SLB DFP submode to configure the DFP agent to which the CSM is going to communicate. Use the no form of this command to remove the agent configuration.
- agent ip-address port [keepalive-timeout [retry-count [retry-interval]]]
- no agent ip-address port
Syntax Description
Defaults
The keepalive-timeout default is 0 (no keepalive message).
Retry count default is 0 seconds (the default allows infinite retries).
The retry-interval default is 180 seconds.
Command Modes
SLB DFP configuration submode.
Command History
Examples
This example shows how to initiate the DFP agent, configure a 350-second timeout, and configure the number of retries to 270:
Related Commands
dfp
manager
show module csm dfp
manager
Use the manager command in SLB DFP submode to set the port where an external DFP can connect to the CSM. Use the no form of this command to remove the manager configuration.
- manager port
- no manager
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB DFP configuration submode.
Command History
Usage Guidelines
This command enables the CSM to listen to DFP connections from an external DFP manager.
Examples
This example shows how to set the DFP manager port:
Related Commands
ft group
Use the ft group command to enter the fault-tolerant configuration submode and configure fault tolerance. Use the no form of this command to remove the fault-tolerant configuration.
- ft group group-id vlan vlan-id
- no ft group
Syntax Description
Defaults
This command has no default settings.
Command Modes
Module CSM configuration submode.
Command History
Usage Guidelines
A fault-tolerant group is comprised of two Catalyst 6000 family switches each containing a CSM configured for fault-tolerant operation. Each fault-tolerant group appears to network devices as a single device. A network may have more than one fault-tolerant group.
Examples
This example shows how to configure a fault-tolerant group named 123 on VLAN 5:
Related Commands
failover
heartbeat-time
preempt
priority
show module csm ft
failover
Use the failover command in the SLB fault-tolerant configuration submode to set the time for a standby CSM to wait before becoming an active CSM. Use the no form of this command to remove the failover configuration.
- failover failover-time
- no failover
Syntax Description
|
Amount of time the CSM must wait after the last heartbeat message is received before assuming the other CSM is not operating; the range is from 1 to 65535. |
Defaults
The default failover time is 3 seconds.
Command Modes
SLB fault-tolerant configuration submode.
Command History
Examples
This example shows how to set a failover period of 6 seconds:
Related Commands
heartbeat-time
Use the heartbeat-time command in the SLB fault-tolerant configuration submode to set the time before heartbeat messages are transmitted by the CSM. Use the no form of this command to restore the default heartbeat interval.
- heartbeat-time heartbeat-time
- no heartbeat-time
Syntax Description
Defaults
The default heartbeat time is 1 second.
Command Modes
SLB fault-tolerant configuration submode.
Command History
Examples
This example shows how to set the heartbeat time to 2 seconds:
Related Commands
preempt
Use the preempt command in the SLB fault-tolerant configuration submode to allow a higher priority CSM to take control of a fault-tolerant group when it comes online. Use the no form of this command to restore the preempt default value.
- preempt
- no preempt
Syntax Description
This command has no arguments or keywords.
Defaults
The default value is that preempt is not specified.
Command Modes
SLB fault-tolerant configuration submode.
Command History
Usage Guidelines
When you enable preempt, the higher priority CSM preempts the other CSM in the fault-tolerant group when the higher priority CSM comes online. When you enable no preempt, the current primary CSM remains the primary CSM when the next CSM comes online.
 |
Note You must set both members of the fault-tolerant CSM pair to preempt for this feature to work. |
Examples
This example shows how to set the fault-tolerance mode to preempt:
Related Commands
ft group
priority
show module csm ft
priority
Use the priority command in the SLB fault-tolerant configuration submode to set the priority of the CSM. Use the no form of this command to restore the priority default value.
- priority value
- no priority
Syntax Description
Defaults
The default priority value is 10.
Command Modes
SLB fault-tolerant configuration submode.
Command History
Usage Guidelines
The CSM with the largest priority value is the primary CSM in the fault-tolerant pair when the modules are both operating.
Examples
This example shows how to set the priority value to 12:
Related Commands
ft group
preempt
show module csm ft
ip slb mode
Use the ip slb mode command to configure the switch to operate as a CSM load-balancing device instead of a Cisco IOS SLB load-balancing device. Use the no form of this command to remove the mode configuration.
- ip slb mode {csm | rp}
- no ip slb mode
-
Note Specifying the no ip slb mode command is the same as specifying the rp mode.
Syntax Description
Defaults
Command Modes
Command History
Usage Guidelines
This command allows you to change from the Cisco IOS SLB load-balancing mode to the CSM load-balancing mode.
|
Note In csm mode, all ip slb commands apply to a CSM module; Cisco IOS SLB is not available. In rp mode (the default), ip slb commands apply to Cisco IOS SLB; the module csm commands are available to configure multiple CSMs. |
Examples
This example shows how to configure the switch mode:
Related Commands
module csm
show ip slb mode
map cookie
Use the map cookie command to create a cookie map and enter the cookie map configuration submode for specifying cookie match rules. Use the no form of this command to remove the cookie maps from the configuration.
- map cookie-map-name cookie
- no map cookie-map-name
Syntax Description
Defaults
This command has no default settings.
Command Modes
Module CSM configuration submode.
Command History
Examples
This example shows how to create a cookie map:
Related Commands
cookie-map (SLB policy configuration submode)
match protocol http cookie
show module csm map
match protocol http cookie
Use the match protocol http cookie command in SLB cookie map configuration submode to add cookies to a cookie map. Multiple match rules can be added to a cookie map. Use the no form of this command to remove the cookie map name from the cookie map.
- match protocol http cookie cookie-name cookie-value cookie-value-expression
Syntax Description no match protocol http cookie cookie-name
Defaults
This command has no default settings.
Command Modes
SLB cookie map configuration submode.
Usage Guidelines
Cookie regular expressions are based on the UNIX filename specification. URL expressions are stored in a cookie map in the form cookie-name = cookie-value-expression. Cookie expressions allow spaces provided they are escaped or quoted. You must match all cookies in the cookie map.
"*" means zero or more characters
"?" means exactly one character—the [Ctrl + V] key combination must be entered
Bracketed range (for example, [0-9]) means matching any single character from the range
A leading ^ in a range means do not match any in the range
".\b" means backspace (ASCII 8
".\f" means form-feed (ASCII 12)
".\n" means newline (ASCII 10)
".\r" means carriage return (ASCII 13)
".\v" means vertical tab (ASCII 11)
".\x##" means any ASCII character as specified in two-digit hexadecimal notation
Command History
Examples
This example shows how to add cookies to a cookie map:
Related Commands
cookie-map (SLB policy configuration submode)
map cookie
show module csm map
map header
Use the map header command to create a map group for specifying HTTP headers and enter the header map configuration submode. Use the no form of this command to remove the HTTP header group from the configuration.
- map name header
- no map name
Syntax Description
Defaults
This command has no default settings.
Command Modes
Module CSM configuration submode.
Command History
Examples
This example shows how to group HTTP headers and associate them with a Content Switching policy:
Related Commands
header-map (SLB policy configuration submode)
match protocol http header
show module csm map
match protocol http header
Use the match protocol http header command in SLB header map configuration submode to specify header fields and values for the CSM to search for when receiving a request. Multiple match rules can be added to a header map. Use the no form of this command to remove the header match rule from the header map.
- match protocol http header field header-value expression
- no match protocol http header field
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB header map configuration submode.
Usage Guidelines
There are predefined fields, for example Accept-Language, User-Agent, or Host.
Header regular expressions are based on the UNIX filename specification. URL expressions are stored in a header map in the form header-name = expression. Header expressions allow spaces provided that they are escaped or quoted. All headers in the header map must be matched.
"*" means zero or more characters
"?" means exactly one character—the [Ctrl + V] key combination must be entered
Bracketed range (for example, [0-9]) means matching any single character from the range
A leading ^ in a range means don't match any in the range
".\b" means backspace (ASCII 8
".\f" means form-feed (ASCII 12)
".\n" means newline (ASCII 10)
".\r" means carriage return (ASCII 13)
".\v" means vertical tab (ASCII 11)
".\x##" means any ASCII character as specified in two-digit hexadecimal notation
Command History
Examples
This example shows how to specify header fields and values to search upon a request:
Related Commands
header-map (SLB policy configuration submode)
map header
show module csm map
map retcode
Use the map retcode command to enable return error code checking and enter the return error code map submode. Use the no form of this command to remove the return code error checking from the configuration.
- map name retcode
- no map name
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command History
Examples
This example shows how to enable return error code checking:
Related Commands
cookie-map (SLB policy configuration submode)
match protocol http cookie
show module csm map
match protocol http retcode
Use the match protocol http retcode command in SLB return code map configuration submode to specify return code thresholds, count and log return codes, and send syslog messages for return code events received from the servers. Use the no form of this command to remove the return code thresholds.
- match protocol http retcode min max action {count | log | remove} threshold [reset seconds]
- no match protocol http retcode min max
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB return code map configuration submode.
Usage Guidelines
The threshold and reset values are not configurable for the count action. These commands only are available for the log and remove actions.
Command History
Examples
This example shows how to specify return codes values to search for in an HTTP request:
Related Commands
map retcode (SLB policy configuration submode
map url
Use the map url command to enter the SLB URL map mode and configure a URL map. Use the no form of this command to remove the URL map from the configuration.
- map url-map-name url
- no map url-map-name
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB URL map configuration submode.
Command History
Usage Guidelines
Any match of a URL regular expression in the URL map results in a successful match. A maximum of 1023 URLs can be configured to a map.
Examples
This example shows how to group URLs and associate them with a Content Switching policy:
Related Commands
match protocol http url
url-map (SLB policy configuration submode)
show module csm map
match protocol http url
Use the match protocol http url command in the SLB URL map configuration submode to add a URL regular expression to a URL map. Multiple match rules can be added to a URL map. Use the no form of this command to remove the URL regular expression from the URL map.
- match protocol http url urln
- no match protocol http url urln
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB URL map configuration submode.
Usage Guidelines
URL regular expressions are based on the UNIX filename specification. URL expressions are stored in a cookie map in the form urln. URL expressions do not allow spaces and only one of the URLs in the map must be matched.
"*" means zero or more characters
"?" means exactly one character—the [Ctrl + V] key combination must be entered
Bracketed range (for example, [0-9]) means matching any single character from the range
A leading ^ in a range means don't match any in the range
".\b" means backspace (ASCII 8
".\f" means form-feed (ASCII 12)
".\n" means newline (ASCII 10)
".\r" means carriage return (ASCII 13)
".\v" means vertical tab (ASCII 11)
".\x##" means any ASCII character as specified in two-digit hexadecimal notation
Command History
Examples
This example shows how to adds URL expressions to a URL map:
Related Commands
map url
url-map (SLB policy configuration submode)
show module csm map
module csm
Use the module csm command to allow the association of load-balancing commands to a specific CSM module and enter the CSM module configuration submode for the specified slot. Use the no form of this command to remove the module csm configuration.
|
Note The module ContentSwitching Module slot command is the full syntax; the module csm slot command is a valid shortcut. |
- module csm slot-number
- no module csm slot-number
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command History
Usage Guidelines
If you want to use the new multiple module configuration, you must change the ip slb mode command to rp. An existing CSM configuration is migrated to the new configuration when you change the mode from csm to rp. A prompt appears requesting a slot number. Migrating from a multiple module configuration to a single module configuration is supported. Migrating the Cisco IOS SLB configuration to the CSM configuration is not supported.
Examples
This example shows how to configure a CSM:
Related Commands
natpool
Use the natpool command in module CSM configuration submode to configure NAT and create a client address pool. Use the no form of this command to remove a natpool configuration.
- natpool pool-name start-ip end-ip {netmask netmask | prefix-length leading_1_bits}
- no natpool pool-name
Syntax Description
Defaults
This command has no default settings.
Command Modes
Module CSM configuration submode.
Command History
Usage Guidelines
If you want to use client NAT, you must create at least one client address pool.
A maximum of 255 NAT pool addresses are available for any CSM.
Examples
This example shows how to configure a pool of addresses with the name web-clients, an IP address range from 128.3.0.1 through 128.3.0.254, and a subnet mask of 255.255.0.0:
Related Commands
nat client (SLB serverfarm configuration submode)
show module csm natpool
policy
Use the policy command to configure policies, associate attributes to a policy, and enter the policy configuration submode. In this submode, you can configure the policy attributes. The policy is associated with a virtual server in virtual server submode. Use the no form of this command to remove a policy.
- policy policy-name
- no policy policy-name
Syntax Description
Defaults
This command has no default settings.
Command Modes
Module CSM configuration submode.
Command History
Usage Guidelines
Policies establish rules for balancing connections to servers. They can contain URL maps, cookie maps, header maps, client groups, sticky groups, DSCP values, and server farms. The order in which policies are linked to a virtual server determines the precedence of the policy. When two or more policies match a requested URL, the policy with the highest precedence is selected.
You can create up to 12287 SLB policies for a given CSM module.
|
Note All policies should be configured with a server farm. |
Examples
This example shows how to configure a policy named policy_content:
Related Commands
slb-policy (SLB virtual server configuration submode)
show module csm policy
client-group
Use the client-group command in SLB policy configuration submode to associate an access list with the policy. Use the no form of this command to remove access list from the policy.
- client-group {1-99 | std-access-list-name}
- no client-group
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB policy configuration submode.
Command History
Usage Guidelines
Only client groups created with the ip access-list standard command can be associated with an SLB policy. Only one client-group can be associated with a given SLB policy.
Examples
This example shows how to configure a client group:
Related Commands
policy
ip access-list standard
show module csm policy
cookie-map
Use the cookie-map command in SLB policy configuration submode to associate a list of cookies with a policy. Use the no form of this command to remove a cookie map.
- cookie-map cookie-map-name
- no cookie-map
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB policy configuration submode.
Command History
Usage Guidelines
Only one cookie map can be associated with a policy. Cookie maps are configured using the map cookie command. The cookie map name must match the name specified in the map cookie command.
Examples
This example shows how to configure a cookie-based SLB policy named policy_content:
Related Commands
policy
map cookie
show module csm policy
header-map
Use the header-map command in SLB policy configuration submode to specify the HTTP header criteria to include in a policy. Use the no form of this command to remove a header map.
|
Note If any HTTP header information is matched, the policy rule is satisfied. |
- header-map name
- no header-map
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB policy configuration submode.
Command History
Usage Guidelines
Only one header map can be associated with a policy. The header map name must match the name specified in the map header command on page A-18.
Examples
This example shows how to configure a header-based policy named policy_content:
Related Commands
policy
map header
show module csm policy
serverfarm
Use the serverfarm command in the SLB policy configuration submode to associate a server farm with a policy. Use the no form of this command to remove the server farm from the policy.
- serverfarm serverfarm-name
- no serverfarm
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB policy configuration submode.
Command History
Usage Guidelines
Use the serverfarm command to configure the server farm. Only one server farm can be configured per policy. The server farm name must match the name specified in the serverfarm module CSM configuration submode command.
Examples
This example shows how to associate a server farm named central with a policy:
Related Commands
policy
serverfarm (module CSM configuration submode)
show module csm policy
set ip dscp
Use the set ip dscp command in the SLB policy configuration submode to mark packets that match the policy with a DSCP value. Use the no form of this command to stop marking packets.
- set ip dscp dscp-value
- no set ip dscp
Syntax Description
Defaults
The default is that the CSM does not store DSCP values.
Command Modes
SLB policy configuration submode.
Command History
Examples
This example shows how to mark packets to match a policy named policy_content:
Related Commands
sticky-group
Use the sticky-group command in the SLB policy configuration submode to associate a sticky group and the sticky group attributes to the policy. Use the no form of this command to remove the sticky group from the policy.
- sticky-group group-id
- no sticky-group
Syntax Description
Defaults
The default is 0, which means that no connections are sticky.
Command Modes
SLB policy configuration submode.
Command History
Usage Guidelines
The group-id must match the ID specified in the sticky command; the range is from 1 to 255.
Examples
This example shows how to configure a sticky group:
Related Commands
policy
sticky
show module csm policy
show module csm sticky
url-map
Use the url-map command in SLB policy configuration submode to associate a list of URLs with the policy. Use the no form of this command to remove the URL map from the policy.
- url-map url-map-name
- no url-map
Syntax Description
Defaults
Command Modes
SLB policy configuration submode.
Command History
Usage Guidelines
Only one URL map can be associated with a policy. URL maps are configured using the map url command.
Examples
This example shows how to associate a list of URLs with a policy named assembly:
Related Commands
policy
map url
show module csm policy
probe
Use the probe command to configure a probe and probe type for health monitoring and to enter the probe configuration submode. Use the no form of this command to remove a probe from the configuration.
- probe probe-name {http | icmp | telnet | tcp | ftp | smtp | dns}
- no probe probe-name
Syntax Description
Defaults
This command has no default settings.
Command Modes
Module CSM configuration submode.
Command History
Usage Guidelines
A probe can be assigned to a server farm in serverfarm submode.
Examples
This example shows how to configure an HTTP probe named TREADER:
Related Commands
probe (SLB serverfarm configuration submode)
show module csm probe
address (dns)
Use the address command in SLB DNS probe configuration submode to specify an IP address of the real server used by DNS to resolve requests. Use the no form of this command to remove the address.
- address ip-address
- no address ip-address
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB DNS probe configuration submode.
Command History
Usage Guidelines
Multiple addresses can be configured for a DNS probe.
Examples
This example shows how to configure an IP address of the DNS server:
Related Commands
probe
address (icmp)
show module csm probe
address (icmp)
Use the address command in SLB ICMP probe configuration submode to specify a destination IP address for health monitoring. Use the no form of this command to remove the address.
- address ip-address
- no address
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB ICMP probe configuration submode.
Command History
Usage Guidelines
One address can be configured for an ICMP probe.
Examples
This example shows how to configure an IP address of the real server:
Related Commands
probe
address (dns)
show module csm probe
credentials
Use the credentials command in the SLB HTTP probe configuration submode to configure basic authentication values for an HTTP probe. Use the no form of this command to remove the credentials configuration.
- credentials username [password]
- no credentials
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB HTTP probe configuration submode.
Command History
Usage Guidelines
This command is for HTTP probes.
Examples
This example shows how to configure authentication for an HTTP probe:
Related Commands
expect status
Use the expect status command in the SLB HTTP/FTP/Telnet/SMTP probe configuration submode to configure a status code for the probe. Use the no form of this command to remove the status code from the configuration.
- expect status min-number [max-number]
- no expect status min-number [max-number]
Syntax Description
Defaults
The default range is 0 to 999 (any response from the server is valid).
Command Modes
SLB HTTP/FTP/Telnet/SMTP probe configuration submode.
Command History
Usage Guidelines
This command is for HTTP, FTP, Telnet, and SMTP probes. You can specify multiple status code ranges with this command by entering one command at a time. If you specify the max-number value, this number is used as the minimum status code of a range. If you specify no maximum number, this command uses a single number (min-number). If you specify both min-number and max-number values, this command uses the range between the numbers.
|
Note When you remove the expect status, you cannot set the range of numbers to 0 or as a range of numbers that includes the values you set for the expect status. The expect status state becomes invalid and does not restore the default range of 0 through 999. To remove the expect status, remove each set of numbers using the no expect status command. For example, enter the no expect status 0 3 command and then enter the no expect status 34 99 command. |
Examples
This example shows how to configure an HTTP probe with multiple status code ranges:
Related Commands
failed
Use the failed command in the SLB probe configuration submode to set the time to wait before probing a failed server. Use the no form of this command to reset the time to wait before probing a failed server to default.
- failed failed-interval
- no failed
Syntax Description
Defaults
The default value for the failed interval is 300 seconds.
Command Modes
SLB probe configuration submode.
Command History
Usage Guidelines
This command is used for all probe types.
Examples
This example shows how to configure a failed server probe for 200 seconds:
Related Commands
header
Use the header command in the SLB HTTP probe configuration submode to configure a header field for the HTTP probe. Use the no form of this command to remove the credentials configuration.
- header field-name [field-value]
- no header field-name
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB HTTP probe configuration submode.
Command History
Usage Guidelines
You can configure multiple headers for each HTTP probe. The length of the field-name value plus the length of the field-value value plus 4 (for ":", space, and CRLF) cannot exceed 255 characters. This command is for HTTP probes.
Examples
This example shows how to configure a header field for the HTTP probe:
Related Commands
interval
Use the interval command in the SLB probe configuration submode to set the time interval between probes. Use the no form of this command to reset the time interval between probes to default.
- interval seconds
- no interval
Syntax Description
|
Number of seconds to wait between probes from the end of the previous probe to the beginning of the next probe; the range is from 5 to 65535. |
Defaults
The default value for the interval between probes is 120 seconds.
Command Modes
SLB probe configuration submode.
Command History
Usage Guidelines
This command is used for all probe types.
Examples
This example shows how to configure a probe interval of 150 seconds:
Related Commands
name
Use the name command in the SLB DNS probe configuration submode to configure a domain name for the DNS probe. Use the no form of this command to remove the name from the configuration.
- name domain-name
- no name
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB DNS probe configuration submode.
Command History
Examples
This example shows how to specify the probe name that is resolved by the DNS server:
Related Commands
open
Use the open command in the SLB HTTP/TCP/FTP/Telnet/SMTP probe configuration submode to set the time to wait for a TCP connection. Use the no form of this command to reset the time to wait for a TCP connection to default.
- open open-timeout
- no open
Syntax Description
Defaults
The default value for the open timeout is 10 seconds.
Command Modes
SLB HTTP/TCP/FTP/Telnet/SMTP probe configuration submode.
Command History
Usage Guidelines
This command is not used for any non-TCP probes, for example, ICMP or DNS.
|
Note There are two different timeout values: open and receive. The open timeout specifies how many seconds to wait for the connection to open (that is, how many seconds to wait for SYN ACK after sending SYN). The receive timeout specifies how many seconds to wait for data to be received (that is, how many seconds to wait for an HTTP reply after sending a GET/HHEAD request). Because TCP probes close as soon as they open without sending any data, the receive timeout is not used. |
Examples
This example shows how to configure a time to wait for a TCP connection of 5 seconds:
Related Commands
receive
Use the receive command in the SLB probe configuration submode to set the time to wait for a reply from a server. Use the no form of this command to reset the time to wait for a reply from a server to default.
- receive receive-timeout
- no receive
Syntax Description
Defaults
The default value for a receive timeout is 10 seconds.
Command Modes
SLB probe configuration submode.
Command History
Usage Guidelines
This command is available for all probe types, except TCP.
|
Note There are two different timeout values: open and receive. The open timeout specifies how many seconds to wait for the connection to open (that is, how many seconds to wait for SYN ACK after sending SYN). The receive timeout specifies how many seconds to wait for data to be received (that is, how many seconds to wait for an HTTP reply after sending a GET/HHEAD request). Because TCP probes close as soon as they open without sending any data, the receive timeout is not used. |
Examples
This example shows how to configures a time to wait for a reply from a server to 5 seconds:
Related Commands
request
Use the request command in the SLB HTTP probe configuration submode to configure the request method used by the HTTP probe. Use the no form of this command to remove the request method from the configuration.
- request [method {get | head}]] [url path]
- no request [method {get | head}] [url path]
Syntax Description
Defaults
The default path is /.
The default method is get.
Command Modes
SLB HTTP probe configuration submode.
Command History
Usage Guidelines
The CSM supports only the get and head request methods. It does not support post and other methods. This command is for HTTP probes.
Examples
This example shows how to configure a request method for the probe configuration:
Related Commands
retries
Use the retries command in the SLB probe configuration submode to set the number of failed probes that are allowed before marking the server failed. Use the no form of this command to reset the number of failed probes allowed before marking a server as failed to default.
- retries retry-count
- no retries
Syntax Description
Defaults
The default value for retries is 3.
Command Modes
SLB probe configuration submode.
Command History
Usage Guidelines
This command is used for all probe types.
|
Note Set retries to 2 or more. If retries are set to 1, a single dropped probe packet will bring down the server. A setting of 0 places no limit on the number of probes that are sent. Retries are sent until the system reboots. |
Examples
This example shows how to configure a retry count of 3:
Related Commands
real
Use the real command in the SLB serverfarm configuration submode to identify a real server that is a member of the server farm and enter the real server configuration submode. Use the no form of this command to remove the real server from the configuration.
- real ip-address [port]
- no real ip-address [port]
Syntax Description
Defaults
The default is no port translation for the real server.
Command Modes
SLB serverfarm configuration submode.
Usage Guidelines
Use this command to identify a real server that is a member of the server farm and enter the real server configuration submode.
|
Note The IP address that you supply provides a load-balancing target for the CSM. This target can be any IP addressable object. For example, the IP addressable object may be a real server, a firewall, or an alias IP address of another CSM. |
Command History
Examples
This example shows how to identify a real server and enter the real server submode:
Related Commands
serverfarm
show module csm real
show module csm serverfarm
inservice
Use the inservice command in the SLB real server configuration submode to enable the real servers. Use the no form of this command to remove a real server from service.
- inservice
- no inservice
Syntax Description
This command has no arguments or keywords.
Defaults
The default for a real server is no inservice.
Command Modes
SLB real server configuration submode.
Command History
Examples
This example shows how to enable a real server:
Related Commands
real (SLB serverfarm submode)
show module csm real
maxconns
Use the maxconns command in the SLB real server configuration submode to limit the number of active connections to the real server. Use the no form of this command to change the maximum number of connections to its default value.
- maxconns max-conns
- no maxconns
Syntax Description
|
Maximum number of active connections on the real server at any one point in time; the range is from 1 to 4294967295. |
Defaults
The default value is the maximum value or infinite (not monitored).
Command Modes
SLB real server configuration submode.
Command History
Usage Guidelines
When you specify minconns, you must also specify the maxconns command.
Examples
This example shows how to limit the connections to a real server:
Related Commands
minconns (real server submode)
real (serverfarm submode)
show module csm real
minconns
Use the minconns command in the SLB real server configuration submode to establish a minimum connection threshold for the real server. Use the no form of this command to change the minimum number of connections to the default value.
- minconns min-cons
- no minconns
Syntax Description
Defaults
The default value is no minconns.
Command Modes
SLB real server configuration submode.
Command History
Usage Guidelines
When the maxconns threshold is exceeded, the CSM stops sending connections until the number of connections falls below the minconns threshold. This value must be lower than the maximum number of connections configured by the maxconns command. When you specify minconns, you must also specify the maxconns command.
Examples
This example shows how to establish a minimum connection threshold for a server:
Related Commands
maxconns (real server submode)
real (serverfarm submode)
show module csm real
redirect-vserver
Use the redirect-vserver command in the SLB real server configuration submode to configure a real server to receive traffic redirected by a redirect virtual server. Use the no form of this command to specify that traffic is not redirected to the real server.
- redirect-vserver name
- no redirect-vserver
Syntax Description
Defaults
The default is no redirect-vserver.
Command Modes
SLB real server configuration submode.
Command History
Usage Guidelines
Mapping real servers to redirect virtual servers provides persistence for clients to real servers across TCP sessions. Before using this command, you must create the redirect virtual server in serverfarm submode with the redirect-vserver command.
Examples
This example shows how to map a real server to a virtual server:
Related Commands
real (SLB serverfarm configuration submode)
redirect-vserver (SLB serverfarm configuration submode)
show module csm real
show module csm vserver redirect
weight
Use the weight command in the SLB real server configuration submode to configure the capacity of the real servers in relation to the other real servers in the server farm. Use the no form of this command to change the server's weight to its default capacity.
- weight weighting-value
- no weight
Syntax Description
Defaults
The weighting value default is 8.
Command Modes
SLB real server configuration submode.
Command History
Examples
This example shows how to configure the weight of a real server:
Related Commands
predictor (SLB serverfarm submode)
real (SLB serverfarm submode)
show module csm real
redirect-vserver
Use the redirect-vserver command in submode to specify the name of a virtual server to receive traffic redirected by the server farm and enter redirect virtual server configuration submode. Use the no form of this command to remove the redirect virtual server.
- redirect-vserver name
- no redirect-vserver name
Syntax Description
|
Name of the virtual server to receive traffic redirected by the server farm; the virtual server name can be no longer than 15 characters. |
Defaults
This command has no default settings.
Command Modes
SLB serverfarm configuration submode.
Command History
Examples
This example shows how to name the virtual server:
Related Commands
real (SLB serverfarm submode)
redirect-vserver (SLB real server submode)
serverfarm
show module csm serverfarm
show module csm vserver redirect
advertise
Use the advertise command in the SLB redirect virtual server configuration mode to allow the CSM to advertise the IP address of the virtual server as host-route. Use the no form of this command to stop advertising the host-route for this virtual server.
- advertise [active]
- no advertise
Syntax Description
|
(Optional) Keyword to allow the CSM to advertise the IP address of the virtual server as host-route. |
Defaults
The default for network mask is 255.255.255.255 if the network mask is not specified.
Command Modes
SLB redirect virtual server configuration submode.
Usage Guidelines
Without the active option, the CSM always advertises the virtual server IP address whether or not there is any active real server attached to this virtual server.
Command History
Examples
This example shows how to restrict a client from using the redirect virtual server:
Related Commands
vserver
show module csm vserver redirect
client
Use the client command in the SLB redirect virtual server configuration mode to restrict which clients are allowed to use the redirect virtual server. Use the no form of this command to remove the client definition from the configuration.
- client ip-address [network-mask] [exclude]
- no client ip-address [network-mask]
Syntax Description
Defaults
The default for network mask is 255.255.255.255 if the network mask is not specified.
Command Modes
SLB redirect virtual server configuration submode.
Usage Guidelines
The network mask is applied to the source IP address of incoming connections and the result must match the IP address before the client is allowed to use the virtual server. If you do not specify exclude, the IP address and network mask combination is allowed.
Command History
Examples
This example shows how to restrict a client from using the redirect virtual server:
Related Commands
client-group (SLB policy submode)
vserver
show module csm vserver redirect
idle
Use the idle command in the SLB redirect virtual server configuration submode to specify the connection idle timer duration. Use the no form of this command to disable the idle timer.
- idle duration
- no idle
Syntax Description
Defaults
Command Modes
SLB redirect virtual server configuration submode.
Command History
Examples
This example shows how to specify the connection idle timer duration:
Related Commands
redirect-vserver (SLB serverfarm submode)
show module csm vserver redirect
inservice
Use the inservice command in the SLB redirect virtual server configuration submode to enable the real server for use by the CSM. If this command is not specified, the virtual server is defined but not used. Use the no form of this command to disable the virtual server.
- inservice
- no inservice
Syntax Description
This command has no arguments or keywords.
Defaults
Command Modes
SLB redirect virtual server configuration submode.
Command History
Examples
This example shows how to enable a redirect virtual server for use by the CSM:
Related Commands
redirect-vserver (SLB serverfarm submode)
show module csm vserver redirect
replicate csrp
Use the replicate csrp command in the SLB redirect virtual server configuration submode to enable connection redundancy. Use the no form of this command to remove connection redundancy.
- replicate csrp
- no replicate csrp
Syntax Description
This command has no keywords or arguments.
Defaults
The default is no replicate csrp.
Command Modes
SLB virtual server configuration submode.
Command History
Examples
This example shows how to enable connection redundancy:
Related Commands
vserver
show module csm vserver redirect
ssl
Use the ssl command in the SLB redirect virtual server configuration submode to redirect an HTTP request to either HTTPS (SSL)_ or the FTP service. Use the no form of this command to reset the redirect of an HTTP request to an HTTP service.
- ssl {https | ftp | ssl-port-number}
- no ssl
Syntax Description
Defaults
The default is no ssl forwarding.
Command Modes
SLB redirect virtual server configuration submode.
Command History
Examples
This example shows how to enable SSL forwarding:
Related Commands
redirect-vserver (SLB serverfarm submode)
show module csm vserver redirect
virtual
Use the virtual command in SLB redirect virtual server configuration submode to specify the virtual server's IP address, the protocol used for traffic, and the port the protocol is using. Use the no form of this command to reset the virtual server to its defaults.
- virtual v_ipaddress tcp port
- no virtual v_ipaddress
Syntax Description
Defaults
The default IP address is 0.0.0.0, which prevents packet forwarding.
Command Modes
SLB redirect virtual server configuration submode.
Command History
Examples
This example shows how to specify the virtual server's IP address, the protocol for redirect virtual server traffic, and the port number used by the protocol:
Related Commands
redirect-vserver (SLB serverfarm submode)
show module csm vserver redirect
vlan
Use the vlan command in the SLB redirect virtual server submode to define which source VLANs can be accessed on the redirect virtual server. Use the no form of this command to remove the VLAN.
- vlan {vlan-number | all}
- no vlan
Syntax Description
Defaults
Command Modes
SLB virtual server configuration submode.
Command History
Examples
This example shows how to specify a VLAN for redirect virtual server access:
Related Commands
sticky
sticky-group (SLB policy submode)
show module csm sticky
show module csm vserver redirect
webhost backup
Use the webhost backup command in SLB redirect virtual server configuration submode to specify a backup string sent in response to HTTP requests. Use the no form of this command to disable the backup string.
- webhost backup backup-string [301 | 302]
- webhost backup
Syntax Description
Defaults
The default status code is 302.
Command Modes
SLB redirect virtual server configuration submode.
Usage Guidelines
This command is used in situations where the redirect virtual server has no available real servers. 301 or 302 is used to specify the redirect code. The backup string may include a %p at the end to indicate inclusion of the path in the HTTP redirect location statement field.
Command History
Examples
This example shows how to specify a backup string that is sent in response to HTTP requests:
Related Commands
redirect-vserver (SLB serverfarm submode)
show module csm vserver redirect
webhost relocation
Use the webhost relocation command in the SLB redirect virtual server configuration submode to specify a relocation string sent in response to HTTP requests. Use the no form of this command to disable the relocation string.
- webhost relocation relocation string [301 | 302]
- no webhost relocation
Syntax Description
Defaults
The default status code is 302.
Command Modes
SLB redirect virtual server configuration submode.
Usage Guidelines
The backup string may include a %p at the end to indicate inclusion of the path in the HTTP redirect location statement field.
Command History
Examples
This example shows how to specify a relocation string that is sent in response to HTTP requests:
Related Commands
redirect-vserver (SLB serverfarm submode)
show module csm vserver redirect
serverfarm
Use the serverfarm command to identify a server farm and enter the serverfarm configuration submode. Use the no form of this command to remove the server farm from the configuration.
- serverfarm serverfarm-name
- no serverfarm serverfarm-name
Syntax Description
|
Character string used to identify the server farm; the character string is limited to 15 characters. |
Defaults
This command has no default settings.
Command Modes
Module CSM configuration submode.
Usage Guidelines
Use this command to enter the server farm configuration submode to configure the load-balancing algorithm (predictor), a set of real servers, and the attributes (NAT, probe, and bindings) of the real servers.
Command History
Examples
This example shows how to identify a server farm named PUBLIC and change the CLI to server farm configuration mode:
Related Commands
serverfarm (SLB policy configuration submode)
serverfarm (SLB virtual server configurations submode)
show module csm serverfarm
bindid
Use the bindid command in the SLB serverfarm configuration submode to assign a unique ID to allow the DFP agent to differentiate a real server in one server farm versus another server farm. Use the no form of this command to disable the bindid.
- bindid [bind-id]
- no bindid
Syntax Description
Defaults
Command Modes
SLB serverfarm configuration submode.
Usage Guidelines
The single real server is represented as multiple instances of itself, each having a different bind identification. DFP uses this identification to identify a given weight for each instance of the real server.
Command History
Examples
This example shows how to bind a server to multiple virtual servers:
Related Commands
dfp
serverfarm
show module csm serverfarm
failaction purge
Use the failaction purge command in the SLB serverfarm configuration submode to set the behavior of connections to real servers that have failed. Use the no form of this command to disable the behavior of connections to real servers that have failed.
- failaction purge
- no failaction purge
Syntax Description
This command has no arguments or keywords.
Defaults
The default is no failaction purge.
Command Modes
SLB serverfarm configuration submode.
Usage Guidelines
With this command enabled, connections to a real server in the server farm are purged when the real server goes down. This feature is required for VPN load balancing.
Command History
Examples
This example shows how to set the behavior of connections to real servers that have failed:
Related Commands
dfp
serverfarm
show module csm serverfarm
health
Use the health command in the SLB serverfarm configuration submode to set the retry attempts to real servers that have failed. Use the no form of this command to disable the retries or the time to wait for connections to real servers that have failed.
- health retries count failed seconds
- no health
Syntax Description
Defaults
There are no default settings.
Command Modes
SLB serverfarm configuration submode.
Command History
Examples
This example shows how to set the behavior of connections to real servers that have failed:
Related Commands
dfp
serverfarm
show module csm serverfarm
nat client
Use the nat client command in SLB serverfarm configuration submode to specify a set of client NAT pool addresses that should be used to perform the NAT function on clients connecting to this server farm. Use the no form of this command to remove the NAT pool from the configuration.
- nat client client-pool-name
- no nat client
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB serverfarm configuration submode.
Usage Guidelines
Use this command to enable client NAT. If client NAT is configured, the client address and port number in load-balanced packets are replaced with an IP address and port number from the specified client NAT pool. This client pool name must match the pool name entered from a previous natpool command.
Command History
Examples
This example shows how to specify NAT on the client:
Related Commands
natpool
serverfarm
nat server
predictor
show module csm serverfarm
nat server
Use the nat server command in SLB serverfarm configuration submode to specify NAT to servers in this server farm. Use the no form of this command to disable server NAT.
- nat server
- no nat server
Syntax Description
This command has no arguments or keywords.
Defaults
Server NAT is enabled by default.
Command Modes
SLB server farm configuration submode.
Usage Guidelines
Use this command to enable server NAT. If server NAT is configured, the server address and port number in load-balanced packets are replaced with an IP address and port number of one of the real servers in the server farm.
|
Note The nat server command has no effect when predictor forward is configured, because no servers can be configured. |
Command History
Examples
This example shows how to specify NAT on the server:
Related Commands
serverfarm
nat client
predictor
show module csm serverfarm
predictor
Use the predictor command in the SLB serverfarm configuration submode to specify the load-balancing algorithm for the server farm. Use the no form of this command to remove the load-balancing algorithm.
- predictor {roundrobin | leastconns | hash url | hash address [source | destination] [ip-netmask] | forward}]
- no predictor
Syntax Description
Defaults
The default algorithm is round robin.
Command Modes
SLB serverfarm configuration submode.
Usage Guidelines
Use this command to define the load-balancing algorithm used in choosing a real server in the server farm. If you do not specify the predictor command, the default algorithm is roundrobin. Using the no form of this command changes the predictor algorithm to the default algorithm.
|
Note The nat server command has no effect when predictor forward is configured, because no servers can be configured. |
The portion of the URL to hash is based on the expressions configured for the virtual server submode command url-hash.
No real servers are needed. The server farm is actually a route forwarding policy with no real servers associated with it.
Command History
Examples
This example shows how to specify the load-balancing algorithm for the server farm:
Related Commands
nat client
nat server
maxconns
minconns
serverfarm
show module csm serverfarm
serverfarm (SLB virtual server configuration submode)
probe
Use the probe command in the SLB serverfarm configuration submode to associate a probe with a server farm. Use the no form of this command to disable a specific probe.
- probe probe-name
- no probe probe-name
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB serverfarm configuration submode.
Usage Guidelines
Each server farm can be associated with multiple probes of the same or different protocols. Protocols supported by the CSM include HTTP, ICMP, TCP, FTP, SMTP, Telnet, and DNS.
Command History
Examples
This example shows how to associate a probe with a server farm:
Related Commands
probe (Module CSM configuration submode)
serverfarm
show module csm probe
show module csm serverfarm
retcode-map
Use the retcode-map command in the SLB serverfarm configuration submode to assign a return code map to a server farm. Use the no form of this command to disable a specific probe.
- retcode-map retcodemap_name
- no retcode-map
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB serverfarm configuration submode.
Command History
Examples
This example shows how to associate a probe with a server farm:
Related Commands
map retcode (Module CSM configuration submode)
serverfarm
show module csm serverfarm
static
Use the static command to configure the server NAT behavior and enter the NAT configuration submode. This command configures the CSM to support connections initiated by real servers. Both client NAT and server NAT can exist in the same configuration. Use the no form of this command to remove NAT from the CSM configuration.
- static {drop | nat {virtual | ip-address}}
- no static {drop | nat {virtual | ip-address}}
Syntax Description
|
Keyword to drop connections from servers specified in static submode. |
|
|
Keyword to use the server's Virtual IP (VIP) to NAT its source IP address. |
|
Defaults
This command has no default settings.
Command Modes
Module CSM configuration submode.
Command History
Examples
This example shows how to configure the CSM to support connections initiated by the real servers:
Related Commands
real
Use the real command in SLB static NAT configuration submode to specify the address for a real server or the subnet mask for multiple real servers performing server NAT. Use the no form of this command to remove the address of a real server or the subnet mask of multiple real servers so they are no longer performing NAT.
- real real-ip-address [real-netmask]
- no real real-ip-address [real-netmask]
Syntax Description
|
(Optional) Range of real servers performing NAT. If not specified, the default is 255.255.255.255 (a single real server). |
Defaults
This command has no default settings.
Command Modes
SLB static NAT configuration submode.
Command History
Examples
This example shows how to specify the address for a real server:
Related Commands
sticky
Use the sticky command to ensure that connections from the same client that match the same SLB policy use the same real server on subsequent connections. Use the no form of this command to remove a sticky group.
- sticky sticky-group-id {netmask netmask | cookie name | ssl} [timeout sticky-time]
- no sticky sticky-group-id
Syntax Description no sticky sticky-group-id
|
ID to identify the sticky group instance; the range is from 1 to 255. |
|
|
(Optional) Sticky timer duration in minutes; the range is from 0 to 65535. |
Defaults
The sticky time default value is 1440 minutes (24 hours).
Command Modes
Module CSM configuration submode.
Command History
| Release | Modification |
|---|---|
Usage Guidelines
Specifying a netmask permits sticky connections based on the masked client IP address.
Use the sticky time option to ensure that connections from the same client that match the same SLB policy use the same real server. If you specify a nonzero value, the last real server that was used for a connection from a client is remembered for sticky-time minutes after the end of the client's latest connection. New connections from the client to the virtual server initiated before the sticky time expires and that match SLB policy are balanced to the same real server that was used for the previous connection. A sticky time of 0 means sticky connections are not tracked.
Examples
This example shows how to create an IP sticky group:
Related Commands
sticky-group (SLB policy submode)
sticky (SLB vserver submode)
show module csm sticky
vlan
Use the vlan command to create a client or server VLAN and assign it a VLAN ID and enter the VLAN submode. Use the no form of this command to remove the VLAN from the configuration.
- vlan vlan-id {client | server}
- no vlan vlan-id
Syntax Description
Defaults
This command has no default settings.
Command Modes
Module CSM configuration submode.
Usage Guidelines
A database entry should exist for the given VLAN ID.
Command History
| Release | Modification |
|---|---|
Examples
This example shows how to create a server VLAN and assign it a VLAN ID:
Related Commands
vlan (SLB vserver submode)
show module csm vlan
alias
Use the alias command in the SLB VLAN configuration submode to assign multiple IP addresses to the CSM. Use the no form of this command to remove an alias IP addresses from the configuration.
- alias ip-address netmask
- no alias ip-address netmask
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB VLAN configuration submode.
Usage Guidelines
This command allows you to place the CSM on a different IP network than real servers without using a router.
Command History
Examples
This example shows how to assign multiple IP addresses to the CSM:
Related Commands
gateway
Use the gateway command in the SLB VLAN configuration mode to configure a gateway IP address. Use the no form of this command to remove the gateway from the configuration.
- gateway ip-address
- no gateway ip-address
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB VLAN configuration submode.
Usage Guidelines
You can configure up to seven gateways per VLAN with a total of up to 255 gateways for the entire system. A gateway must be in the same network as specified in the ip address SLB VLAN command.
Command History
Examples
This example shows how to configure a client-side gateway IP address:
Related Commands
ip address (SLB VLAN configuration submode)
vlan
show module csm vlan
ip address
Use the ip address command in the SLB VLAN configuration submode to assign an IP address to the CSM that is used for probes and ARP requests on a VLAN. Use the no form of this command to remove the CSM IP address and disable probes and ARP requests from the configuration.
- ip address ip-address netmask
- no ip address
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB VLAN configuration submode.
Usage Guidelines
This command is applicable for both server and client VLANs. Up to 255 unique VLAN IP addresses are allowed per module.
Command History
| Release | Modification |
|---|---|
|
Increases maximum number of unique VLAN IP addresses per system form 32 to 255. |
Examples
This example shows how to assign an IP address to the CSM:
Related Commands
route
Use the route command in the SLB VLAN configuration submode to configure networks that are one Layer 3 hop away from the CSM. Use the no form of this command to remove the subnet or gateway IP address from the configuration.
- route ip-address netmask gateway gw-ip-address
- no route ip-address netmask gateway gw-ip-address
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB VLAN configuration submode.
Usage Guidelines
You specify the Layer 3 network's subnet address and the gateway IP address to reach the next-hop router. The gateway address must be in the same network as specified in the ip address SLB VLAN command.
Command History
Examples
This example shows how to configure a network to the CSM:
Related Commands
ip address (SLB VLAN configuration submode)
vlan
show module csm vlan
vserver
Use the vserver command to identify a virtual server and enter the virtual server configuration submode. Use the no form of this command to remove a virtual server from the configuration.
- vserver virtserver-name
- no vserver virtserver-name
Syntax Description
|
Character string used to identify the virtual server; the character string is limited to 15 characters. |
Defaults
This command has no default settings.
Command Modes
Module CSM configuration submode.
Command History
Examples
This example shows how to identify a virtual server named PUBLIC_HTTP and change the CLI to virtual server configuration mode:
Related Commands
redirect-vserver (SLB serverfarm submode)
show module csm vserver redirect
advertise
Use the advertise command in the SLB redirect virtual server configuration mode to allow the CSM to advertise the IP address of the virtual server as host-route. Use the no form of this command to stop advertising the host-route for this virtual server.
- advertise [active]
- no advertise
Syntax Description
|
(Optional) Keyword to allow the CSM to advertise the IP address of the virtual server as host-route. |
Defaults
The default for network mask is 255.255.255.255 if the network mask is not specified.
Command Modes
SLB redirect server configuration submode.
Usage Guidelines
Without the active option, the CSM always advertises the virtual server IP address whether or not there is any active real server attached to this virtual server.
Command History
Examples
This example shows how to restrict a client from using the virtual server:
Related Commands
redirect-vserver
show module csm vserver redirect
client
Use the client command in the SLB virtual server configuration mode to restrict which clients are allowed to use the virtual server. Use the no form of this command to remove the client definition from the configuration.
- client ip-address [network-mask] [exclude]
- no client ip-address [network-mask]
Syntax Description
Defaults
The default for network mask is 255.255.255.255 if the network mask is not specified.
Command Modes
SLB virtual server configuration submode.
Usage Guidelines
The network mask is applied to the source IP address of incoming connections and the result must match the IP address before the client is allowed to use the virtual server. If exclude is not specified, the IP address and network mask combination is allowed.
Command History
Examples
This example shows how to restrict a client from using the virtual server:
Related Commands
client-group (SLB policy submode)
ip access-list standard
vserver
show module csm vserver redirect
idle
Use the idle command in the SLB virtual server configuration submode to control the amount of time the CSM maintains connection information in the absence of packet activity. Use the no form of this command to change the idle timer to its default value.
- idle duration
- no idle
Syntax Description
Defaults
Command Modes
SLB virtual server configuration submode.
Usage Guidelines
If you do not specify a duration value, the default value is applied.
Command History
Examples
This example shows how to specify an idle timer duration of 4000:
Related Commands
vserver
show module csm vserver redirect
inservice
Use the inservice command in the SLB virtual server configuration submode to enable the virtual server for load balancing. Use the no form of this command to remove the virtual server from service.
- inservice
- no inservice
Syntax Description
This command has no keywords or arguments.
Defaults
Command Modes
SLB virtual server configuration submode.
Command History
Examples
This example shows how to enable a virtual server for load balancing:
Related Commands
vserver
show module csm vserver redirect
parse-length
Use the parse-length command in the SLB virtual server configuration submode to set the maximum number of bytes to parse for URLs and cookies. Use the no form of this command to restore the default.
- parse-length bytes
- no parse-length
Syntax Description
Defaults
Command Modes
SLB virtual server configuration submode.
Command History
Examples
This example shows how to set the number of bytes to parse for URLs and cookies:
Related Commands
vserver
show module csm vserver redirect
pending
Use the pending command in the SLB virtual server configuration submode to set the pending connection timeout. Use the no form of this command to restore the default.
- pending timeout
- no pending
Syntax Description
Defaults
The default pending timeout is 30 seconds.
Command Modes
SLB virtual server configuration submode.
Usage Guidelines
This command is used to prevent denial of service (DOS) attacks. The pending connection timeout sets the response time for terminating connections if a switch becomes flooded with traffic. The pending connections are configurable on a per virtual server basis.
Command History
Examples
This example shows how to set the number to wait for a connection to be made to the server:
Related Commands
vserver
show module csm vserver redirect
persistent rebalance
Use the persistent rebalance command in the SLB virtual server configuration submode to enable or disable HTTP 1.1 persistence for connections in the virtual server. Use the no form of this command to disable persistence.
- persistent rebalance
- no persistent rebalance
Syntax Description
This command has no keywords or arguments.
Defaults
The default is no persistent rebalance.
Command Modes
SLB virtual server configuration submode.
Command History
Examples
This example shows how to enable the HTTP 1.1 persistence:
Related Commands
vserver
show module csm vserver redirect
replicate csrp
Use the replicate csrp command in the SLB virtual server configuration submode to enable connection redundancy. Use the no form of this command to disable connection redundancy.
- replicate csrp {sticky | connection}
- no replicate csrp {sticky | connection}
Syntax Description
Defaults
Command Modes
SLB virtual server configuration submode.
Usage Guidelines
Sticky and connection replication can be enabled or disabled separately. For replication to occur, you must enable SLB fault tolerance with the ft group command.
Command History
Examples
This example shows how to enable connection redundancy:
Related Commands
ft group
vserver
show module csm vserver redirect
serverfarm
Use the serverfarm command in SLB virtual server configuration submode to associate a server farm with a virtual server. Use the no form of this command to remove a server farm association from the virtual server.
- serverfarm serverfarm-name
- no serverfarm
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB virtual server configuration submode.
Usage Guidelines
The server farm name must match the server farm name specified in a previous module CSM submode serverfarm command.
Command History
Examples
This example shows how to associate a server farm with a virtual server named PUBLIC_HTTP:
Related Commands
serverfarm (Module CSM submode)
serverfarm (SLB policy submode)
show module csm vserver redirect
vserver
slb-policy
Use the slb-policy command in the SLB virtual server configuration submode to associate a load-balancing policy with a virtual server. Use the no form of this command to remove a policy from a virtual server.
- slb-policy policy-name
- no slb-policy policy-name
Syntax Description
Defaults
This command has no default settings.
Command Modes
SLB virtual server configuration submode.
Usage Guidelines
Multiple load-balancing policies can be associated with a virtual server. URLs in incoming requests are parsed and matched against policies defined in the same order in which they are defined with this command. The policy name must match the name specified in a previous policy command.
|
Note The order of the policy association is important; you should enter the highest priority policy first. |
Command History
Examples
This example shows how to associate a policy with a virtual server.:
Related Commands
vserver
policy
show module csm policy
show module csm vserver redirect
sticky
Use the sticky command to ensure that connections from the same client use the same real server. Use the no form of this command to change the sticky timer to its default value and remove the sticky option from the virtual server.
- sticky duration [group group-id] [netmask ip-netmask]
- no sticky
Syntax Description
Defaults
The default is no sticky. Sticky connections are not tracked.
The group ID default is 0. The sticky feature is not used for other virtual servers.
The network default is 255.255.255.255.
Command Modes
SLB virtual server configuration submode.
Usage Guidelines
The last real server that was used for a connection from a client is stored for the duration value after the end of the client's latest connection. If a new connection from the client to the virtual server is initiated during that time, the same real server that was used for the previous connection is chosen for the new connection.
A nonzero sticky group ID must correspond to a sticky group previously created using the sticky command. Virtual servers in the same sticky group share sticky state information.
Command History
Examples
This example shows how to set the sticky timer duration and places the virtual server in a sticky group for connection coupling:
Related Commands
sticky
sticky-group (SLB policy submode)
show module csm sticky
show module csm vserver redirect
url-hash
Use the url-hash command in the SLB virtual server configuration submode to set the beginning and ending pattern of a URL to parse URLs for the URL hash load-balancing algorithm. Use the no form of this command to remove the hashing from service.
- url-hash {begin-pattern | end-pattern} pattern
- no url-hash
Syntax Description
Defaults
Command Modes
SLB virtual server configuration submode.
Usage Guidelines
The beginning and ending patterns apply to the URL hashing algorithm that is set using the predictor command in the SLB serverfarm submode.
Command History
Examples
This example shows how to specify a URL pattern to parse:
Related Commands
predictor (SLB serverfarm configuration submode)
vserver
show module csm vserver redirect
virtual
Use the virtual command in the SLB virtual server configuration submode to configure virtual server attributes. Use the no form of this command to set the virtual server's IP address to 0.0.0.0 and its port number to zero.
- virtual ip-address [ip-mask] protocol port-number [service ftp | rtsp]
- no virtual ip-address
Syntax Description
Defaults
The default IP mask is 255.255.255.255.
Command Modes
SLB virtual server configuration submode.
Usage Guidelines
Clients connecting to the server farm represented by the virtual server use this address to access the server farm. This service option is allowed only if a port number is specified. A port of 0 (or any) means that this virtual server handles all ports not specified for handling by another virtual server with the same IP address. The port is used only for TCP or UDP load balancing.
The following TCP port names can be used in place of a number:
ftp—File Transfer Protocol (21)
https—HTTP over Secure Sockets Layer (443)
matip-a—Mapping of Airline Traffic over IP, Type A (350)
nntp—Network News Transport Protocol (119)
pop2—Post Office Protocol v2 (109)
pop3—Post Office Protocol v3 (110)
smtp—Simple Mail Transport Protocol (25)
www—World Wide Web—Hypertext Transfer Protocol (80)
any—Allows traffic for any port, or the same as specifying a 0.
Command History
| Release | Modification |
|---|---|
Examples
This example shows how to create a virtual server and assign it an IP address, protocol, and port:
Related Commands
vserver
show module csm vserver redirect
vlan
Use the vlan command in the SLB virtual server submode to define which source VLANs may access the virtual server. Use the no form of this command to remove the VLAN.
- vlan vlan-number
- no vlan
Syntax Description
Defaults
Command Modes
SLB virtual server configuration submode.
Usage Guidelines
The VLAN must correspond to an SLB VLAN previously created with the vlan command.
Command History
Examples
This example shows how to specify a VLAN for virtual server access:
Related Commands
show module csm vserver redirect
show module csm vlan
vlan
show module csm arp
Use the show module csm slot arp command to display the CSM ARP cache.
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command History
Examples
This example shows how to display the CSM ARP cache:
show module csm conns
Use the show module csm slot conns command to display active connections.
Syntax Description
Defaults
If no options are specified, the command displays output for all active connections.
Command Modes
Command History
Examples
This example shows how to display active connection data:
show module csm dfp
Use the show module csm slot dfp command to display DFP agent and manager information, such as passwords, timeouts, retry counts, and weights.
- show module csm slot dfp [agent [detail | ip-address port] | manager [ip_addr] | detail | weights]
Syntax Description
Defaults
If no options are specified, the command displays summary information.
Command Modes
Command History
| Release | Modification |
|---|---|
|
Added the virtual server weight display information to report to the DFP manager. This command was changed to show module csm slot (for ip slb mode rp only). |
Examples
This example shows all available DFP data:
This example shows information about weights:
This example, with no options specified, shows summary information:
Related Commands
dfp
agent (SLB DFP configuration submode)
manager (SLB DFP configuration submode)
show module csm ft
Use the show module csm slot ft command to display statistics and counters for the CSM fault-tolerant pair.
- show module csm slot ft [detail]
Syntax Description
Defaults
Command Modes
Command History
Examples
This example shows how to display the statistics and counters for the CSM fault-tolerant pair:
Related Commands
show module csm map
Use the show module csm slot map command to display information about URL maps.
- show module csm slot map [url | cookie | header | retcode] [name map-name] [detail]
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command History
| Release | Modification |
|---|---|
|
This command was changed to show module csm slot (for ip slb mode rp only). The header option is added for displaying only header maps. |
|
Examples
This example shows how to display URL maps associated with a Content Switching policy:
This example shows how to display return code maps:
Related Commands
show module csm memory
Use the show module csm slot memory command to display information about memory use.
- show module csm slot memory [vserver vserver-name] [detail]
Syntax Description
|
(Optional) Keyword to specify the virtual server configuration. |
|
|
(Optional) Option to restrict output to the named virtual server. |
Defaults
This command has no default settings.
Command Modes
Command History
| Release | Modification |
|---|---|
|
This command was changed to show module csm slot (for ip slb mode rp only). The detail keyword no longer has an effect and is hidden or deprecated. |
Examples
This example shows how to display the memory usage of virtual servers:
Related Commands
parse-length (SLB virtual server configuration submode)
show module csm natpool
Use the show module csm slot natpool command to display NAT configurations.
- show module csm slot natpool [name pool-name] [detail]
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command History
Usage Guidelines
Examples
This example shows how to display results of the default show module csm slot natpool command:
This example shows how to display results of the show module csm slot natpool command with the detail variable:
Related Commands
show module csm policy
Use the show module csm slot policy command to display a policy configuration.
- show module csm slot policy [name policy-name]
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command History
Examples
This example shows how to display a policy configuration:
Related Commands
show module csm probe
Use the show module csm slot probe command to display HTTP or ping probe data.
- show module csm slot probe [http | icmp | telnet | tcp | ftp | smtp | dns] [name probe_name] [detail]
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command History
Examples
This example shows how to display probe data:
Related Commands
show module csm real
Use the show module csm slot real command to display information about real servers.
- show module csm slot real [sfarm sfarm-name] [detail]
Syntax Description
Defaults
If no options are specified, the command displays information about all real servers.
Command Modes
Command History
Examples
This example shows Cisco IOS SLB real server data:
Table A-1 describes the fields in the display.
Related Commands
real (SLB serverfarm configuration submode)
show module csm real retcode
Use the show module csm slot real retcode command to display information about the return code configuration.
- show module csm slot real retcode [sfarm sfarm-name] [detail]
Syntax Description
Defaults
If no options are specified, the command displays information about all real servers.
Command Modes
Command History
Examples
This example shows Cisco IOS SLB real server return code data:
Related Commands
real (SLB serverfarm configuration submode)
show module csm serverfarm
Use the show module csm slot serverfarm command to display information about a server farm.
- show module csm slot serverfarms [name serverfarm-name] [detail]
Syntax Description
|
(Optional) Keyword to display information about a particular server farm. |
|
|
(Optional) Keyword to display detailed server farm information. |
Defaults
This command has no default settings.
Command Modes
Command History
Examples
This example shows how to display server farm data:
Table A-2 describes the fields in the display.
This example shows how to display only the details for one server farm:
Related Commands
show module csm static
Use the show module csm slot static command to display information about server NAT configurations.
- show module csm slot static [drop | nat {ip-address | virtual}]
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command History
Examples
This example shows how to display static data:
Related Commands
static
real (SLB static NAT configuration submode)
show module csm static server
Use the show module csm slot static server command to display information about actual servers that are having NAT performed.
- show module csm slot static server [ip-address] [drop | nat {ip-address | virtual} | pass-through]
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command History
Examples
This example shows how to display static server data:
Related Commands
static
real (SLB static NAT configuration submode)
show module csm stats
Use the show module csm slot stats command to display SLB statistics.
- show module csm slot stats
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command History
Examples
This example shows how to display SLB statistics:
Table A-3 describes the fields in the display.
|
Number of connections that have been created since the last time counters were cleared. |
|
|
Number of connections that have been destroyed since the last time counters were cleared. |
show module csm status
Use the show module csm slot status command to display if the CSM is online. If the CSM is online, this command shows the CSM chassis slot location and indicates if the configuration download is complete.
- show module csm slot status
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command History
Examples
This example shows how to display CSM status:
show module csm sticky
Use the show module csm slot sticky command to display the sticky database.
- show module csm slot sticky [groups | client ip_address]
Syntax Description
|
(Optional) Keyword to display all of the sticky group configurations. |
|
|
(Optional) Keyword to display the sticky database entries associated with a particular client IP address. |
|
Defaults
If no options are specified, the command displays information about all clients.
Command Modes
Command History
Usage Guidelines
This command only displays the database of clients using IP stickiness; it does not show cookie or SSL.
Examples
This example shows how to display the sticky database:
Related Commands
sticky
sticky (SLB virtual server configuration submode)