|
|
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 obtain help on customizing objects in the SwitchProbe device.
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 art_filter artmib_options
cdp curr_interface date dlc_proto
dump eventlog gw_addr if_options
interface ip_addr ip_valid lnkopt
mac_addr manage_mode max_controlentry max_host
max_etherpktsize max_log max_matrix modem
monitor_mode mtu_size net_mask netflow_port
netflow_speed ping proute proxyapport
read_community reset ringid rmon1_options
rmon2_options route secondary_ip_addr server
slip_route software_options speed svc
tftp tftp_timeout time tracksession
trap_port treq write_community
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.7 *****
[1] Change IP Address 192.168.143.2
[2] Change Net Mask 255.255.252.0
[3] Change Default Gateway Address 192.168.143.94
[4] Change Read Community public
[5] Change Write Community public
[8] Select Interface ETHERNET
[9] Change Server Address 192.168.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 several parameters. For effective use of these commands, follow these guidelines:
Use the get command to view the current value of objects. The following example shows how to use 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."
Use the set command to set the value of an object. The following example shows how to use 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
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 Monitor option to automate pings and SNMP queries from the agent to any IP device and to set alarms on user-specified thresholds. For more information about the Resource Monitor, see "Using the Resource Monitor Option" in "Using Special Licensed Software Options."
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 shows the options and syntax of entries available for the agent_location object:
% help agent_location
command to display or change given parameters:
get agent_location
set agent_location
new_value
Use the quit command to return to the Agent Configuration Utility menu. The quit command requires no additional objects or parameters.
Table 8-1 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.
| This Object... | Performs This Function |
|---|---|
access_list | Lets you to install varying degrees of SNMP security for the SwitchProbe device beyond the read and write community definitions. For more information, see "Using the Access List Security Feature" in "Using 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 the following agent options:
|
art_filter | Lets you view, establish, and delete a particular ART filter or all ART filters. ART art filter excludes traffic originating from certain hosts from ART analysis. |
artmib_options | Used to view (get artmib_options) or establish (set artmib_options) ART settings. Each ART MIB option, which you can also set using option 21 in the Agent Configuration Utility, is explained in "Using the ART MIB Option" in "Using Special Licensed Software Options."
|
artmib_options |
|
atm_maxvpbits | Lets you view (get), automatically calculate and establish, or manually establish the number of bits that make up the selected VPI. Use this object only when the selected interface is an OC-3 ATM interface. The OC-3 ATM interface can decode ATM PVC addresses to a 10-bit resolution. By default, all ten bits are used to specify the 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 command set atm_maxvpibits auto to automatically calculate and establish the maximum number of bits used for specifying the VPI. To manually specify the maximum number of bits used for specifying the VPI, use the command set atm_maxvpibits.The number of bits used for VCI is then 10 minus maxvpibits. For example, if you set the maxvpibits to 3, three bits are 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 "Configuring Special Interface OptionsOC-3 ATM" in "Configuring SwitchProbe Devices."
|
atm_pvc | Lets you 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. |
cdp | Lets you view or change the ability (1) or inability (2) of the device to count Cisco Discovery Protocol (CDP) packets. |
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 on. |
date | Lets you view (get) or establish (set) the current date on the SwitchProbe device. |
dlci | Lets you view (get) or establish (set) the agent 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 | (For WAN SwitchProbe devices only.) |
dump | For Cisco use only; however, you can use this object 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. |
if_options | Lets you view (get) or establish (set) settings on specific interfaces. Each if_option, which you can also set using Configure Interface Options (menu selection 14 in the Agent Configuration Utility), are described in "Configuring SwitchProbe Devices."
|
if_options |
|
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 boot time, you must disable the IP address using the command |
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_controlentry | Lets you 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 4 MB, the default value is 512. |
max_etherpktsize | Lets you 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 lets you 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 |
max_host | Included in interface. Specifies the maximum number of entries (default 256) in each instance of the RMON-MIB hostTable and hostTimeTable. The agent ages out least-recently seen host entries when this number is exceeded. |
max_log | Provides a decimal value (default 128) specifying the maximum number of entries in the RMON-MIB log table. |
max_matrix | (Included in interface) Decimal value (default 1024) 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. |
modem | Used to set up and control 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 (default 1500) that can be sent or received on the interface. |
netflow_ifn | NetFlow Monitor is a software option for the Ethernet and Fast Ethernet SwitchProbe devices that you can purchase from Cisco Systems. The netflow_ifn object lets you 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 "Using the NetFlow Monitor Option" in "Using Special Licensed 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 on most workstations, this function is performed by entering the command 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. |
probe_mode | You can only set the probe_mode object on Multiport Fast Ethernet and Gigabit Ethernet SwitchProbe devices. This objects lets you view or establish the mode at which the interface operates (0 = half duplex, 1 = full duplex, 2 = mixed duplex). Mixed duplex is not a valid setting for a Gigabit Ethernet interface. |
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 | Lets you view (get), establish (set), and delete a particular (or all) proxyapport(s) on a device. Some protocols (such as SAP) use a range of TCP port numbers rather than only one well-known port. This command lets a SwitchProbe device aggregate all the traffic that might be distributed across a range of TCP port numbers and send that traffic to one proxy port or exclude that traffic from analysis. You can specify a maximum of 20 ports for a specific agent. To define a certain range of ports as one proxy port, use the command set proxyapport. For example, to channel TCP traffic from ports 100 through 110 on server 10.10.25.5 to proxy port 99 (named TRAFFIC), you would enter the following command: |
read_community | A basic SNMP term that defines a collection of devices authorized to communicate with each other. For security purposes, 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). You must set this value for multiple ring source routing environment. |
rmon1_options | Lets you view (get) or establish (set) the SwitchProbe device RMON1 parameters, including:
|
rmon2_options | Lets you view (get) or establish (set) the SwitchProbe device RMON2 parameters, including:
|
rmon2_options |
|
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 |
server | Provides the IP address of the host used as the server to download software updates, IP address under BOOTP, and agent configuration. |
slip_route | Lets you view (get) or establish (set) a SwitchProbe device SLIP IP address and managed interface IP address (used to implement the SLIP routing function). |
software_options | Used as the access mechanism for controlling 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.) |
time | Lets you view (get) or establish (set) the SwitchProbe device clock in the 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, and it is present on all Cisco SwitchProbe devices. The set tracksession command-line object lets you establish the frequency (in seconds) at which the tracksession table is 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 the command set tracksession 120 500 purges the tracksession table every 120 seconds, and allows 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 security purposes, 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. 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"). |
Posted: Wed Oct 2 08:03:24 PDT 2002
All contents are Copyright © 1992--2002 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.