2.8. Extended Services Appliance Command Reference

2.8.1. Command Hierarchies

2.8.1.1. ESA Configuration Commands

config
esa esa-id [create]
— no esa esa-id
description description-string
[no] host-port port-id
[no] shutdown
vm vm-id [create]
— no vm
cores core-count
— no cores
description description-string
host-port port-id
— no host-port
memory memory-size
— no memory
[no] shutdown
vm-type vm-type
— no vm-type

2.8.2. Command Descriptions

2.8.2.1. ESA Configuration Commands

esa

Syntax 
esa esa-id [create]
no esa esa-id
Context 
config
Description 

This command configures or creates an ESA instance with an identifier.

The no form of this command removes the ESA from the system.

Parameters 
esa-id —
Specifies the ESA identifier.
Values—
1 to 16

 

create—
Mandatory keyword used when creating an ESA instance in the config context.

description

Syntax 
description description-string
no description
Context 
config>esa
Description 

This command creates a text description which is stored in the configuration file to help identify the ESA instance.

The no form of this command removes the description from the configuration.

Parameters 
string—
Specifies the description character string, up to 80 characters. Allowed values are any string composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

host-port

Syntax 
[no] host-port port-id
Context 
config>esa
Description 

This command configures an Ethernet port associated to the ESA instance.

The no form of this command removes the host-port.

Parameters 
port-id—
Specifies the port identifier of any valid Ethernet port on a supported IOM.
Values—
slot/mda/port

 

vm

Syntax 
vm vm-id [create]
no vm vm-id
Context 
config>esa
Description 

This command configures or creates an ESA-VM instance.

The no form of this command removes the ESA-VM from the system.

Parameters 
vm-id—
Specifies the VM identifier.
Values—
1 to 4

 

create—
Mandatory keyword used when creating an ESA-VM in the config context

cores

Syntax 
cores core-count
no cores
Context 
config>esa>vm
Description 

This command configures the number of CPU physical cores to be allocated to the ESA-VM instance. If an invalid value is configured for the number of cores, the VM remains in a failed state.

The no form of this command removes the core allocation. To modify the number of cores, you must use the no core command first.

Parameters 
core-count—
Specifies the number of cores.
Values—
0 to 128

 

description

Syntax 
description description-string
no description
Context 
config>esa>vm
Description 

This command creates a text description which is stored in the configuration file to help identify the ESA-VM instance.

The no form of this command removes the description from the configuration.

Parameters 
string—
Specifies the description character string, up to 80 characters. Allowed values are any string composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

host-port

Syntax 
host-port port-id
no host-port
Context 
config>esa>vm
Description 

This command configures an Ethernet port associated to an ESA-VM instance. The port-id used must be the same as the port associated with the ESA context on which the ESA-VM is configured.

The no form of this command removes the specified host-port for the ESA-VM instance.

Parameters 
port-id—
Specifies the port identifier of any valid Ethernet port ID on the supported IOM.
Values—
slot/mda/port

 

memory

Syntax 
memory memory-size
no memory
Context 
config>esa>vm
Description 

This command configures the amount of memory (in gigabytes) that is allocated to the ESA-VM instance.

The no form of this command removes the memory allocation. To modify the memory allocation, first invoke the no memory command.

Parameters 
memory-size—
Specifies the amount of memory in GB.
Values—
0 to 256

 

shutdown

Syntax 
[no] shutdown
Context 
config>esa
config>esa>vm
Description 

This command administratively disables the instance. The operational state of the instance is disabled, as well as the operational state of any entities contained within. When disabled, the instance does not change, reset, or remove any configuration settings or statistics.

The no form of this command administratively enables the instance.

vm-type

Syntax 
vm-type vm-type
no vm-type
Context 
config>esa>vm
Description 

This command configures the type of ESA-VM instance.

The no form of this command removes the specified vm-type.

Parameters 
vm-type—
Specifies the VM type.
Values—
aa — Specifies Application Assurance feature support.
bb — Specifies broadband feature support, such as NAT.
tunnel — Specifies the tunnel feature set, such as IPsec tunnels.