Command-Line Mode

You use command-line mode to customize a SwitchProbe device. SwitchProbe devices contain internal objects on which specific values are defined. These specific values are used as follows:

To control how the SwitchProbe device operates.
To specify the parameters and descriptions.
To enable or disable options.
To define the unique IP address assigned to the SwitchProbe device.
To perform various useful functions or define useful values.

Available as an option from the Agent Configuration Utility, command-line mode offers a way for you to work with specific commands: get, set, do, help, and quit. With these commands you can view, define, edit, and get help on customizing objects within the SwitchProbe device.

Using the Command Line

Command-line mode is an option that you select from the Remote Login screen or console port. To display information about available commands and current SwitchProbe objects, follow these steps:

Step 1 From the console screen, enter 11 and press Enter.

Step 2 At the prompt, enter help and press Enter.

The following screen is displayed:

% help
Syntax: action object [arg,...]
actions
	get: display the value of an object
	set: change the value of an object
	do: perform an agent operation
	help: display this help menu
	quit: exit command line-line mode
	
objects
access_list       agent             agent_contact   agent_location
agent_name        agent_options	    data	           date
dlc_proto	         dlc_offset	       dump	           eventlog
gw_valid	          if_options	       interface	      ip_addr
ip_valid	          mac_addr	         manage_mode	    max_captsize
max_controlentry  max_host	         max_log	        max_matrix
memory	            min_pktsize	      modem	          monitor_mode
mtu_size          net_mask	         netmask_valid	  netflow_port
nnetflow_speed	    nvram	            ping	           proute
read_community	    reset	            ringid	         route
secondary_ip_addr software_options speed	          server
switch_info	       tftp	             tftp_timeout	   time
write_community

Command-Line Overview Screen

The command-line overview screen displays the name and description of each available command, and a list of all currently available objects that you can customize. There are five commands: get, set, do, help, and quit.

After you attach a local or remote console to the SwitchProbe device, the following Agent Configuration Utility menu is displayed:

***** SwitchProbe Ethernet Rev 4.5 ***** 
 
[1] Change IP Address                    45.20.1.2
[2] Change Net Mask                      255.255.252.0
[3] Change Default Gateway Address       45.20.0.94
[4] Change Read Community                public
[5] Change Write Community               public
[8] Select Interface                     ETHERNET
[9] Change Server Address                204.240.143.7
[10] Upgrade Software
[11] Enter Command-line mode
[12] Reset Agent
 
Enter your response or Enter "exit" to logout
 
Selection #:

Command-Line Operations

Commands are often followed by an object name and several parameters. For effective use of these commands, follow these guidelines:

Separate the object and each parameter with a space.
Enclose the parameters in quotation marks if the parameter is a string that contains spaces.

Note If the parameter is an on or off state, sometimes 1 indicates on, and 0 indicates off.

get Command

Use the get command to view the current value of objects. The following example shows the use of the get command to view the contents of the agent_location object:

% get agent_location 
Agent Location Here

The default value of agent_location is "Agent Location Here."

set Command

Use the set command to set the value of an object. The following example shows the use of the set command to change the contents of the agent_location object, and then use the get command to check the results:

% set agent_location "San Jose"
% get agent_location
San Jose

do Command and ping

Use the do command to instruct the agent to execute the code named by the object. (You cannot use all objects with the do command.) The following example shows how to use the do command with the ping object:

% do ping 45.20.0.101
Reply from 45.20.0.101 seq=0, time=40 msec

The ping object can be very useful when troubleshooting because ping is executed from the agent to the specified address, not from the management software to the specified address.

Use the Resource Manager option to automate pings and SNMP queries from the agent to any IP device and to set alarms on user-specified thresholds.

help Command

Use the help command to access online help for specific objects. To access online help, enter help followed by the object name and press Enter. The following example displays the command options and the syntax of entries that are available for the agent_location object:

% help agent_location
command to display or change given parameters:
get agent_location 
set agent_location new_value

quit Command

Use the quit command to return to the Agent Configuration Utility menu. The quit command requires no additional objects or parameters.

Command-line Objects

The following list describes the command-line objects. For more detailed information about the commands and their uses for each object, enter help followed by the object name, and press Enter.

access_list---Allows you to install varying degrees of Simple Network Management Protocol (SNMP) security for the SwitchProbe device beyond the read and write community definitions. For more information, see "Access List Security" in Chapter 10, "Advanced Features."
agent---A composite list of the agent parameters and descriptions.
agent_contact---An ASCII text string corresponding to the MIB II system group variable sysContact.
agent_location---An ASCII text string corresponding to the MIB II system group variable sysLocation.
agent_name---An ASCII text string corresponding to the MIB II system group variable sysName.
agent_options--- Enables or disables options such as router_discovery, flash_boot, and others. Agent options are as follows:
artmib options---Used to view (get artmib_options) or establish (set artmib_options) application response time settings. Each artmib option, which you can also set using option 21 in the Agent Configuration Utility, are explained in "Changing ART MIB Parameters" in "Software Options."
atm_maxvpibits---Allows you to view (get) or establish (set) the number of bits that make up the selected Virtual Path Indicator (VPI). Use this object only when the selected interface is an ATM interface.

: The ATM interface can decode ATM Permanent Virtual Channel (PVC) addresses to a 10-bit resolution. By default, all ten bits are used to specify the Virtual Channel Identifier (VCI) portion of the PVC, and no bits are reserved to specify the VPI portion of the PVC. This default setting is sufficient in a UNI signaling Switched Virtual Circuit (SVC) environment where the VPI is usually 0.
: However, in other environments, PVCs usually use a non-zero VPI. In that case, use the set atm_maxvpibits command to specify the maximum number of bits used for specifying the VPI. The number of bits used for VCI will then be (10 minus maxvpibits).
: For example, if you set the maxvpibits to 3, three bits will be used for VPI, and seven bits for VCI. The total number of bits used for VPI and VCI is 10.

atmmib options---Used to view (get) or establish (set) ATM interface settings. Each atmmib option, which you can also set using the Change ATM MIB Parameters (menu selection 22) in the Agent Configuration Utility, are explained in detail in "Special Interface OptionsATM" in "Configuration."
- host_table_size---Indicates and allows you to set the maximum number of data link-layer hosts that each selected ATM interface in the SwitchProbe device can monitor.
- matrix_table_size---Indicates and allows you to set the maximum number of data link-layer conversations that each selected ATM interface in the SwitchProbe device can monitor.
- host_aging_frequency---Allows you to establish or modify the frequency (in seconds) at which the selected ATM interface replaces older information in its host tables, with newer information.
- matrix_aging_frequency---Allows you to establish or modify the frequency (in seconds) at which the selected ATM interface replaces older information in its conversation tables with newer information.
- enable_stats---This value (Yes or No) determines whether the SwitchProbe device tracks RMON1 statistics for the selected ATM interface.
- enable_host---This value (Yes or No) determines whether the SwitchProbe device tracks host statistics for the selected ATM interface.
- enable_matrix---This value (Yes or No) determines whether the SwitchProbe device tracks conversation statistics for the selected ATM interface.
atm_pvc---Allows you to view (get) or establish (set) the ATM permanent virtual circuits that are monitored as virtual interfaces of the SwitchProbe device. Use this object only when the selected interface is an ATM interface.
curr_interface---Changes to the agent configuration are performed on one interface at a time. You must select the interface before changing the IP address, subnet mask, and so forth.
date ---Allows you to view (get) or establish (set) the SwitchProbe device's current date. The date is in the format <month>/<day>/<four-digit year>. (For example, 7/25/1998 or 12/3/2001.)
dlci---Allows you to view (get) or establish (set) the agent's DLCI interface configuration, including the DLCI number, DTE CIR, DCE CIR, and the physical interface monitoring the PVC for each manually configured DLCI.
dlc_proto---Allows you to view (get) or establish (set) the agent's DLC protocols (for WAN SwitchProbe devices only).
data---Used to configure DLCIINFO and IP-DATAFILTER information.
dump---For Cisco use only; however, it can be used with the free_mem parameter to determine the amount of unused memory available in the SwitchProbe device.
eventlog---Maintained at the agent and includes a list of the most recent events that have occurred at the agent. These events are automatically stored as they occur.
gw_addr---If the agent is on a different LAN than the client, this object displays the address of the default gateway that connects the agent LAN segments.
interface---Contains detailed interface characteristics of interface 1. Contains an ASCII text string corresponding to the MIB II interface group variable ifDescr.
ip_addr---Contains the unique IP address of the agent assigned by the network administrator.
ip_valid---If the IP address is being configured using BOOTP, to force the agent to send out BOOTP requests at power up, the IP address must be disabled using the command set ip_valid no.
manage_mode---Enables management mode for the currently selected interface.
mac_addr---Enables the use of a locally administered MAC address for use in a Token Ring environment.
max_captsize---The maximum size of a capture buffer in kilobytes.
max_controlentry ---Allows you to view (get) or establish (set) the maximum number of control entries in the SwitchProbe device. Control entries are used when domain groups are created. In a 2-MB SwitchProbe device, the default value is 128. In a 4-MB SwitchProbe device, the default value is 256. In all SwitchProbe devices greater than 4MB, the default value is 512.
max_etherpktsize---Allows you to view (get) or establish (set) the maximum size (in bytes) of an Ethernet packet. The default Ethernet packet size is 1518 bytes. However, this object allows you to set the maximum size up to 65535 bytes. The flexibility of increasing the maximum packet size is useful in environments which use VLAN encapsulations, resulting in a valid packet size beyond 1518 bytes. Adjusting the max_etherpktsize object allows packets larger than 1518 (usually called babygiants) to be counted as valid packets even though the 802.3 specification stipulates that such packets be counted as oversized.
max_host---(Included in interface) Specifies the maximum number of entries in each instance of the RMON-MIB hostTable and hostTimeTable. The agent ages out least-recently seen host entries when this number is exceeded. The default value is 256.
max_log---Provides a decimal value specifying the maximum number of entries in the RMON-MIB log table. The default value is 128.
max_matrix---(Included in interface) Decimal value specifying the maximum number of entries in each instance of the RMON-MIB matrixDSTable and matrixSDTable. The agent ages out least-recently seen entries when this number is exceeded. The default value is 1024.
min_pktsize ---Indicates the maximum number of bytes of each WAN packet that can be saved in the capture buffer. The default value is 0, and the range is 0 to 1536 bytes.
modem---Provides for the setup and control of an external modem for operation through the SLIP interface.
monitor_mode---Enables monitor mode for the selected interface.
mtu_size---Indicates the size (in bytes) of the largest datagram that can be sent or received on the interface, specified in bytes. The default is 1500.
netflow_ifn---NetFlow Monitor is a software option for the Ethernet and Fast Ethernet SwitchProbe devices that can be purchased from Cisco Systems. The netflow_ifn object allows you to view (get) or establish (set) special virtual interfaces on a Fast Ethernet SwitchProbe device with NetFlow Monitor software to receive NetFlow packets from specific interfaces of a Cisco Systems routers with the NetFlow option. For more information, see "NetFlow Monitor Parameters" in "Software Options."
netflow_port---Specifies the NetFlow UDP port number.
netflow_speed ---Specifies the UDP port speed in bits per second.
net_mask---Determines if a host is directly connected to a specific segment or if it must be reached through a router.
ping---Similar to the ping function found on most workstations, this function is performed by entering do ping IP address. For example:

: do ping 45.20.0.80.
: The ping is sent from the agent to the specified IP destination, not from the management station to the destination. The agent displays the result of the ping.

proute---Enables the implementation of permanent private routes from the agent to the selected host IP or subnet IP addresses. This information is permanently stored in NVRAM.
proxyapport---Some protocols (such as SAP) use a range of TCP port numbers rather than only one well-known port. This command enables a SwitchProbe device to count all the SAP traffic that may be distributed across a range of TCP port numbers. To define a certain range of ports as one proxy port, use the set proxyapport command.

: For example, to channel IP traffic from ports 100 through 110 to proxy port 99, you would enter the following command:
: set proxyapport add IP 99, 100, 110 "name of port"

read_community---A basic SNMP term that defines a collection of devices that are authorized to communicate with each other. For purposes of security, you can change the community names to limit access between the client and subgroups of agents. The name can be any 32-byte ASCII character string. The default value is "public." The client read and write communities must match those of the agent to perform read and write functions.
reset---Resets the agent.
ringid---Establishes the ring identification for source routing. The default is 0 (not defined). Must be set for multiple ring source routing environment.
rmon1_options---Allows you to view (get) or establish (set) the SwitchProbe device's RMON1 parameters, including:
rmon2_options---Allows you to view (get) or establish (set) the SwitchProbe device's RMON2 parameters, including:
route---Enables the implementation of a static route from the agent to selected host IP or subnet IP addresses. This route becomes effective immediately and is lost if power is lost.
secondary_ip_addr---Implements the trap routing function in the agent.
slip_route---Allows you to view (get) or establish (set) a SwitchProbe device's SLIP IP address and managed interface IP address (used to implement the SLIP routing function).
software_options---Acts as the access mechanism to control certain agent options that are activated and deactivated through software.
speed---Provides bit rate of the current interface (for example, 16 [16 Mbps] or 4 [4 Mbps] for Token Ring, and so forth.)
server---Provides the IP address of the host used as the server to download software updates, IP address under BOOTP, and agent configuration.
time---Allows you to view (get) or establish (set) the SwitchProbe device's clock in <hour>:<minutes>:<seconds> format.
tftp---Downloads software from a remote location.
tftp_timeout---Determines how many seconds an agent waits for a TFTP message before aborting the session.
tracksession---To free up dedicated protocol ports, some server devices transmit/receive communication from client devices on alternative ports. For example, rather than receiving FTP communications on (well-known) port 21, a device might receive that communication on a lesser-known port. The ability to count packets to and from these alternative ports is known as TrackSession capability. All Cisco SwitchProbe devices have TrackSession capability.

: The set tracksession command-line object allows you to establish the frequency (in seconds) at which the tracksession table will be purged (minimum is 300 seconds, maximum is 72000 seconds, default is 30 seconds), and the total number of alternative tracksession ports allowed on the SwitchProbe device (minimum is 100, maximum is 65535, default is 2000).
: For example, set tracksession 120 500 purges the tracksession table every 120 seconds, and will allow up to 500 alternative ports on the SwitchProbe device.

trap_port---Specifies which port assignment is used when sending a trap.
treq---Specifies the Requested Target Token Rotation Time parameter for FDDI interfaces.
write_community---Defines a collection of devices authorized to communicate with each other. For purposes of security, you can change the community names to limit access between the client and subgroups of agents. The name used can be any 32-byte ASCII character string. The default value is "public." The client read and write communities must match those of the agent to perform read and write functions.

Note Arguments are typically decimal values that specify the limit value of an object. Arguments can also be ASCII text strings. When you enter a text string containing spaces, you must enclose the entire string in quotes ("text string").

Table of Contents

Command-Line Mode