Application Control Engine Module Command Reference (Software Version A1(2))
Real Server Host Configuration Mode Commands

Table Of Contents

Real Server Host Configuration Mode Commands

(config-rserver-host) conn-limit

(config-rserver-host) description

(config-rserver-host) inservice

(config-rserver-host) ip address

(config-rserver-host) probe

(config-rserver-host) weight

Real Server Redirect Configuration Mode Commands

(config-rserver-redir) conn-limit

(config-rserver-redir) description

(config-rserver-redir) inservice

(config-rserver-redir) webhost-redirection


Real Server Host Configuration Mode Commands

Real server host configuration mode commands allow you to create and configure host real servers that are used in server load balancing (SLB). The parameters that you configure determine how the ACE interacts with the servers used for Web content and services. For details about SLB, see the Cisco Application Control Engine Module Server Load-Balancing Configuration Guide.

To create a host real server and access real server host configuration mode, use the rserver host command in configuration mode. The CLI prompt changes to (config-rserver-host). For information about commands available in this mode, see the following commands.

Use the no form of this command to remove an existing real server from the configuration.

rserver [host] name

no rserver name

Syntax Description

name

Unique identifier of the real server. Enter an unquoted text string with no spaces and a maximum of 64 alphanumeric characters.

host

(Optional) Specifies that the real server is a typical server that provides Web services and content.


Command Modes

Configuration mode

Admin and user contexts

Command History

Release
Modification

3.0(0)A1(2)

This command was introduced.


Usage Guidelines

The commands in this mode require the rserver feature in your user role. For details about role-based access control (RBAC) and user roles, see the Cisco Application Control Engine Module Virtualization Configuration Guide.

Examples

To create a host server named SERVER1, enter:

host1/Admin(config)# rserver SERVER1
host1/Admin(config-rserver-host)# 

To delete the host server named SERVER1, enter:

host1/Admin(config)# no rserver SERVER1

Related Commands

(config-sfarm-host) rserver

(config-rserver-host) conn-limit

To configure the maximum and minimum number of connections that you want to allow for a host real server, use the conn-limit command. Use the no form of this command to reset the maximum number of connections and the minimum connection threshold for a real server to the default value of 4294967295.

conn-limit max max-conns min min-conns

no conn-limit max

Syntax Description

max maxconns

Specifies the maximum number of connections allowed for this real server. Enter an integer from 2 to 4294967295. The default is 4294967295.

min minconns

Specifies the connection threshold below which the real server will start accepting connections again after the number of connections exceeds the configured maximum number of connections. Enter an integer from 2 to 4294967295. The default is minconns equal to maxconns.


Command Modes

Real server host configuration mode

Admin and user contexts

Command History

Release
Modification

3.0(0)A1(2)

This command was introduced.


Usage Guidelines

Use this command to specify the maximum number of connections and the minimum connection threshold for a real server. The minconns value must be less than or equal to the maxconns value. When the number of connections to a real server reaches the maxconns value, the ACE stops sending connections to that server and assigns it a state of OUTOFSERVICE. The ACE uses the minconns value as a threshold for load balancing to start accepting connections again after the maxconns limit is reached.

Examples

To configure the maximum number of connections and the minimum connection threshold for a real server, enter:

host1/Admin(config-rserver-host)# conn-limit max 65535 min 40000

To reset the maximum number of connections and the minimum connection threshold for a real server to the default value of 4294967295, enter:

host1/Admin(config-rserver-host)# no conn-limit

Related Commands

This command has no related commands.

(config-rserver-host) description

To configure a description for a real server, use the description command. Use the no form of this command to remove the real server description from the configuration.

description text

no description

Syntax Description

text

User-defined description of the real server and related information. Enter an unquoted text string with a maximum of 240 alphanumeric characters.


Command Modes

Real server host configuration mode

Admin and user contexts

Command History

Release
Modification

3.0(0)A1(2)

This command was introduced.


Usage Guidelines

This command has no usage guidelines.

Examples

To configure a description for a real server, enter:

host1/Admin(config-rserver-host)# description database application server

To delete a description for a real server, enter:

host1/Admin(config-rserver-host)# no description

Related Commands

This command has no related commands.

(config-rserver-host) inservice

To place a real server in service, use the inservice command in real server host configuration mode. Use the no form of this command to gracefully shut down a real server.

inservice

no inservice

Syntax Description

This command has no keywords or arguments.

Command Modes

Real server host configuration mode

Admin and user contexts

Command History

Release
Modification

3.0(0)A1(2)

This command was introduced.


Usage Guidelines

This command requires the real-inservice feature in your user role. For details about role-based access control (RBAC) and user roles, see the Cisco Application Control Engine Module Virtualization Configuration Guide.

Use the no form of this command to shut down a real server gracefully for maintenance or software upgrades. When you enter this command, the ACE tears down all non-TCP connections. For TCP connections, the ACE allows existing connections to complete before taking the server out of service. No new connections are allowed. Afterward, use the inservice command to place the real server back in service.

The ACE resets all SSL connections to a particular real server when you enter the no inservice command for that server.

Examples

To place a real server in service, enter:

host1/Admin(config-rserver-host)# inservice

To take a real server out of service, enter:

host1/Admin(config-rserver-host)# no inservice

Related Commands

This command has no related commands.

(config-rserver-host) ip address

To configure an IP address for a real server, use the ip address command in real server host configuration mode. Use the no form of this command to remove the real server IP address from the configuration.

ip address ip-address

no ip address

Syntax Description

ip-address

The IP address for the real server of type host. Enter an IP address in dotted-decimal notation (for example, 192.168.12.6).


Command Modes

Real server host configuration mode

Admin and user contexts

Command History

Release
Modification

3.0(0)A1(2)

This command was introduced.


Usage Guidelines

Use this command to provide a unique IP address for a real server. The address you choose must not be a VIP of an existing virtual server.

Examples

To configure the IP address of a real server, enter:

host1/Admin(config-rserver-host)# ip address 192.168.12.6

To delete the real server IP address from the configuration, enter:

host1/Admin(config-rserver-host)# no ip address 192.168.12.6

Related Commands

This command has no related commands.

(config-rserver-host) probe

To configure a probe to monitor the health of a real server, use the probe command. Use the no form of this command to remove the probe from the real server.

probe probe-name

no probe probe-name

Syntax Description

probe-name

Identifier of an existing probe that you want to assign to a real server to monitor its health. Enter an unquoted text string with no spaces and a maximum of 64 alphanumeric characters.


Command Modes

Real server host configuration mode

Admin and user contexts

Command History

Release
Modification

3.0(0)A1(2)

This command was introduced.


Usage Guidelines

You can associate multiple probes with each real server.

Examples

To configure a probe for a real server of type host, enter:

host1/Admin(config-rserver-host)# probe SERVER1_PROBE

To remove a probe from a real server of type host, enter:

host1/Admin(config-rserver-host)# no probe SERVER1_PROBE

Related Commands

This command has no related commands.

(config-rserver-host) weight

To configure the capacity of a real server in relation to other servers in a server farm, use the weight command. The weight value you specify for a server is used in the weighted roundrobin and least connections predictor load-balancing methods. Use the no form of this command to reset the real server weight to the default value.

weight number

no weight

Syntax Description

number

Weight value assigned to a real server in a server farm. This value is used in the weighted roundrobin and least connections predictor load-balancing algorithms. Enter an integer from 0 to 100. The default is 8.


Command Modes

Real server host configuration mode.

Admin and user contexts

Command History

Release
Modification

3.0(0)A1(2)

This command was introduced.


Usage Guidelines

To specify different weight values for a real server in a server farm, you can assign multiple IP addresses to the server. You can also use the same IP address of a real server with different port numbers.

Server weights take effect only when there are open connections to the servers. When there are no sustained connections to any of the servers, the leastconns predictor method behaves like the roundrobin method.

Examples

To configure a weight value for a real server, enter:

host1/Admin(config-rserver-host)# weight 50

To reset the weight of a real server to the default value of 8, enter:

host1/Admin(config-rserver-host)# no weight

Related Commands

This command has no related commands.

Real Server Redirect Configuration Mode Commands

Real server redirect configuration mode commands allow you to configure parameters for redirection real servers used in server load balancing (SLB). A redirection real server is used only for redirecting network traffic to another server as indicated in the Webhost redirection string. See the (config-rserver-redir) webhost-redirection command. The parameters that you configure determine how the ACE interacts with the servers used for redirection. Redirection servers are useful for content that has physically moved to another location, either temporarily or permanently. For details about SLB and redirection, see the Cisco Application Control Engine Module Server Load-Balancing Configuration Guide.

To create a redirect real server and access real server configuration mode, use the rserver redirect command in configuration mode. The CLI prompt changes to (config-rserver). For information about commands available in this mode, see the commands that follow this section.

Use the no form of this command to remove an existing real server from the configuration.

rserver redirect name

no rserver redirect name

Syntax Description

name

Unique identifier of the real server. Enter an unquoted text string with no spaces and a maximum of 64 alphanumeric characters.


Command Modes

Configuration mode

Admin and user contexts

Command History

Release
Modification

3.0(0)A1(2)

This command was introduced.


Usage Guidelines

All commands in this mode require the Real feature in your user role. For details about role-based access control (RBAC) and user roles, see the Cisco Application Control Engine Module Virtualization Configuration Guide.

Examples

To create a redirect server named SERVER1, enter:

host1/Admin(config)# rserver redirect SERVER1

To delete the redirect server named SERVER1, enter:

host1/Admin(config)# no rserver redirect SERVER1

Related Commands

(config-rserver-redir) webhost-redirection

(config-rserver-redir) conn-limit

To configure the maximum and minimum (optional) number of connections that you want to allow for a real server, use the conn-limit command. Use the no form of this command to reset the maximum number of connections and the minimum connection threshold for a real server to the default value of 4294967295.

conn-limit max max-conns min min-conns

no conn-limit max

Syntax Description

max max-conns

Specifies the maximum number of connections allowed for this real server. Enter an integer from 2 to 4294967295.

min min-conns

Specifies the connection threshold below which the real server will start accepting connections again after the number of connections exceeds the configured maximum number of connections. Enter an integer from 2 to 4294967295. The default is minconns equal to maxconns.


Command Modes

Real server redirect configuration mode

Admin and user contexts

Command History

Release
Modification

3.0(0)A1(2)

This command was introduced.


Usage Guidelines

Use this command to specify the maximum number of connections and the minimum connection threshold for a real server. The minconns value must be less than or equal to the maxconns value. When the number of connections to a real server reaches the maxconns value, the ACE stops sending connections to that server and assigns it a state of OUTOFSERVICE. The ACE uses the minconns value as a threshold for load balancing to start accepting connections again after the maxconns limit is reached.

Examples

To configure the maximum number of connections and the minimum connection threshold for a real server, enter:

host1/Admin(config-rserver-redir)# conn-limit maxconns 65535 minconns 40000

To reset the maximum number of connections and the minimum connection threshold for a real server of type redirect to the default value of 4294967295, enter:

host1/Admin(config-rserver-redir)# no conn-limit

Related Commands

This command has no related commands.

(config-rserver-redir) description

To configure a description for a real server, use the description command. Use the no form of this command to remove the real server description from the configuration.

description text

no description

Syntax Description

text

User-defined description of the real server and related information. Enter an unquoted text string with a maximum of 240 alphanumeric characters.


Command Modes

Real server redirect configuration mode

Admin and user contexts

Command History

Release
Modification

3.0(0)A1(2)

This command was introduced.


Usage Guidelines

Use this command to provide a unique description for the real server with a maximum of 240 characters.

Examples

To configure a real server description, enter:

host1/Admin(config-rserver-redir)# description database application server

To delete a real server description, enter:

host1/Admin(config-rserver-redir)# no description

Related Commands

This command has no related commands.

(config-rserver-redir) inservice

To place a real server in service, use the inservice command. Use the no form of this command to remove the real server from service.

inservice

no inservice

Syntax Description

This command has no keywords or arguments.

Command Modes

Real server redirect configuration mode

Admin and user contexts

Command History

Release
Modification

3.0(0)A1(2)

This command was introduced.


Usage Guidelines

This command requires the real-inservice feature in your user role. For details about role-based access control (RBAC) and user roles, see the Cisco Application Control Engine Module Virtualization Configuration Guide.

Use the no form of this command to shut down a real server gracefully for maintenance or software upgrades. When you enter this command, the ACE tears down all non-TCP connections. For TCP connections, the ACE allows existing connections to complete before taking the server out of service. No new connections are allowed. Afterward, use the inservice command to place the real server back in service.

Examples

To place a real server in service, enter:

host1/Admin(config-rserver-redir)# inservice

To take a real server out of service, enter:

host1/Admin(config-rserver-redir)# no inservice

Related Commands

This command has no related commands.

(config-rserver-redir) webhost-redirection

To configure the relocation URL string used for redirection, use the webhost-redirection command. You can configure a port number to redirect a request in the relocation string. Use the no form of this command to remove the real server redirection URL string from the configuration.

webhost-redirection relocation_string [301 | 302]

no webhost-redirection

Syntax Description

relocation_string

URL string used to redirect requests to another server. Enter an unquoted text string with no spaces and a maximum of 255 characters. The redirection string supports the following special characters:

%h—Inserts the host name from the request Host header

%p—Inserts the URL path string from the request


Note To insert a question mark (?) in the relocation string, press ctrl-v before you type the question mark.


[301|302]

(Optional) Specifies the redirection status code returned to a client. The codes indicate the following:

301—The requested resource has been moved permanently. For future references to this resource, the client should use the one of the returned URIs.

302—The requested resource has been found, but has been moved temporarily to another location. For future references to this the resource, the client should continue to use the request URI because the resource may be moved to other locations from time to time.

For more information, see RFC 2616.


Command Modes

Real server redirect configuration mode

Admin and user contexts

Command History

Release
Modification

3.0(0)A1(2)

This command was introduced.


Usage Guidelines

Configure this command only on a real server that you have configured as a redirection server.

Examples

To configure a redirection string on a real server, enter:

host1/Admin(config-rserver-redir)# webhost-redirection 
www.acme.com:4000/common/images/*.jpg 301

To remove the redirection string from a real server, enter:

host1/Admin(config-rserver-redir)# no webhost-redirection

Related Commands

This command has no related commands.