Command-line mode provides a way for you to customize a SwitchProbe. SwitchProbe devices contain internal objects that have specific values defined. The specific values are used in many ways:
- 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. These commands make it easy to view, define, edit, and get help on customizing objects within the SwitchProbe device.
Command-line mode is an option that you can select from the Remote Login Screen or console port. To display information about the available commands and most current SwitchProbe objects, use the following procedure.
Step 1 From the console screen, select 11 Enter Command-line mode and then press Enter.
Step 2 At the prompt, enter help.
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
netflow_speed nvram ping proute
read_community reset ringid route
secondary_ip_addr software_options speed server
switch_info tftp tftp_timeout time
write_community
The command-line overview screen displays the name and description of each available command, as well as a list of all currently available objects that you can customize. There are only five available commands: get, set, do, help, and quit. Because commands and object names are case-sensitive, you must enter them in lowercase.
Once a local or remote console is attached to the SwitchProbe device, the following Configuration Utility menu is displayed:
***** SwitchProbe Token Ring Rev 4.1 *****
[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 #:
Commands are often followed by an object name and a number of parameters. Separate the object and each parameter with a space. If the parameter is a string and it contains spaces, always enclose it in quotation marks. If the parameter is an "on" or "off" state, sometimes 1 indicates on and 0 indicates off.
The get command is used 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."
The set command is used 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 the get command to check the results:
% set agent_location "The grassy knoll"
% get agent_location
The grassy knoll
The do command causes the agent to execute the code named by the object. Not all objects can be used with the do command. The following example shows the use of 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.
The Resource Manager software option can automate pings and SNMP queries from the agent to any IP device and set alarms on user-specified thresholds.
Online help is available for specific objects by entering help followed by the object name. For example, help agent_location 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 nvram parameters:
get agent_location
set agent_location new_value
The quit command returns you to the Configuration Utility menu. There are no additional objects or parameters.
Objects are defined in the following list. For more detailed information on the commands and usage for each object, enter help followed by the object name.
- access_list--Enables the user to install varying degrees of Simple Network Management Protocol (SNMP) security for the SwitchProbe device beyond the read and write community definitions. Security is described in detail in the "Access List Security" section of the "Advanced Features" chapter.
- 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:
- mib_checks--For Cisco use only.
- mib_defaults--For Cisco use only.
- default_groups--Enables the default groups of RMON for compatibility with third-party management software.
- prom_boot--For Cisco use only.
- flash_boot--For Cisco use only.
- router_discovery--Enables the SwitchProbe device to monitor ICMP traffic to determine its default router.
- rip--For Cisco use only.
- modem_log--When enabled, causes the agent to log all modem events to the local console and eventlog. This is addressed in the "Modem Support" section of the "Advanced Features" chapter.
- slip_ip--Enables routing between the SLIP interface to the primary LAN interface. This is addressed in the "SLIP Routing" section of the "Advanced Features" chapter.
- traffic_generator-- Enables or disables traffic generator capabilities in the SwitchProbe device. Traffic Generator can only be enabled using the local console but can be disabled from either the local or remote console.
- curr_interface--Changes to the agent configuration are done to one interface at a time. You must select the current interface before changing the IP address, subnet mask, and so forth.
- data--This object is used to configure DLCIINFO and IP-DATAFILTER information.
- dlc_offset--For Cisco use only.
- dump--This object is primarily 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. See the examples at the end of this chapter.
- dlc_proto--This object is used to select data link control (DLC) protocols for WAN SwitchProbes only.
- 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, the address of the default gateway that connects the agent LAN segments.
- gw_valid--For Cisco use only.
- if_options--For Cisco use only.
- interface--Contains detailed interface characteristics of interface 1. Contains 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, in order to force the agent to send out BOOTP requests on power on, the IP address must be disabled using the command set ip_valid no.
- manage_mode--Enables management mode for the currently selected interface. This is described in the "In-Band Management" section of the "Installation" chapter.
- mac_addr--Enables the use of a locally administered MAC address for use in a Token Ring environment.
- max_captsize--This object is maximum size of a capture buffer in kilobytes.
- max_controlentry--Specifies the maximum number of control entries in the SwitchProbe device. Control entries are generally used when domain groups are created. In a 2-Megabyte SwitchProbe model, the default value is 128. In a 4-Megabyte SwitchProbe model, the default value is 256.
- 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--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.
- memory--For Cisco use only.
- min_pktsize--The maximum number of bytes of each WAN packet that can be saved in the capture buffer (7500 model series only). Specified in bytes, the default is 128. Accepts a value range of 128 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 currently selected interface. This is described in the "In-Band Management Procedure" section of the "Installation" chapter.
- mtu_size--The size of the largest datagram that can be sent or received on the interface, specified in bytes. The default is 1500.
- netflow_port--Specifies the NetFlow UDP port number.
- netflow_speed--Specifies the UDP port speed in bits/sec.
- net_mask--Determines if a host is directly connected to a specific segment or if it must be reached through a router.
- netmask_valid--For Cisco use only.
- nvram--For Cisco use only.
- ping--Similar to the ping function found on most workstations. The command 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 selected host IP or subnet IP addresses. This information is permanently stored in nonvolatile RAM (NVRAM).
- read_community--A term basic to SNMP that defines a collection of devices that are authorized to communicate with one another. For purposes of security, the community names can be changed 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 read and write communities of the client must match that of the agent in order 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.
- route--Enables the implementation of a static route from the agent to selected host IP or subnet IP addresses. This route becomes effective at once and is lost if power is lost.
- secondary_ip_addr--Necessary to implement the trap routing function in the agent.
- software_options--Access mechanism to control certain agent options, which are activated and deactivated through software.
- speed--Bit rate of the current interface. For example, 16 (16 Mbps) or 4 (4 Mbps) for Token Ring, and so forth.
- server--The IP address of the host used as server to download software updates, IP address under BOOTP, and agent configuration.
- switch_info--Configures the SwitchProbe device as a proxy agent for a switch or other network device.
- tftp--Downloads software from a central device.
- tftp_timeout--A timeout parameter that determines how many seconds an agent waits for a TFTP message before aborting the session.
- trap_port--Specifies which port assignment is used when sending a trap.
- treq--Specifies the Requested Target Token Rotation Time parameter for the CDDI and FDDI interfaces.
- write_community--A term basic to SNMP that defines a collection of devices authorized to communicate with one another. For purposes of security, the community names can be changed 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 read and write communities of the client must match that of the agent in order to perform read and write functions.
Arguments are typically decimal values that specify the limit value of an object. Arguments can also be ASCII text strings. When a text string containing spaces is entered, the entire text must be enclosed in quotes ("text string").
The following example shows how to retrieve the agent information:
% get agent
model Token Ring
agent_number 71299
software_version 4.1
link time Apr 04 07:09:07 1997
nvram_version 30
agent_location Agent Location Here
agent_contact Your Contact Here
agent_name Your System Name Here
read_community public
write_community public
max_host 256
max_matrix 1024
max_log 128
max_captsize 8192
max_controlentry 256
server 204.240.143.22
tftp_filename ns6060.hex
tftp_timeout 10
The following example shows how to check and change variables, such as max_host and max_matrix:
% get max_host 256
% set max_host 105
% get agent
model Token Ring
agent_number XXXX
software_version 4.1
nvram_version 20
agent_location Agent Location Here
agent_contact Your Contact Here
agent_name Your System Name Here
read_community public
write_community public
max_host 128
max_matrix 512
max_log 128
max_captsize 8192
tftp_server 204.240.143.7
tftp_filename ns6060.hex
tftp_timeout 10
The following example shows how to retrieve the interface information:
% get interface
interface_number 1
ip_addr 204.240.143.156
gw_addr 0.0.0.0
net_mask 255.255.255.0
secondary_ip_addr 0.0.0.0
MAC addr 00-80-8c-01-16-83
local MAC addr 00-00-00-00-00-00
The following example shows how to check the available memory:
% get dump free_mem
Free memory available=6292432
The following example shows how to check the event log:
% get eventlog
---------------------- Event/Error Log ------------------------
<12:19:48> ----------New Boot----------
<12:19:48> Booting from flash
<12:19:48> IFN 1 MAC Addr: 00-80-8c-01-01-25
<12:19:48> IFN 3 MAC Addr: 00-80-8c-81-01-25
<12:19:48> Free memory after boot = mmmmmmm Bytes
<12:19:51> SwitchProbe CDDI [Ifn 1: Ethernet, Ifn 2: CDDI]
<12:19:51> Number of consoles initialized = X
<12:19:51> Opening port 2 for SLIP
<12:19:51> MIBMGR: Collector activated for interface 1
<12:19:51> MIBMGR: Collector activated for interface 2
<12:19:51> MIBMGR: Collector activated for interface 3
<12:19:51> AGENT Version 2.3.1 <12:19:51> NVRAM Version 2.0
<12:19:51> Link time Month; Day; hh:mm:ss Year
<12:19:51> Interface [1] IP Addr: 45.20.1.2
<12:19:52> net mask: 255.255.252.0
<12:19:52> GW Addr: 45.20.0.94
<12:19:52> Interface [2] IP Addr: Not configured
<12:19:52> net mask: Not configured
<12:19:52> GW Addr: Not configured
<12:19:52> Agent Ready
<12:19:52> Free Memory after init = mmmmmmm Bytes
%
