Table Of Contents
Command Reference
Command Privileges and Modes
CLI Conventions
Checking Command Syntax
System Help
Command Summary
Command Syntax Conventions
Commands
?
arp
date
diskusage
dns
dnssuffix
domainname
exit
expert
gateway
help
hostname
hotswap
ifconfig
model
netstat
nslookup
ntp
passwd
passwd expert
ping
pndbusage
pnexp
pnimp
pnlog
pnreset
pnrestore
pnstart
pnstatus
pnstop
pnupgrade
raidstatus (5.x)
reboot
route
script
show healthinfo
show inventory
shutdown
snmpwalk
ssh
sslcert
ssllist
syslogrelay setcollector
syslogrelay src
syslogrelay list
sysstatus
tcpdump
telnet
time
timezone
traceroute
unlock
version
Command Reference
Revised: February 22, 2008, OL-14672-01
This appendix summarizes the command line interface (CLI) commands of MARS Appliance 5.3.x. You can access the CLI using one of four possible console connections, as described in Establishing a Console Connection, page 5-4.
This appendix contains the following sections:
•Command Privileges and Modes
•CLI Conventions
•Checking Command Syntax
•System Help
•Command Summary
•Command Syntax Conventions
•Commands
Command Privileges and Modes
To access the CLI on the MARS Appliance, you must have a console connection to the appliance and use the system administrative account, pnadmin. No other administrative account defined in the web interface has privileges to access the console connection. For more information about establishing a console connection, see Establishing a Console Connection, page 5-4.
Note There is only one command mode for the MARS Appliances.
CLI Conventions
The CLI uses the following conventions:
•The key combination ^C, or Ctrl-C, means hold down the Ctrl key while you press the C key.
•A string is defined as a nonquoted set of characters.
Checking Command Syntax
The serial console interface provides several types of responses to incorrect command entries:
Command Line Entry
|
System Display
|
Command line that does not contain any valid commands.
|
Unknown command
|
Valid command that does not contain required options.
|
Incomplete command
|
Valid command that does not provide valid options or parameters.
|
Invalid input
|
In addition, some commands have command-specific error messages that notify you that a command is valid, but that it cannot run correctly.
System Help
You can obtain help using the following methods:
•For a list of all commands and a brief description, enter help or ?, and then press Enter.
•For syntax help on a specific command, type the command name, a space, a dash, and a lowercase h, and then press Enter, for example, arp -h. The help contains command usage information and syntax.
Command Summary
Table A-1 summarizes all commands available on the MARS Appliance. Refer to the full description of commands that you are not familiar with before using them.
Table A-1 Command Summary
Command
|
Location of GUI Equivalent
|
Summary Description
|
Location of Full Description
|
?
|
—
|
Print list of available commands.
|
?
|
arp
|
—
|
Display/manipulate/store the arp table.
|
arp
|
date
|
—
|
Set/show date.
|
date
|
diskusage
|
—
|
Display percentage of disk used.
|
diskusage
|
dns
|
Admin > System Setup > Configuration Information
|
Add/remove/show domain name resolving servers.
|
dns
|
dnssuffix
|
Admin > System Setup > Configuration Information
|
Add/remove/show domain name suffixes search path.
|
dnssuffix
|
domainname
|
—
|
Set/show name of the domain to which the MARS Appliance belongs.
|
domainname
|
exit
|
—
|
Switch to standard mode/log out.
|
exit
|
expert
|
—
|
Switch to expert debugging mode (for using Cisco TAC personnel only).
|
expert
|
gateway
|
Admin > System Setup > Configuration Information
|
Show/set default gateway of the MARS Appliance.
|
gateway
|
help
|
—
|
Print list of available commands.
|
help
|
hostname
|
The Name field on the Admin > System Setup > Configuration Information page.
|
Set/show the hostname of the MARS Appliance.
|
hostname
|
hotswap1
|
—
|
Hot add or remove hard disk drive.
|
hotswap
|
ifconfig
|
Admin > System Setup > Configuration Information
|
Configure/store network interface.
|
ifconfig
|
model
|
—
|
Displays the model number and mode of the MARS Appliance.
|
model
|
netstat
|
—
|
Show network statistics.
|
netstat
|
nslookup
|
—
|
Look up the IP address or domain name.
|
nslookup
|
ntp
|
—
|
Synchronize system clock with Network Time Protocol (NTP) servers.
|
ntp
|
passwd
|
Admin > User Management (pnadmin)
|
Change administrative password used to access the appliance from the Secure Shell (SSH) or GUI client.
|
passwd
|
passwd expert
|
—
|
Change the customer portion of the expert debugging mode password used to access the appliance from the Secure Shell (SSH).
|
passwd expert
|
ping
|
—
|
Sends Internet Control Message Protocol (ICMP) echo_request packets for diagnosing basic network connectivity.
|
ping
|
pndbusage
|
—
|
Shows the current database usage and explains how future space will be claimed, either through unused partitions or purging of oldest data.
|
pndbusage
|
pnexp
|
—
|
Export configuration and event data from a 4.3.x appliance for import into a MARS Appliance running 5.3.1 or later.
|
pnexp
|
pnimp
|
—
|
Import configuration and event data previously exported from a MARS Appliance running 4.3.x into a one running 5.3.1 or later.
|
pnimp
|
pnlog
|
Admin > System Maintenance > View Log Files
Admin > System Maintenance > Set Runtime Logging Levels
Help > Feedback
|
Show system log/set log level.
|
pnlog
|
pnreset
|
—
|
Reset the MARS Appliance to factory defaults.
|
pnreset
|
pnrestore
|
—
|
Restore MARS system configuration and data from a backup.
|
pnrestore
|
pnstart
|
—
|
Start MARS applications.
|
pnstart
|
pnstatus
|
—
|
Show running status of MARS applications.
|
pnstatus
|
pnstop
|
—
|
Stop MARS applications.
|
pnstop
|
pnupgrade
|
Admin > System Maintenance > Upgrade
Admin > System Parameters > Proxy Settings
|
Upgrade the software running on the MARS Appliance.
|
pnupgrade
|
raidstatus1
|
—
|
Display the status of hard disk drives.
|
raidstatus (5.x)
|
reboot
|
—
|
Reboot the MARS Appliance.
|
reboot
|
route
|
—
|
Configure/store routing tables.
|
route
|
script
|
—
|
Command line interface to provided script files.
usage: script [-b] program
|
script
|
show healthinfo
|
—
|
Displays operational status of components in the MARS Appliance.
|
show healthinfo
|
show inventory
|
—
|
Displays identifying details of essential components in the MARS Appliance.
|
show inventory
|
shutdown
|
—
|
Shut down the MARS Appliance.
|
shutdown
|
snmpwalk
|
—
|
Communicates with a network entity using SNMP GETNEXT requests.
|
snmpwalk
|
ssh
|
—
|
User interface to the SSH client.
|
ssh
|
sslcert
|
—
|
Generate a new self-signed SSL certificate.
|
sslcert
|
ssllist
|
—
|
List existing ssl certificates
|
ssllist
|
syslogrelay setcollector
|
—
|
Displays the IP address of the device to which syslogs are forwarded.
|
syslogrelay setcollector
|
syslogrelay src
|
—
|
Displays list of source addresses for which syslogs are forwarded.
|
syslogrelay src
|
syslogrelay list
|
—
|
Displays list of syslog collector and sources.
|
syslogrelay list
|
sysstatus
|
—
|
User interface to the Unix top command.
|
sysstatus
|
tcpdump
|
—
|
Dump traffic on a network.
|
tcpdump
|
telnet
|
—
|
User interface to the TELNET client.
|
telnet
|
time
|
—
|
Set/show time for the MARS Appliance.
|
time
|
timezone
|
—
|
Set/show timezone for the MARS Appliance.
|
timezone
|
traceroute
|
—
|
Displays the network route that packets take to reach a specified host.
|
traceroute
|
unlock
|
Admin > Management > User Management
|
Unlocks access to the GUI for all or specified accounts after login failure.
|
unlock
|
version
|
Help > About
|
Displays the version of software running on the MARS Appliance.
|
version
|
Command Syntax Conventions
Command descriptions in this document and in the CLI help system use the following conventions:
•Vertical bars (|) separate alternative, mutually exclusive elements.
•Square brackets ([ ]) indicate optional elements.
•Braces ({ }) indicate a required choice. Braces within square brackets ([{ }]) indicate a required choice within an optional element.
•Angle brackets (< >) indicate the following elements:
–Arguments
–Character string that you enter but that does not appear on the screen, such as a password
•Bold indicates commands and keywords that are entered literally as shown.
•Italics indicate arguments for which you supply values.
Commands
This section describes the Cisco Security Monitoring, Analysis, and Response System commands. Command names are case sensitive.
?
The ? command lists available commands and provides a brief description of each command.
Syntax Description
This command has no arguments or keywords.
Examples
To see the full list of commands that are available, enter:
arp
The arp command relates to the ARP cache on the MARS Appliance. You can view the list of mappings, clear an entry, or add a new mapping.
To display the current entries in the ARP cache, enter:
arp
To display the cached entries for a specific host, enter:
arp [-evn] [-H type] [-i if_local] -a [hostname]
To add a host to the cache, enter one of the following commands:
arp [-v] [-H type] [-i if_local] -s hostname hw_addr [netmask] pub
arp [-v] [-H type] [-i if_local] -s hostname hw_addr [temp]
arp [-v] [-H type] [-i if_loca] -Ds hostname if_dest [netmask] pub
To delete a host from the cache, enter:
arp [-v] [-i if_local] -d hostname [pub | nopub]
In all places where a hostname is expected, you can alternatively enter an IP address in dotted-decimal notation.
As a special case for compatibility the order of the hostname and the hardware address can be exchanged.
Each complete entry in the ARP cache is marked with the C flag. Permanent entries are marked with M and published entries have the P flag.
Note You cannot add arp entries from a file, as you do not have access to the file system on the MARS Appliance.
Syntax Description
none The default behavior of this command displays the IP address, hardware type, interface name, and MAC address associated with the network interface in the MARS Appliance.
-v Tell the user what is going on by being verbose.
-n Display numerical addresses instead of symbolic host, port, or usernames.
-H type When setting or reading the ARP cache, this optional parameter identifies which class of entries (hardware type) ARP should check for. The default value of this parameter is ether. The list of valid type values is as follows:
•strip (Metricom Starmode IP)
•ash (Ash)
•ether (Ethernet)
•tr (16/4 Mbps Token Ring)
•tr (16/4 Mbps Token Ring [New])
•ax25 (AMPR AX.25)
•netrom (AMPR NET/ROM)
•rose (AMPR ROSE)
•arcnet (ARCnet)
•dlci (Frame Relay DLCI)
•fddi (Fiber Distributed Data Interface)
•hippi (HIPPI)
•irda (IrLAP)
•x25 (generic X.25) .
-a [hostname], Displays the entries of the specified hosts. If the hostname parameter is not used, all entries are displayed.
-d hostname Delete any entry for the specified host.
-D Use the interface if_dest's hardware address.
-e Shows the entries in default (Linux) style.
-i If_local Select an interface in the appliance. When dumping the ARP cache only entries matching the specified interface are printed. When setting a permanent or temp ARP entry, the entry is associated with this interface; if this option is not used, the routing table is used to determine the most likely interface through which the address is reachable. For pub entries the specified interface is the interface on which ARP requests are answered. This value must be different from the interface to which the IP datagrams will be routed (if_dest).
-s hostname hw_addr
Manually create an ARP address mapping entry for host hostname with hardware address set to hw_addr class. For the Ethernet class, use the 6-bytes in hexadecimal notation, separated by colons. You can determine this value using the ipconfig /all command on the host for which you are defining this entry. When adding proxy arp entries (that is, those with the publish flag set), a netmask may be specified to proxy arp for entire subnets. If the temp flag is not supplied entries are permanently stored in the ARP cache. You cannot define an ARP entry for an entire subnet.
Examples
To permanently add an arp cache entry for a management host (marsgui) reachable from eth1, enter:
arp -v -H ether -i eth1 -s marsgui 00:05:9A:3C:78:00 pub
To remove the entry defined above, enter:
arp -v i eth1 -d marsgui nopub
date
To display or set the system date, use the date command.
Note Time changes on the appliance are immediate, which can affect active incident correlation. If you change the time by greater than 30 minutes, you should restart your appliance to ensure that all processes synchronize using the new time.
date [newdate]
Syntax Description
none The default behavior of this command displays the date in the mm/dd/yy format (for example, 04/28/05)
newdate Identifies the date to which you want to change the appliance clock. You can use either of the following formats: mm/dd/yyyy or mm/dd/yy.
Examples
To display the current date, enter:
To change the date to March 12, 2004, enter either of the following commands:
diskusage
To display the amount of disk space available on all partitions, enter
diskusage
For all MARS Appliance models, the Oracle database has three partitions:
•/u01: Stores the Oracle binary files.
•/u02: Stores the data files.
•/u03: Stores the replay log files, which are cached, in-memory working files not yet committed to the data store.
If any of these partitions reaches 99% capacity, the Oracle database will experience operational issues.
The size of the data partition (/u02) varies based on the model:
•MARS 20: 74 GB
•MARS 50: 148 GB
•MARS 100: 565 GB
•MARS 200: 795 GB
Syntax Description
none The default behavior of this command displays amount of disk space available on all partitions in the MARS Appliance
Examples
To display the disk usage for all partitions in the MARS Appliance, enter the following command:
The following is sample output for a MARS 100, as noted by the size of the /u02 partition:
Filesystem Size Used Avail Use% Mounted on
/dev/sda3 20G 5.7G 13G 31% /
/dev/sda1 129M 14M 108M 12% /boot
/dev/sda5 20G 4.8G 13G 26% /opt
/dev/sda6 20G 130M 18G 1% /log
/dev/sda7 29G 134M 27G 1% /pnarchive
/dev/sda8 20G 2.7G 16G 14% /u01
/dev/sda9 9.8G 2.2G 7.2G 23% /u03
/dev/sda10 565G 15G 522G 3% /u02
none 1005M 0 1005M 0% /dev/shm
dns
To display or specify the IP addresses of the Domain Name Services (DNS) servers that the MARS Appliance should use to resolve IP addresses into hostnames, use the dns command.
dns [primary] [secondary] [tertiary]
Note If the DNS configuration is changed from the web interface, you must perform a pnstop and then a pnstart operation for the new DNS information to be used by the MARS Appliance. For information on performing these two operations, see Stop Appliance Services via the Console, page 6-5 and Start Appliance Services via the Console, page 6-5.
Syntax Description
none The default behavior of this command displays the current set of IP addresses assigned to the primary, secondary, and tertiary DNS servers.
primary Identifies the IP address of the DNS server that should be used first to resolve hostnames and/or IP addresses. Only the primary is required.
secondary Identifies the IP address of the DNS server that should be used second to resolve hostnames and/or IP addresses. This address is optional. If this value is left blank, any previously defined secondary entries are deleted.)
tertiary Identifies the IP address of the DNS server that should be used last to resolve hostnames and/or IP addresses. This address is optional. If this value is left blank, any previously defined tertiary entries are deleted.
Examples
To display the current DNS server entries, enter:
To set the primary DNS server to 192.168.101.3 and the secondary DNS server to 192.168.102.5, enter:
dns 192.168.101.3 192.168.102.5
dnssuffix
To display, add, or remove the DNS search paths associated with the adapters in the MARS Appliance, use the dnssuffix command.
dnssuffix [add | del] searchpath
Syntax Description
none The default behavior of this command displays the current domain search paths defined for the appliance.
add Specifies that the text that follows "add" should be added as a new dns search path.
del Specifies that the text that follows "del" should be removed from the dns search path, if found.
searchpath Identifies the domain name to be used for local DNS searches.
Examples
To display the current DNS search path, enter:
To add example.com to the search path, enter:
dnssuffix add example.com
To remove example.com from the search path, enter:
dnssuffix del example.com
domainname
To set or show the DNS domain of the MARS Appliance, use the domainname command.
domainname [domain]
Syntax Description
none The default behavior of this command displays the current domain value, if defined. Otherwise, it displays no value.
domain Name of DNS domain.
Examples
This command sets the domain name to example.com:
To display the current domain name, enter:
exit
To log out of the system, use the exit command.
exit
Syntax Description
This command has no arguments or keywords.
Examples
The following command logs you out of the system:
expert
To enable expert debugging mode on the MARS Appliance, use the expert command.
expert
The expert command, undocumented before the 4.1.3, is for exclusive use by Cisco to aid in debugging customer issues that require direct access to the internal data store of the MARS Appliance. You may further restrict access to the expert command by setting the customer portion of the expert mode password via the passwd expert command. This command removes the default expert mode password set on the appliance from the factory.
While you can use the passwd expert command to restrict access to the expert command, only authorized Cisco support personnel are able to access the expert debugging mode of an appliance.
See also passwd expert.
Syntax Description
none The default behavior of this command prompts the user to provide authentication credentials to enable the expert debugging mode. Only authorized Cisco support personnel can properly authenticate.
Examples
None.
gateway
To show or set the default gateway to be used by the MARS Appliance, use the gateway command.
gateway [address]
Syntax Description
none The default behavior of this command displays the current gateway setting, if defined. Otherwise, it displays no value.
address Changes the default gateway address to the value specified. Use decimal notation.
Examples
To display the current default gateway address used by the appliance, enter:
To set the default gateway address to 192.168.101.1, enter:
help
The help command displays a complete list of commands that are available at the serial console.
help [name]
Syntax Description
none The default behavior of this command displays the full list of commands that are available and their corresponding brief description.
name Identifies the command for which you want to see the brief description.
Examples
To display the complete list of available commands, enter:
To display a brief description about the netstat command, enter:
hostname
To set or show the hostname of the MARS Appliance, use the set hostname command.
hostname [hostname]
Note Changing the hostname requires that the appliance reboot. This reboot will occur automatically after your change the hostname. However, you are prompted to verify the hostname change. To cancel the hostname change without rebooting, enter no at the Hostname change will cause the system to reboot. Do you want to proceed? prompt.
Syntax Description
none The default behavior of this command displays the current hostname value, if defined. Otherwise, it displays no value.
hostname Identifies the value to which the hostname for the MARS Appliance should be set.
Examples
This command sets the MARS Appliance name to csmars1:
To see the current hostname, enter:
hotswap
Use the hotswap command to remove and add hard drives to MARS Appliances with RAID arrays. This command must be executed before a hard drive is physically removed from or added to the RAID array.
hotswap {add | remove | list all} disk
Command History
Release
|
Modification
|
3.X
|
This command was introduced.
|
5.2.4
|
The list all keyword was added. The disk argument range of values include 0.
|
5.3.2
|
The list all keyword was modified to display the chassis hard drive slot to Port and PD number map; support for MARS 55 was added.
|
Syntax Description
add
|
Indicates that the hard drive with the designated disk number is to be added to the RAID array.
|
remove
|
Indicates that the hard drive with the designated disk number is to be removed from the RAID array.
|
list all
|
Displays a map of chassis hard drive slots and their related Port or PD number.
|
disk
|
Thechassis hard drive slot number of the hard drive to be hotswapped.
|
Usage Guidelines
To hotswap a hard drive is to replace the hard drive without powering down or rebooting the appliance.
For MARS Appliances 110, 110R, 210, GC2R, and GC2, the valid disk arguments range from 0 to 5.
For the MARS Appliance 55 the valid disk arguments are 0 and 1.
To hotswap a hard drive, execute hotswap remove disk, replace the hard drive in the slot designated by disk, then execute hotswap add disk. Check the operational status of the hard drive and the RAID array with the raidstatus command.
Whenever a hotswap remove disk command is executed, the hard drive in that slot is removed from the array and another must be added to restore full redundancy to the RAID array.
If the wrong disk value is entered, that hard drive is dropped from the RAID array, but can be rebuilt into the array without physically removing and inserting the hard drive by executing a hotswap add disk command. It can take up to 300 minutes for a single hard drive to be rebuilt into the RAID array.
For more information on RAID hotswapping procedures, see the chapter, "System Maintenance" in the User Guide for Cisco Security MARS Local Controller at the following URL:
MARS Appliances 55, 110R, 110, 210, GC2R, and GC2
http://www.cisco.com/en/US/docs/security/security_management/cs-mars/5.3/user/guide/local_controller/maintain.html
Examples
In the following example, a hard drive is hotswapped in slot 5 of a MARS 210. The hard drive status is verified with the raidstatus command:
[pnadmin]$ hotswap list all
Hardware RAID is found with 6 disks!
Disks available to be hotswapped:
|==============|==============|==============|
|--------------|--------------|--------------|
|==============|==============|==============|
[pnadmin]$ hotswap remove 5
Adapter: 0: EnclId-14 SlotId-5 state changed to OffLine.
Disk 5 can now be safely removed from the system.
-------------------------------------------------------
Product Name : Intel(R) RAID Controller SROMBSAS18E
Firmware Version : 1.03.00-0211
Adapter RaidType Status Stripe Size Cache
---------------------------------------------------------------
a0 Raid-10 Degraded 64kB 2097151MB Enabled
PD Status Size & Block Model
--------------------------------------------------------------------------------
p0 Online 715404MB [0x575466f0 Sectors] ATA ST3750640NS E
p1 Online 715404MB [0x575466f0 Sectors] ATA ST3750640NS E
p2 Online 715404MB [0x575466f0 Sectors] ATA ST3750640NS E
p3 Online 715404MB [0x575466f0 Sectors] ATA ST3750640NS E
p4 Online 715404MB [0x575466f0 Sectors] ATA ST3750640NS E
p5 Offline 715404MB [0x575466f0 Sectors] ATA ST3750640NS E
Started rebuild progress on device(Encl-14 Slot-5)
Disk 5 has been successfully added to RAID
-------------------------------------------------------
Product Name : Intel(R) RAID Controller SROMBSAS18E
Firmware Version : 1.03.00-0211
Adapter RaidType Status Stripe Size Cache
---------------------------------------------------------------
a0 Raid-10 Degraded 64kB 2097151MB Enabled
PD Status Size & Block Model
--------------------------------------------------------------------------------
p0 Online 715404MB [0x575466f0 Sectors] ATA ST3750640NS E
p1 Online 715404MB [0x575466f0 Sectors] ATA ST3750640NS E
p2 Online 715404MB [0x575466f0 Sectors] ATA ST3750640NS E
p3 Online 715404MB [0x575466f0 Sectors] ATA ST3750640NS E
p4 Online 715404MB [0x575466f0 Sectors] ATA ST3750640NS E
p5 Rebuild 715404MB [0x575466f0 Sectors] ATA ST3750640NS E
Rebuild Progress on Device at Enclosure 14, Slot 5 Completed 17% in 32 Minutes.
Related Commands
Command
|
Description
|
raidstatus (5.x)
|
Displays the status of the RAID array and of the individual HDDs.
|
ifconfig
To display or modify the current IP address and network mask pairs associated with the network interfaces installed in the MARS Appliance, use the ifconfig command.
ifconfig {eth0 | eth1} ip_addr netmask
Syntax Description
none The default behavior of this command displays the current settings for both the eth0 and eth1 interfaces.
eth0 Identifies that you want to set the IP address/netmask value for the eth0 interface. This option cannot be used in conjunction with eth1. If you do not specify the ip_addr and netmask values, this option displays the current settings for the eth0 interface.
eth1 Identifies that you want to set the IP address/netmask value for the eth0 interface. This option cannot be used in conjunction with eth0. If you do not specify the ip_addr and netmask values, this option displays the current settings for the eth1 interface.
ip_addr Identifies the IP address to assign to the specified interface (eth0 or eth1). You must specify a netmask value following this value.
netmask Identifies the network mask value to use with the address specified. You must specify the IP address before specifying this value.
Usage Guidelines
For more information on the physical placement of eth0 versus eth1, see the corresponding appliance model under Hardware Descriptions—MARS 25R, 25, 55, 110R, 110, 210, GC2R, and GC2, page 1-4.
For MARS Appliances 110, 110R, 210, GC2R, and GC2, eth0 is integrated NIC 1, eth1 is integrated NIC 2; eth2 and eth4 are unsupported.
Examples
To display the current interface address settings, enter:
To set the IP address of eth1 to 192.168.101.2/32, enter:
ifconfig eth1 192.168.101.2 255.255.255.255
Related Commands
Command
|
Description
|
show healthinfo
|
Displays operational status of appliance components.
|
displays the detailed usage guidelines on this command.
model
Use the model command to display the model and mode of the MARS Appliance.
model
Syntax Description
none The default behavior of this command lists model and mode of the MARS Appliance.
-h Displays the detailed usage guidelines on this command.
Examples
The following displays the model information about the MARS Appliance:
netstat
Use the netstat commands to display the status of network connections on either TCP, UDP, RAW or UNIX sockets.
netstat
By default, the netstat command only displays status on active sockets that are not in the LISTEN state (that is, connections to active processes).
Syntax Description
none The default behavior of this command lists current Internet connections and UNIX domain sockets.
-h Displays the detailed usage guidelines on this command.
-r Displays information about the routing table on the MARS Appliance.
-v Displays verbose information. Useful for obtaining information about unconfigured address families.
-V Displays version of command.
nslookup
Look up the IP address or domain name using its counterpart. This command launches an interactive console that displays information that you can use to diagnose Domain Name System (DNS) infrastructure. Before using this tool, you should be familiar with how DNS works.
Syntax Description
nslookup puts you into interactive command mode. To quit the command mode and return to the command prompt, enter exit.
ntp
The Network Time Protocol (NTP) synchronizes the clocks of computers across a network. By specifying an NTP server, you are instructing the appliance to contact that server to retrieve appropriate time settings. Synchronized times is especially important to MARS, because timestamp information provided by the reporting devices (and the appliance itself) is critical to accurate reconstruction of what transpires on the network.
Note Time changes on the appliance are immediate, which can affect active incident correlation. If you change the time by greater than 30 minutes, you should restart your appliance to ensure that all processes synchronize using the new time.
Warning When operating in a Global Controller/Local Controller hierarchy configuration, you must configure NTP on the Global Controller and on each Local Controller to ensure that rules fired by the Local Controller are properly propagated to the Global Controller.
Use ntp server to identify the primary and secondary NTP server with which the appliance should synchronize. To force a synchronization with the NTP server, use ntp sync. To disable the use of ntp by this appliance, use ntp disable.
ntp server [ntp_server1] [ntp_server2]
Syntax Description
none The default behavior of this command displays the current settings for the NTP servers. If no servers have been identified, it displays the message: ntp is not setup.
ntp_server1 Identifies the server, by IP address, that runs the NTP server from which you want this MARS Appliance to retrieve system time information. This time value sets the clock used to date and correlate events that are received by the appliance.
ntp sync Forces the MARS Appliance to synchronize with the NTP server. If the first server is unreachable, the appliance attempts to synchronize with the secondary server.
ntp disable Disables the use of NTP on the MARS Appliance.
Examples
To specify that 192.168.101.5 and 192.168.103.21 are your primary and secondary NTP servers, respectively, enter:
ntp server 192.168.101.5 192.168.103.21
To force a synchronization between the MARS Appliance and the NTP servers you have identified, enter:
To disable NTP synchronization, enter:
passwd
To change the password of the system administrative account (pnadmin) associated with the appliance, use the passwd command.
passwd [new_pword]
Syntax Description
none The default behavior of this command displays the command's usage guidelines.
new_pword Identifies the password to which you want to set the system administrative account's password.
Examples
To change the system administrative account password to Ou812o, enter:
Retype new password: <Ou812o>
passwd expert
To change the customer portion of the password associated with expert debugging mode of the appliance, use the passwd expert command.
passwd expert [new_pword]
While you can use the passwd expert command to restrict access to the expert command, only authorized Cisco support personnel are able to access the expert debugging mode of an appliance.
See also expert.
Syntax Description
none The default behavior of this command displays the command's usage guidelines.
new_pword Identifies the password to which you want to set the expert mode password.
Examples
To change the customer portion of the password associated with expert mode of the appliance to Ou812o, enter:
Retype new password: <Ou812o>
ping
To send ICMP echo_request packets for diagnosing basic network connectivity between the appliance and a network host, use the ping command.
ping [-LRUbdnqrvV] [-c count] [-i interval] [-w wait] [-p pattern] [-s packetsize] [-t ttl] [-I
if_addr] [-T option] [-Q tos] host
Use Ctrl+C or ^C to stop the output of this command and return to the command prompt.
Note The options used in this command are case sensitive.
Syntax Description
none The default behavior of this command displays the command's usage guidelines.
-b Allow pinging a broadcast address.
-c count Stop after sending count ECHO_REQUEST packets. With deadline option, ping waits for count ECHO_REPLY packets, until the timeout expires.
-d Set the SO_DEBUG option on the socket being used.
-i wait Identifies the wait interval in seconds between each sent packet. The default is one second.
-I if_addr Set source address to the specified interface address.
-l preload If preload is specified, ping sends that many packets as fast as possible before falling into its normal mode of behavior. Only the super-user can use this option.
-L Suppress loopback of multicast packets. This flag only applies if the ping destination is a multicast address.
-n Numeric output only. No attempt will be made to look up symbolic names for host addresses.
-p pattern You can specify up to 16 "pad" bytes to fill out the packet you send. This is useful for diagnosing data-dependent problems in a network. For example, "-p ff" will cause the sent packet to be filled with all 1s.
-Q tos Set Quality of Service-related bits in ICMP datagrams. The tos value can be either decimal or hex number. Traditionally (RFC1349), these have been interpreted as 0 for reserved (currently being redefined as congestion control), 1-4 for Type of Service, and 5-7 for Precendence. Possible settings for Type of Service are minimal cost, 0x02; reliability, 0x04; throughput, 0x08; and low delay, 0x10. Multiple TOS bits should not be set simultaneously. Possible settings for special Precedence range from priority (0x20) to net control (0xe0). You must be root (CAP_NET_ADMIN capability) to use Critical or higher Precedence value. You cannot set bit 0x01 (reserved) unless ECN has been enabled in the kernel. In RFC2474, these fields have been redefined as 8-bit Differentiated Services (DS), consisting of bits 0-1 of separate data (ECN will be used, here), and bits 2-7 of Differentiated Services Codepoint (DSCP).
-q Quiet output. Nothing is displayed except the summary lines at startup time and when finished.
-R Record route. Includes the RECORD_ROUTE option in the ECHO_REQUEST packet and displays the route buffer on returned packets. Note that the IP header is only large enough for nine such routes. Many hosts ignore or discard this option.
-r Bypass the normal routing tables and send directly to a host on an attached network. If the host is not on a directly attached network, an error is returned. This option can be used to ping a local host through an interface that has no route through it.
-s packetsize Specifies the number of data bytes to be sent. The default is 56, which translates into 64 ICMP data bytes when combined with the 8 bytes of ICMP header data.
-t ttl Set the IP Time to Live for multicasted packets. This flag only applies if the ping destination is a multicast address.
-T option Set special IP timestamp options. Timestamp option may be either tsonly (only timestamps), tsandaddr (timestamps and addresses), or tsprespec host1 [host2 [host3 [host 4]]] (timestamp prespecified hops).
-M hint Select Path MTU Discovery strategy. hint may be either do (prohibit fragmentation, even local one), want (do PMTU discovery, fragment locally when packet size is large), or don't (do not set DF flag).
-U Print true user-to-user latency (the old behavior).
-v Displays verbose output.
-V Displays the version of this command.
-w deadline Specify a timeout, in seconds, before ping exits regardless of how many packets have been sent or received.
pndbusage
To determine how much of the total database space is used, use the pndbusage command:
pndbusage
This command displays the percentage used within the current partition, as well as specifies whether additional partitions are available. If no unused partitions exist, the command identifies which partition will be purged, provides an approximate schedule for when that purge will occur, and specifies the date range and total number of events scheduled to be purged.
Syntax Description
none The default behavior of this command displays the percentage of total space used by the database.
Examples
Two possible outputs exist for this command:
•If empty partitions are available, the output appears as follows:
Current partition started on <start date> and uses
<number>% of its available capacity.
Switching to next partition is estimated for <estimated switching date>
<number> empty partitions are available for storage.
•If no empty partitions exists, the output appears as follows:
Current partition started on <start date> and uses
<number>% of its available capacity.
Switching to next partition is estimated for <estimated switching date>
<number> events, received between <purge start date> and <purge end date> will be
purged.
In this case, the third line indicates the data that will be purged on the <estimated switching date>.
Indents are displayed as shown above.
pnexp
From the pnexp command prompt, you can access time and disk space required for a data export, review the size of the database and the data therein, start and stop the export of configuration data, event data, or both, and check the status of an ongoing export. To access the pnexp command prompt, use the pnexp command at the pnadmin prompt:
pnexp
Command History
Release
|
Modification
|
4.3.1
|
This command was introduced in the Local Controller and Global Controller version 4.x train.
|
Syntax Description
help
|
Displays a list of valid subcommands.
|
quit | exit
|
Quit and exit the pnexp command. Return to the pnadmin command prompt.
|
status
|
Display the status of the current data export operation.
|
log {all | recent}
|
Show all or recent data exporting log entries.
|
data
|
Displays the number of events, report results, statistics, and incidents in the database.
|
config
|
Displays the number of devices, reports, and rules in the database. This command should be used as a point of comparison once the configuration is imported into the target appliance. Compare with the output of the pnimp config command.
|
stop
|
Stop the data export operation.
|
esti_time [MM/DD/YY:HH]
|
Estimates how much time and storage is required to export the event data that was received by MARS after a specified start time—only the events received after that time are migrated. If the last argument is not specified, then the estimate is based on all event data in the database.
Note The data export tool ignores data that was previously archived for the MARS Appliance. Each time the command is run, it writes data to a new NFS directory regardless whether data has already been archived.
|
export {config | data | all} {nfs_path} [MM/DD/YY:HH]
|
Export MARS configuration data ({config}), or events/reports/statistics/incidents data ({data}), or both ({all}) to the specified NFS path ({nfs_path}). If the last optional argument is given, only data received after that time will be exported. Example: export all 10.1.1.1:/mars/archive 02/28/07:00.
The nfs_path value identifies the top-level archive folder on the NFS server; it does not identify a specific archive date. If you export event data to an NFS server, the specified NFS path value must not match the archive path used by the source appliance. The pnexp command creates the proper archive folder under this path.
Note Only the start date is specified, the end date is always the current time (when event receiving is stopped.
|
Usage Guidelines
Use the pnexp command to prepare and export configuration and event data from MARS Appliance running 4.x as separate data so you can import either or both on a MARS Appliance running 5.x software. When the export operation begins, that MARS Appliance stops receiving events until the exporting process completes.
Caution Once the export operation begins, event data published to this appliance is lost, as is any event data that is not already written to the database. Follow the instructions provided in
Data Migration Work Flow, page -2 to avoid losing event data.
The configuration export runs in the foreground displaying its status and errors immediately, where as event data export runs in the background. Use the log {all | recent} command to view the running status log for event data export.
The event export part of this operation can take a long time, as the export speed ranges between 6,000 and 30,000 events per second depending on the appliance model. Event data is exported in the following order: report result, statistics, incident and firing events, and event session. If the remote NFS server becomes unavailable during a lengthy export operation, the pnexp program attempts to remount the server. For event data export, logs are written to the /log/export.log file.
Examples
The following example specifies that the MARS Appliance should export the configuration data to the NFS archive found at 192.168.3.138:/storage/mars_migration:
pnexp> export config 192.168.3.138:/storage/mars_migration
WARNING: this will stop CS-MARS, do you wish to continue (yes/no): yes
!!! The exported config data is saved under sub-directory of
192.168.3.138:/storage/mars_migration/LC-220_2007-09-04-11-25-10
!!! Stopping CS-MARS processes ...
!!! Exporting config data now
Dumping configuration data, may take a while ...
Configuration dump finished.
Configdump to 192.168.3.138:/storage/mars_migration/LC-220_2007-09-04-11-25-10 finished
successfully.
The following example specifies that the MARS Appliance should export the event data corresponding to the configuration data in the previous example:
pnexp> export data 192.168.3.138:/storage/mars_migration 05/01/07:0
WARNING: this will stop CS-MARS, do you wish to continue (yes/no): yes
Estimated total number of events to export: 1401080357
Estimated time to export events: 12 hours 58 minutes
Estimated space for exported events: 66809 MB
Do you wish to continue (yes/no): yes
!!! The exported event data is saved at
192.168.3.138:/storage/mars_migration/LC-220_2007-09-04-11-25-10
!!! Stopping CS-MARS processes ...
!!! Restarting oracle ...
!!! Exporting data in background now, enter 'status' or 'log' to view data exporting
status and/or logs.
Tip Use the log all command to determine where the archives are saved. This path information is required by the pnimp command.
Sep 4 11:25:21.293 2007@LM_INFO@Thread 1024:START DATA EXPORTING...
Sep 4 11:25:21.293 2007@LM_INFO@Thread 1024:Parameter: nfs_path =
192.168.3.138:/storage/mars_migration/LC-220_2007-09-04-11-25-10
Sep 4 11:25:21.293 2007@LM_INFO@Thread 1024:Parameter: event_start_time = 05/01/07:0
Sep 4 11:25:21.395 2007@LM_INFO@Thread 1024:Trying to mount /mnt/pnarchive
Sep 4 11:25:22.677 2007@LM_INFO@Thread 1024:EXPORTING REPORT RESULTS ...
Related Commands
Command
|
Description
|
pnimp
|
Import configuration and event data into a MARS Appliance running version 5.3.1 or later.
|
pnimp
From the pnimp command prompt, you can access time required for a data import, review the size of the event data set on the NFS server, start and stop the import of configuration data or event data, and check the status of an ongoing import. To access the pnimp command prompt, use the pnimp command at the pnadmin prompt:
pnimp
Command History
Release
|
Modification
|
5.3.1
|
This command was introduced in the Local Controller and Global Controller 5.x train
|
Syntax Description
help
|
Displays a list of valid subcommands.
|
quit | exit
|
Quit and exit the pnimp command. Return to the pnadmin command prompt.
|
status
|
Display the status of the current data import operation.
|
log {all | recent}
|
Show all or recent data import log entries.
|
data {nfs-path}
|
Show how much data exists in the specified NFS path.
|
config
|
Displays the number of devices, reports, and rules in the migration data set. This command should be used as a point of comparison after the configuration is imported into the target appliance. Compare with the output of the pnexp config command.
|
stop
|
Stop the data import operations.
|
esti_time {nfs_path} {MM/DD/YY}
|
Estimates how much time is required to import the event, report, statistics, and incident data found at the specified NFS path. The MM/DD/YY parameter restricts the estimate to data generated on or after that date.
Note This command does not estimate the time required to import configuration data.
|
import {config | data} {nfs_path} [MM/DD/YY
|
Import MARS configuration data ({config}), or events/reports/statistics/incident data ({data}) from the specified NFS path ({nfs_path}). The last argument ([MM/DD/YY]) is required for importing events/reports/statistics/incident data, meaning only importing data received or computed on or after that date. For importing config data, the latest MARS configuration data found under nfs_path is used.
The nfs_path value identifies the exported archive folder on the NFS server; this path was dispayed when you ran the pnexp export command.
Note You must first import the corresponding configuration data before attempting to import the event, report, statistics, incident data for reporting devices.
|
Usage Guidelines
Use the pnimp command to import configuration and event data generated from a MARS Appliance running 4.x into a MARS Appliance running 5.x software. The import operation does not affect event processing; in other words, the received events are processed upon arrival. However, it does affect the web interface and the query and report features may experience long delays and missing event or session data.
Tip To avoid IP address conflicts, reconfigure the MARS Appliance running 4.x before you import its configuration data into a new appliance.
Note When you import configuration data, it overwrites the configuration running on the MARS Appliance and reboots the appliance. After rebooting, the MARS Appliance assumes the IP address, hostname, and username/password of the appliance from which the configuration archive was exported.
The configuration import runs in the foreground displaying its status and errors immediately, where as event data export runs in the background. Use the log {all | recent} command to view the running status log for event data import.
Recent data is imported first. If an NFS-related problem results in a file not being imported properly, the pnimp import program halts and logs an error to the /log/migrationrestore.log file.
The next time the import operation is started, you are prompted whether to retry the last failed file. If no, the import operation continues with the next file. If another problem occurs, for example, a file corruption, that prevents a file from being imported, pnimp import generates a log similar to "file es_334_...gz is imported with error!" and continue with the next file.
When the import operation completes, the Local Controller begins to rebuild the RAW message indices. You can use the web interface although keyword query will remain slow until the indices are rebuilt.
Examples
The following example specifies that the MARS Appliance should import the configuration data from the NFS archive found at 192.168.3.138/storage/mars_migration/:
pnimp> import config 192.168.3.138:/storage/mars_migration/LC-220_2007-09-04-11-25-10
09/04/07
The most recent configuration archive from 4.3.1 release or later found on the NFS server
was created at 2007-09-04-11-25-10. Because events received after the config archive was
created may not be imported correctly later on when you try to import event data, so if
possible, you should always use 'pnexp' to export a fresh copy of configuration from the
Gen-1 MARS box before trying this command.
Do you wish to continue (yes/no) : yes
WARNING: this operation will overwrite current MARS box's configurations (both system and
DB) and reboot the machine. After reboot, current MARS box will take over the IP address,
hostname and MARS username/password of the MARS box from which the config archive was
exported, please make sure there will be no IP address conflict.
Do you wish to continue (yes/no): yes
!!! Stopping CS-MARS processes ...
Invoking binary config importing procedure ...
Recreating the database schema.
Importing data into database ...
Configuration data binary import done.
!!! Updating system settings ...
Broadcast message from root (pts/5) (Wed Jun 13 15:23:46 2007):
The system is going down for reboot NOW!
The following example specifies that the MARS Appliance should import the event data corresponding to the configuration data in the previous example:
Enter 'help' for a list of valid commands, 'exit' or 'quit' to exit.
pnimp> import data 192.168.3.138:/storage/mars_migration/LC-220_2007-09-04-11-25-10
01/01/07
Last imported configuration archive is from
192.168.3.138:/storage/mars_migration/LC-220_2007-09-04-11-25-10/2007-09-04/CF/cf-4318-431
_2007-09-04-11-25-10.pna created at 2007-09-04-11-25-10. Because events received after the
config archive was created may not be imported correctly, you should import a latest copy
of configuration from the Gen-1 MARS box before trying this command if possible.
Do you wish to continue (yes/no): yes
Total number of days with data : 5
Total number of event archives to import: 89
Total number of report result archives to import: 1
Total number of statistics archives to import: 4
Total number of incident archives to import: 3
Estimated time to import all events: 2 hours 1 minutes
Do you wish to continue (yes/no): yes
!!! Importing data in background now, enter 'status' or 'log' to view data importing
status and/or logs.
Related Commands
Command
|
Description
|
pnexp
|
Export configuration and event data from a MARS Appliance running version 4.x (4.3.1 or later).
|
pnlog
To set the logging level or to view log information at the console, use the pnlog command. This command specifies the logging level of the MARS services, as well as the CheckPoint CPMI and LEA logs received by the MARS Appliance.
Syntax Description
none The default behavior of this command displays the command's usage guidelines.
pnlog show {gui | backend | cpdebug}
The pnlog show command provides running output of a particular logfile at the console. You can view one of three logfiles: the GUI logs, the backend logs (shows logs for the processes that the pnstatus command reports on), and CheckPoint debug logs. Press Ctrl+C to stop the output of this command.
When using cpdebug, you must set the pnlog setlevel cpdebug value to 3 or 9, as the default value of 0 turns off all CPE debug messages.
pnlog mailto {[smtp_server] [sender] [recipient]}
The pnlog mailto command is an alternative to sending a Feedback e-mail with the log files attached. It sends an e-mail from sender to recipient using smtp_server. The e-mail contains debugging information. These logs contain the logs specified above.
pnlog setlevel {trace | debug | info | warning | error | critical}
The pnlog setlevel command specifies how verbose the logs generated by the MARS Appliance services are, with trace being the most verbose and critical being the least. The default level is info. Unless you are actively debugging an issue, Cisco recommends that you use the default value. The trace and debug options should be used only on the advice of Cisco TAC. Setting a level of critical shows only the critical events, while setting a level of warning shows all warning or higher events (in other words, it shows warning, error, and critical events). The CLI sets a global output level while the web interface allows you to change this setting for each service (use pnstatus to view the list of services). You can access this setting in the web interface by selecting Admin > System Maintenance > Set Runtime Logging Levels.
pnlog setlevel cpdebug { 0 | 3 | 9 }
The pnlog setlevel cpdebug command sets the output level of the CheckPoint discovery process. You must specify one of three levels: 0, 3, or 9, where 0 disables Check Point debug logging, 3 enables all OPSEC debug logs, and 9 enables all CPMI debug logs. This command is used together with pnlog show cpdebug command to study the raw output of CheckPoint Discovery (CPMI) and CheckPoint Log (LEA) sessions. Cisco recommends the use of 9 for debugging and 0 when not actively debugging.
Examples
To view the backend service logs at the console, enter:
To send e-mail to bob@exmple.com from admin@example.com using the 192.168.101.5 mail server, enter:
pnlog mailto 192.168.101.5 admin@example.com bobc@example.com
To set the log level of the MARS Appliance services to debug, enter.
To set the log level of the CheckPoint discovery process to debug, enter:
pnreset
To restore the appliance to the factory default settings (except for the pnadmin account) or to reset a Local Controller to standalone mode, use the pnreset command:
pnreset {-h} | {-g} | {-o} | {-j} | {-s}
Syntax Description
none
|
Default. With no options pnreset restores the appliance to factory defaults and purges all configuration and event data (certificate and fingerprints stored to validate reporting devices, topology settings, archived logs, and the license key information).
|
-h
|
Displays usage information.
|
-g
|
Removes the Global Controller data from a Local Controller, leaving all Local Controller-specific data untouched.
|
-o
|
Resets the tnsnames.ora file to factory default. The tnsnames.ora file is required for the Oracle client to connect to the Oracle server.
|
-j
|
Resets the web server scheduler depending on Local Controller's running mode. A restart of web server is enforced.
|
-s
|
Resets a Local Controller to standalone mode. It removes the same data as the -g option, and in addition, removes the Global Controller connectivity data from the Local Controller and the default Global Controller zone information.
|
Command History
Release
|
Modification
|
4.1.0
|
This command was introduced with -g, -h, -o, and -j options.
|
4.2.2
|
The -s option was introduced.
|
Usage Guidelines
The pnreset Command Without Options
The pnreset command restores the appliance to factory settings by deleting system configuration and event data stored in the appliance database. This reset process can take between 30 and 60 minutes to complete, depending on the model of the appliance. The pnreset command does not reset the password that you have defined for the Administrator (pnadmin) account. To reset the password to factory defaults, you must re-image the appliance using the Recovery DVD.
The pnreset command does not re-image the MARS Appliance. You should reimage the appliance when receiving a new appliance not running the most current version of the software or when you need to restore the administrator password to the factory default. For more information on reimaging, refer to Recovery Management, page 6-34.
Before entering the pnreset command without an option, disconnect the appliance from the network by unplugging the Ethernet cables from the appliance. Disconnecting from the network ensures that the cursor will return from the command upon completion. You must run pnreset without an option using a direct console connection, not an ssh console or other network-based connection. This requirement does not apply to pnreset when used with one of the options. For more information on console connections, see Establishing a Console Connection, page 5-4.
Caution Before executing the
pnreset command without an option, write down the license key of the appliance. The license key is cleared during the reset
process. You must provide this license key during the initial configuration following a reset operation, and it is not restored as part of archived data. This caution does not apply to
pnreset when used with one of the options.
The -g Option
The -g option should be used only when a Global Controller recovery is required. The -g option keeps the Global Controller connectivity information on the Local Controller intact, enabling the Local Controller to reconnect as soon as the Global Controller is restored. To purge Global Controller information from the Local Controller, use the -s option.
The pnreset -g command clears the global inspection rules and global user accounts from the Local Controller, which prepares the Local Controller to be managed by the reimaged Global Controller. It does not remove the global user groups; instead they are renamed (appended with a date) and converted to local user groups. You can edit or delete these empty groups after the reset. Because user groups are often used as recipients for rule notifications, they are not deleted to avoid invalidating the Action definition of such rules.
The -o Option
Resets the tnsnames.ora file to factory defaults. The tnsnames.ora file is required for the Oracle client to connect to Oracle server. If MARS does not pull logs from the Oracle client, this option should never be used. If the tnsnames.ora file contains invalid data, MARS may be unable to connect to its internal Oracle database. This option should only be used when errors indicated that MARS has failed to setup an external Oracle server, errors are reported during that setup, and the pnstatus command fails to execute due to these connectivity issues.
Caution Do not use the
-o option to troubleshoot all Oracle client issues. Using this command clears all Oracle client settings from the MARS Appliance, requiring that you re-enter all Oracle client setting using the web interface. Use this option only on direction from the Cisco TAC.
The -j Option
Resets the web server scheduler depending on the Local Controller's running mode. A restart of web server is enforced.
The -s Option
The -s option (4.2.2 and more recent) resets a Local Controller to Standalone mode from Monitor mode when the Global Controller cannot completely uncouple from (that is, delete) a Local Controller because of an unreliable network connection. It removes the same data as the -g option, removes the Global Controller connectivity data from the Local Controller, and removes the default Global Controller zone information. Use this option in the following cases:
•To reset a Local Controller when a Global Controller that was not running in archive mode crashes. If you plan to restore the Global Controller from an archive, use the -g option.
•If the Global Controller is not available or is unable to connect to the Local Controller, preventing you from successfully deleting the Local Controller entry from the Global Controller.
•If a Local Controller delete operation from the Global Controller fails.
Note If the Global Controller is operating properly and there is Global Controller-to-Local Controller connectivity, we recommend deleting the Local Controller entry from the Global Controller.
Examples
To restore the MARS Appliance to the factory defaults, enter:
To prepare for a Global Controller reset or recovery, enter the following command on each Local Controller monitored by the Global Controller:
To remove the Global Controller communication information and reset a Local Controller to standalone mode, enter the following command on the target Local Controller:
Note You must also delete the Local Controller entry on the Global Controller.
Related Commands
Command
|
Description
|
pnstatus
|
Displays the status of each module running as part of the MARS application.
|
pnupgrade
|
Upgrades the software running on the MARS Appliance.
|
pnrestore
The pnrestore command restores data that has been archived using a network attached storage (NAS) device. You can specify the archival settings from the GUI using Admin > System Maintenance > Data Archiving (see Configure the Data Archive Setting for the MARS Appliance, page 6-31). For more information on the archive file structure and how the archive works, see Configuring and Performing Appliance Data Backups, page 6-20. For more guidance on restoring, see Guidelines for Restoring, page 6-41.
Note While complete system configuration data is archived, the dynamic data that is archived includes only the data that is received or generated after you enable the data archive setting. Therefore, we recommend that you enable archiving before configuring your appliance to receive audit events from reporting devices.
Using the pnrestore command, you can restore three types of data:
•MARS OS—Restores the operating system (OS), including any upgrades that applied before the most recent archive was performed.
Note The version of MARS software running on the appliance to be restored must match the version recorded in the archive. For example, if the data archive is for version 4.1.4, you must re-image the MARS Appliance to version 4.1.4, not older or newer, before using the pnrestore command to recover the system configuration and events.
•System configuration data—Restores system configuration data, such as network settings, reporting devices, custom inspection rules, event types, reports, administrative accounts, archival settings, cases, and any other data that you have entered. It also, as of 4.2.1, includes the specific incident and event data associated with cases. It does not restore all dynamic data, just that data associated with cases.
•Dynamic data—Restores real event data that came from reporting devices, including incidents generated from events.
Note Prior to 4.2.1, performing a restore of just the configuration data resulted in incomplete data required to reconstruct existing cases: all open cases reference incidents and sessions. If this dynamic data is not restored, the cases could reference invalid incident and session IDs. To restore cases for releases prior to 4.2.1, you perform a full restore (mode 2).
To restore archived appliance data, use the pnrestore command:
pnrestore -m 1 -p NFSSeverIP:/archive_path -t start_time
—or—
pnrestore -m 2 -p NFSSeverIP:/archive_path -t start_time
—or—
pnrestore -m 3 -r 1 -p NFSSeverIP:/archive_path -t start_time [-e end_time -s
NFSSeverIP:/stagingAreaPath]
—or—
pnrestore -m 4-r 1 -p NFSSeverIP:/archive_path -t start_time [-e end_time -s
NFSSeverIP:/stagingAreaPath]
—or—
pnrestore -m 5
Command History
Release
|
Modification
|
4.1.1
|
Mode 5 appears (-m 5 option).
|
5.2.4
|
End time (-e), stage path area (-s), and -r 1 options appear.
|
Syntax Description
none The default behavior of this command displays the command's usage guidelines.
-m Restoring mode. Three modes are available: 1 (default), 2, or 5. The mode determines what type of data is restored and from where the data is restored. Table A-2 identifies what data is restored for each option.
Note Mode 5 restores from a backup in the local database; you cannot use it to restore from a NFS archive. As such, you not need to have archiving enabled to perform this restore operation. The configuration data is backed up every night on the appliance. Beware that if you upgrade to a newer release and attempt a restore before that configuration has been backed up, the restore will fail.
-h Displays the detailed command's usage guidelines.
-t Restores the data dated from this time through the most current archive date. Use mm/dd/yy:hh format. This option is required when you select mode r 2.
-e (5.2.4 and later) Used in conjunction with -t and -s, this parameter allows you to specify the end time (endTime) of the data restore range. Used to restore a past range of data.
-s (5.2.4 and later) Used in conjunction with -t and -s, this parameter allows you to specify the path (stagePath) on the NFS server to which to copy the range of data. This option is used to create a staging area from which you can restore a past range of data.
-p Name of the directory where the archived data is stored. You must identify the NFS server by IP address, separated by a :/ and then the pathname NFSSeverIP:/archive_path.
Where NFSSeverIP is the value specified in the Remote Host IP field and archive_path is the value specified in the Remote Path field in the settings found in the web interface at Admin > System Maintenance > Data Archiving. For more information on these settings, see Configure the Data Archive Setting for the MARS Appliance, page 6-31.
-r 1 (5.2.4 and later) Used in conjunction with modes 3 and 4 only. Skips restoring the OS binary; instead only the configuration and dynamic data is restored. Because the version used to write out the archive for a particular time slice may predate the version most recently stored on the NFS server, these modes prevent MARS from overwriting the OS installed in the appliance to read the specified time slice's data.
Table A-2 pnrestore Mode Description
Restore Mode
|
Restore OS?
|
Restore System Configuration?
|
Restore Dynamic Data?
|
1 (default)
|
Yes
|
Yes
|
Partial1
|
2
|
Yes
|
Yes
|
Yes
|
3 -r 1
|
No
|
Yes
|
No
|
4 -r 1
|
No
|
Yes
|
Yes
|
5
|
No
|
Yes2
|
No
|
Examples
You can use the restore feature to complete different restoring tasks, such as:
•Perform a partial restore on the same MARS Appliance using the local backup of the configuration data; it essentially restores the previous days' configuration backup. Use the pnrestore command, mode 5. For example, in the CLI menu of the appliance, enter:
•Perform a partial restore on the same MARS Appliance using the archived data (including the OS and all data), but restoring only the event data generated since January 2, 2006 through the current date. Use the pnrestore command, mode 2. For example, in the CLI menu of the appliance, enter:
pnrestore -m 2 -p 192.168.1.1:/archive/CS_MARS1 -t 01/02/06:0
•Archive and restore data to the same MARS Appliance or a different MARS Appliance of the same model. From the appliance where you want to archive the data, use the GUI to configure archiving. From the appliance to which you want to copy the archived data, use the pnrestore command.
For example, if you only want to copy the OS and the system configuration data, you should use mode 1 of the restore command. For example in the CLI menu of the new appliance, enter:
pnrestore -m 1 -p NFSSeverIPOfOldBox:/archive/CS_MARS1
Caution When restoring Local Controller data, problems can arise if you attempt to restore dynamic data from a bigger appliance to a smaller appliance. In such cases, use mode 1.
•Create a staging area that contains a range of data and determine the correct version of MARS to use when restoring the selected data. Depending on the generation of hardware that generated the archive, pnrestore copies the data range to a target directory. Upon completion, pnrestore displays the version of MARS to use to stage the ranged restore as well as the correct restore parameter and NFS directory to use.
Note Upon completion of a staged restore, use the web interface to change the hostname, IP address, and license settings of the MARS Appliance to the appropriate values.
For example, if you want to stage data between 10/01/06 and 11/01/06 to the corresponding directory under the stageAreaPath directory, enter:
pnrestore -t 10/01/06:00 -e 11/01/06:00 -p nfsIp:/archive -s nfsIp:/stageAreaPath
•Restore only the configuration and runtime data from October 1, 2006 at midnight to November 1 2006 at midnight, with the archive at 10.1.1.1 and the corresponding directory under the stageAreaPath directory at 10.1.10.15.
pnrestore -m 4 -r 1 -t 10/01/06:00 -e 11/01/06:00 -p 10.1.1.1:/archive -s
10.1.10.15:/stagingArea
pnstart
To manually start the MARS application running on the appliance from the serial console, use the pnstart command.
pnstart
Syntax Description
This command has no arguments or keywords.
Examples
The following command starts the MARS application running on the appliance:
pnstatus
To show the status of each module running as part of the MARS application from the serial console, use the pnstatus command.
pnstatus
Note For a description of the processes and services, see List of Backend Services and Processes, page B-11.
All services should be running on a Local Controller. However, a Global Controller only has four services running: autoupdate, graphgen, pnarchiver, and superV—all other services are stopped.
Syntax Description
This command has no arguments or keywords.
Examples
The following command shows the status of each module of the MARS application running on the appliance:
DbIncidentLoaderSrv RUNNING 01:12:18
KeywordQuerySrv RUNNING 01:12:18
autoupdate RUNNING 01:12:18
csiosips RUNNING 01:12:18
device_monitor RUNNING 01:12:18
discover RUNNING 01:12:18
graphgen RUNNING 01:12:18
pnarchiver RUNNING 01:12:18
pndbpurger RUNNING 01:12:18
pnesloader RUNNING 01:12:18
pnparser RUNNING 01:12:19
process_event_srv RUNNING 01:12:19
process_inlinerep_srv RUNNING 01:12:19
process_postfire_srv RUNNING 01:12:19
process_query_srv RUNNING 01:12:19
pnstop
To stop the MARS application running on the appliance from the serial console, use the pnstop command.
pnstop
Syntax Description
This command has no arguments or keywords.
Examples
The following command stops the MARS application running on the appliance:
pnupgrade
To upgrade the software running on the MARS Appliance, use the pnupgrade command. This command supports upgrade from an Internal Upgrade Server and from a CD-ROM. See Checklist for Upgrading the Appliance Software, page 6-6, for details on obtaining upgrade images and preparing the Internal Upgrade Server. The pnupgrade command supports the following syntaxes:
pnupgrade cdrom://path/pn-version.pkg
pnupgrade https://path/pn-version.pkg [user] [password]
pnupgrade http://path/pn-version.pkg [user] [password]
pnupgrade ftp://path/pn-version.pkg [user] [password]
pnupgrade [proxyServerIP:proxyServerPort proxyUser:proxyPassword]
https://path/pn-version.pkg [user] [password]
Note When using the HTTPS syntax, if the certificate of the upgrade server changes between upgrades, you are prompted by pnupgrade to accept the new certificate before the upgrade continues.
As of 4.1.3, the pnupgrade log command is also supported. This command provides a log of each step that was performed during the most recent upgrade. This log is useful in determining which step fails or hangs during a failed upgrade.
pnupgrade log
Syntax Description
proxyServerIP (Optional) Identifies the IP address of the proxy server that resides between your appliance and the Internal Upgrade Server. This option is only valid with the https transport. If you specify a proxy server, you must specify a corresponding port and a proxy server username/password pair.
proxyServerPort Identifies the port on which the proxy server listens for connection requests.
proxyUser Identifies the username that the appliance uses to connect to and authenticate to the proxy server.
proxyPassword Identifies the password that corresponds to the proxyUser account.
path Identifies the path required to access the package file using the selected access upgrade method. For protocols, this is often the URL and path.
version Displays the version number of the upgrade package, for example, 3.3.4.
user Identifies the username that the appliance uses to connect to and authenticate to the Internal Upgrade Server.
password Identifies the passwords that corresponds to the user account.
Examples
pnupgrade cdrom://342files/pn-342.pkg
pnupgrade https://www.example.com/upgrades/pn-342.pkg csAdmin B12e25s
pnupgrade http://www.example.com/upgrades/pn-342.pkg csAdmin 13a12Co13
pnupgrade ftp://www.example.com/upgrades/pn-342.pkg csAdmin 13c14u2020
pnupgrade 192.168.1.1:2642 psAdmin:12o22E13 https://www.example.com/upgrades/pn-342.pkg csAdmin M15m13Y
--------------------------------------
4.1.3 2070 --> 4.1.3 2072
--------------------------------------
1 Preparing upgrade start
1.1 Load the step table start
1.1 Load the step table end
1.4 Stop other applications start
1.4 Stop other applications end
4 Upgrade MARS applications start
4.1 Untar MARS executable binary start
4.2 Untar MARS executable binary end
4.3 Modify janus.conf start
4.3 Modify janus.conf end
raidstatus (5.x)
To view the status of the RAID array and of the individual hard drives, use the raidstatus command.
raidstatus
Syntax Description
This command has no arguments or keywords.
Command History
Release
|
Modification
|
5.2.4
|
This command was introduced in the 5.X release train.
|
5.3.2
|
Support for the MARS 55 was added.
|
Usage Guidelines
This command description section is valid for the MARS Appliance models 55, 110R, 110, 210, GC2 and GC2R.
The raidstatus command is used with the hotswap command to replace component hard drives of the MARS Appliance Raid array.
For information on RAID hotswapping procedures and hard drive alerts, see the chapter, "System Maintenance" in the User Guide for Cisco Security MARS Local Controller at the following URL:
http://www.cisco.com/en/US/docs/security/security_management/cs-mars/5.3/user/guide/local_controller/maintain.html
Examples
The following example displays a MARS 55 with a failed hard drive:
RAID Controller Information:
-------------------------------------------------------
Product Name : Intel Embedded Server RAID Technology
Adapter Raid Type Status Stripe Size
------------------------------------------------------
a0 Raid 1 Degraded 64 KB 476772 MB
Port Status Size Model Serial # Write Cache
--------------------------------------------------------------------------
0 Online 476772 MB HDS725050KLA360 KRVN0AZBH5R3LJ Enabled
1 Failed 476772 MB HDS725050KLA360 KRVN0AZBH5R8RJ Enabled
In the following example, the MARS 210 RAID array is fully operational and redundant, that is, adapter a0 Raid-10 status is optimal, and all of the hard drives are online.
-------------------------------------------------------
Product Name : Intel(R) RAID Controller SROMBSAS18E
Firmware Version : 1.03.00-0211
Adapter RaidType Status Stripe Size Cache
---------------------------------------------------------------
a0 Raid-10 Optimal 64kB 2097151MB Enabled
PD Status Size & Block Model Serial#
-----------------------------------------------------------------------------------------
p0 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E CQD017CET
p1 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E C3QD02EMY
p2 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E C3QD02ELS
p3 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E C3QD02D0A
p4 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E C3QD01T1P
p5 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E C3QD02BZ7
In the following example, the MARS 210 RAID array is shown degraded because hard drive 3 (p3) has failed. The RAID array is functional, but not fully redundant because the p2+p3 RAID 1 pair is compromised.
Adapter Information: -------------------------------------------------
Product Name : Intel(R) RAID Controller SROMBSAS18E
Firmware Version : 1.03.00-0211
Adapter RaidType Status Stripe Size Cache
-------------------------------------------------------------------------------
a0 Raid-10 Optimal 64kB 2097151MB Enabled
PD Status Size & Block Model Serial#
-----------------------------------------------------------------------------------------
p0 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E CQD017CET
p1 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E C3QD02EMY
p2 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E C3QD02ELS
p3 Failed 715404MB [0x575466f0 Sectors] ATA ST3750640AS E C3QD02D0A
p4 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E C3QD01T1P
p5 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E C3QD02BZ7
In the following example, hard drive 3 has been replaced with the hotswap command, and is being rebuilt into the the MARS 210 Raid Array. The Array remains degraded until p3 has Online status. The progress message at the bottom shows percentage complete and time elapsed in the rebuild process.
Adapter Information: C3QD02C0K
-------------------------------------------------------
Product Name : Intel(R) RAID Controller SROMBSAS18E
Firmware Version : 1.03.00-0211
Adapter RaidType Status Stripe Size Cache
---------------------------------------------------------------
a0 Raid-10 Degraded 64kB 2097151MB Enabled
PD Status Size & Block Model Serial#
-----------------------------------------------------------------------------------------
p0 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E CQD017CET
p1 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E C3QD02EMY
p2 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E C3QD02ELS
p3 Rebuild 715404MB [0x575466f0 Sectors] ATA ST3750640AS E C3QD02C0K
p4 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E C3QD01T1P
p5 Online 715404MB [0x575466f0 Sectors] ATA ST3750640AS E C3QD02BZ7
Rebuild Progress on Device at Enclosure 20, Slot 2 Completed 71% in 279 Minutes.
Table A-3 describes the output fields of the raidstatus command.
Table A-3 raidstatus CLI command for MARS 55, 110R, 110, 210, GC2R, and GC2
Output Field
|
Description
|
RAID Controller Information Fields
|
Product Name
|
RAID controller manufacturer and serial number
|
Firmware Version : 1.02.00-0119
|
Indicates version of the RAID controller firmware
|
RAID Array Information Fields ( The RAID 10 Virtual Drive Information)
|
Adapter
|
Identifier for the physical RAID controller.
|
RaidType
|
RAID Level of Array.
|
Status
|
The current state of the RAID virtual drive.
•Optimal—All component HDDs are operating as configured.
•Degraded—At least one of the component HDDs has failed or is offline. Troubleshooting is advised to prevent possible data loss.
•Offline—The array is not available or is unusable.
|
Stripe
|
The data stripe is always 64 KB.
|
Size
|
The available storage in megabytes of the RAID array.
|
Cache (not displayed for the MARS 55)
|
The MARS RAID cache is always enabled.
|
Individual Hard Drive Information Fields
|
PD (Port for MARS 55)
|
p0-p5. The physical hard drive numbers. 0 or 1 for the MARS 55
|
Status
Note Only Online, Failed, Rebuild, and Undefined are supported on the MARS 55.
|
The current state of the physical HDD.
•Online—The HDD is functioning normally within the RAID 10 array.
•Rebuild—The HDD is being reimaged from its RAID 1 partner to restore full redundancy to a the virtual disk. The RAID 10 array efficiency is not yet optimal.
•Failed—The HDD originally was Online, but now has an unrecoverable error. An email alert is sent to the administrator.
•Offline—The HDD was removed by executing a hotswap remove command, but the HDD was not physically removed from the slot. An email alert is sent to the administrator.
•Unconfigured Good—The HDD is usable, but the RAID information is out of sync with the RAID 1 partner. An email alert is sent to the administrator.
•Unconfigured Bad— The firmware detected a media error on the hard drive. An online HDD was probably removed or inserted without executing a hotswap sequence and the HDD now has a media error. An alert is sent to the administrator.
•Undefined—(MARS 55 only) A new HDD has been added but is not RAID 1 formatted, "Undefined" may appear briefly before "Rebuild."
•N/A—There is no HDD in the slot. An email alert is sent to the administrator.
|
Size & Block (not displayed for MARS 55)
|
Size of the usable storage on the HDD
|
Model
|
The model number of the physical HDD
|
Serial#
|
The serial number of the physical HDD.
The string, "This Drive is Foreign" is appended to the serial number when an HDD formatted with metadata from a different RAID controller is introduced. The message is removed when the HDD is assimilated into the array.
|
Write Cache (MARS 55 only)
|
RAID 1 Write Cache is always enabled.
|
Progress Messages
|
Rebuild Progress on Device at Enclosure 0,
Slot 1 Completed 8%
|
(MARS 55) Indicates the slot number and percentage complete of the physical drive being rebuilt.
|
Rebuild Progress on Device at Enclosure
20, Slot 2 Completed 71% in 279 Minutes.
|
Indicates the status, elapsed rebuilding time, and slot number of each physical drive being rebuilt.
|
Related Commands
Command
|
Description
|
hotswap
|
Specifies that a designated hard drive is to be removed or added to a RAID array.
|
reboot
To reboot the MARS Appliance from the serial console, use the reboot command.
reboot
Caution The reboot is immediate and you are not prompted to confirm.
Syntax Description
This command has no arguments or keywords.
Examples
The following command reboots the appliance:
route
The route command manipulates the MARS Appliance's IP routing tables. Its primary use is to set up static routes to specific hosts or networks via an interface after it has been configured with the ifconfig command.
When the add or del options are used, the route command modifies the routing tables. Without these options, the route command displays the current contents of the routing tables.
To list the kernel routing tables, enter:
route [-nNve] [-FC]
To add a route to the routing table, enter:
route [-v] [-FC] add [-net | -host] target [netmask] [gateway] [metric N] [mss M] [window W] [irtt
I] [reject] [mod] [dyn] [reinstate] [[dev] inf_local]
To delete a route from the routing table, enter:
route [-v] [-FC] del [-net | -host] target [netmask] [gateway] [metric N] [[dev] inf_local]
To display detailed usage syntax for the command, enter:
route -h
To display version/author information and exit, enter:
route -V
Syntax Description
none The default behavior of this command displays the command's usage guidelines.
add Add a route to the table.
del Delete the specified route from the table.
-net Identifies the route as a network route.
-host Identifies the route a host route.
target IP address of the host or network for which you are defining a route.
netmask Network mask that corresponds to the ip_addr value.
gateway IP address of the gateway for this route.
mms M Set the TCP Maximum Segment Size (MSS) for connections over this route to M bytes. The default is the device MTU minus headers, or a lower MTU when path mtu discovery occurred.
window W Set the TCP window size for connections over this route to W bytes.
irtt I Set the initial round trip time (irtt) for TCP connections over this route to I milliseconds (1-12000). If omitted, the default value is 300ms.
reject Install a blocking route, which forces a route lookup to fail. Use this feature, for example, to mask out networks before using the default route. Do not use for firewalling.
mod, dyn Reinstate install a dynamic or modified route. These flags are for diagnostic purposes, and are generally only set by routing daemons.
-h Displays the detailed command's usage guidelines.
-v Display verbose information.
-n Display numeric values for addresses; don't resolve hostnames.
-e Display extended information.
-F Display Forwarding Information Base (FIB), which is the default.
-C Display routing cache instead of FIB.
script
Use the restricted script command mode to execute provided script:
script [-b] program
Syntax Description
program Identifies the name of the script to run.
Command History
Release
|
Modification
|
4.3.1
|
This command was introduced in the 4.3.1 release.
|
5.3.1
|
This command was introduced in the 5.3.1 release.
|
Usage Guidelines
The following scripts are available from the restricted script command mode:
•get_mars_summary_info.sh— Gather high level statistics about the configuration and topology for the MARS Appliance.
Examples
The following example gathers high level statistics about the MARS Appliance's configuration and topology.
[pnadmin]$ script get_mars_summary_info.sh
Collecting MARS summary info from the DB in HTML format
Started at Fri Sep 14 05:50:10 PDT 2007
Use 'pnlog mailto' command to include it in the logs
This may take several minutes to complete. Use Ctrl+C in case you need to interrupt.
Completed at Fri Sep 14 05:50:10 PDT 2007
show healthinfo
To display the operational status of key components in the appliance use the show healthinfo command.
show healthinfo
Syntax Description
There are no arguments or keywords for this command.
Command History
Release
|
Modification
|
5.2.4
|
This command was introduced in the 5.X release train.
|
Usage Guidelines
The show healthinfo command displays the operational status of critical components, such as fans, CPUs, hard drives, Ethernet interfaces, power supplies, backup battery units, memory usage, and the operating system.
Power Supply
In the command output for Power Supply, PS1 is the lower power supply, PS2 is the upper power supply. In normal operation, PS1 supplies most of the power requirements, and PS2 is the redundant power supply.
Ethernet Card Status
In the command output for Ethernet, eth0 is integrated NIC 1, eth1 is integrated NIC 2; eth2 and eth3 are not supported.
Raid Battery Backup Unit
In the command output for BBU, the relative state of charge is directly proportional to the battery backup time (100%charge = 72hours ).
For more information on RAID BBU and power supply procedures, see the chapter, "System Maintenance" in the User Guide for Cisco Security MARS Local Controller at the following URL:
http://www.cisco.com/en/US/docs/security/security_management/cs-mars/5.3/user/guide/local_controller/maintain.html
Examples
The following example dispays the health monitoring information on a MARS 110.
[pnadmin]$ show healthinfo
Processor Vendor ID Model CPU(MHZ)
0 GenuineIntel Intel(R) Xeon(R) CPU 5130 @ 2.00GHz 1995.024
1 GenuineIntel Intel(R) Xeon(R) CPU 5130 @ 2.00GHz 1995.024
2 GenuineIntel Intel(R) Xeon(R) CPU 5130 @ 2.00GHz 1995.024
3 GenuineIntel Intel(R) Xeon(R) CPU 5130 @ 2.00GHz 1995.024
MemTotal: 4137832 kB MemFree: 18812 kB
----------------------------------
--------------------------------
Power Supply Value Status
----------------------------------------
PS1 AC Current 2.36 Amps ok
PS2 AC Current 0.12 Amps ok
PS1 +12V Current 21 Amps ok
PS2 +12V Current 0 Amps ok
PS1 +12V Power 248 Watts ok
PS2 +12V Power 0 Watts ok
Relative state of charge : 93 %
Full charge capacity : 920 mAh
Remain capacity : 858 mAh
Linux SJ-LC-17 2.6.9-42.0.2.ELsmp #1 SMP Thu Aug 17 18:00:32 EDT 2006 i686 i686 i386
GNU/Linux
Related Commands
Command
|
Description
|
ifconfig
|
Displays or modifies the IP address and network mask of the network interfaces.
|
show inventory
|
Displays identifying details of essential components in the appliance.
|
show inventory
To display an inventory and serial numbers of essential components in the MARS Appliance, use the show inventory command.
show inventory
Syntax Description
There are no arguments or keywords for this command.
Command History
Release
|
Modification
|
5.2.4
|
This command was introduced.
|
Usage Guidelines
The show inventory command displays the part identification string (PID) and serial numbers of the chassis, hard drives, RAID battery backup unit, and power supplies.
Examples
The following example displays the inventory of a MARS 110 Local Controller:
[pnadmin]$ show inventory
NAME: "Chassis", DESCR: "CS-MARS-110 Local Controller"
PID: CS-MARS-110, VID: V01, SN: M1100000027
NAME: "Hard Disk Drive", DESCR: "Barracuda ES - Serial ATA II - 3.0Gps - 500GB"
PID: CS-MARS-S500-HD, VID: , SN: 5QG02GFH
NAME: "Hard Disk Drive", DESCR: "Barracuda ES - Serial ATA II - 3.0Gps - 500GB"
PID: CS-MARS-S500-HD, VID: , SN: 5QG00KH4
NAME: "Hard Disk Drive", DESCR: "Barracuda ES - Serial ATA II - 3.0Gps - 500GB"
PID: CS-MARS-S500-HD, VID: , SN: 5QG02GCH
NAME: "Hard Disk Drive", DESCR: "Barracuda ES - Serial ATA II - 3.0Gps - 500GB"
PID: CS-MARS-S500-HD, VID: , SN: 5QG02GE4
NAME: "Hard Disk Drive", DESCR: "Barracuda ES - Serial ATA II - 3.0Gps - 500GB"
PID: CS-MARS-S500-HD, VID: , SN: 5QG02GHJ
NAME: "Hard Disk Drive", DESCR: "Barracuda ES - Serial ATA II - 3.0Gps - 500GB"
PID: CS-MARS-S500-HD, VID: , SN: 5QG02GGV
RAID Battery Backup Unit Information:
NAME: "Battery", DESCR: "MARS110/210/GC2 RAID Controller Back-Up Battery"
PID: CS-MARS-X10-BB, VID: , SN: 313
Power Supply Information:
NAME: "Power supply", DESCR: "MARS110/210/GC2 Power Supply Module"
PID: CS-MARS-D750-PS, VID: , SN: DLD0636022220
NAME: "Power supply", DESCR: "MARS110/210/GC2 Power Supply Module"
PID: CS-MARS-D750-PS, VID: , SN: DLD0621008449
Related Commands
Command
|
Description
|
show healthinfo
|
Displays operational status of appliance components.
|
shutdown
To shut down the appliance and turn off the power from the serial console, use the shutdown command.
shutdown
Caution The shutdown is immediate and you are not prompted to confirm.
To turn on the appliance after executing the shutdown command, you must have physical access to it. For more information, see Powering on the Appliance and Verifying Hardware Operation, page 4-8.
Syntax Description
This command has no arguments or keywords.
Examples
The following command shuts down the appliance:
snmpwalk
The snmpwalk command loads an SNMP application that uses SNMP GETNEXT requests to query a network entity for a tree of information.
To use snmpwalk, enter:
snmpwalk [options...] <hostname> {<community>} [<objectID>]
Syntax Description
none The default behavior of this command displays the command's usage guidelines.
-h The default behavior of this command displays the command's usage guidelines.
hostname Identifies the DNS name of the device against which the snmpwalk command will be run. Typically, this device is a router or switch. This device must have SNMP management access enabled and the MARS Appliance must be a valid management host.
community Identifies the community string for SNMP transactions.
objectID An object identifier (OID) may be given on the command line. This OID specifies which portion of the object identifier space to search using GETNEXT requests. If no OID argument is present, the snmpwalk command searches MIB-2.
ssh
To access the SSH client that resides on the appliance, use the ssh command.
ssh [options] host [command]
Syntax Description
none The default behavior of this command displays the command's usage guidelines.
-h Displays the detailed command's usage guidelines.
-l user Log in using this username.
-n Redirect input from /dev/null.
-F config Config file (default: ~/.ssh/config).
-A Enable authentication agent forwarding.
-a Disable authentication agent forwarding (default).
-X Enable X11 connection forwarding.
-x Disable X11 connection forwarding (default).
-i file Identity for public key authentication (default: ~/.ssh/identity).
-t Tty; allocate a tty even if command is given.
-T Do not allocate a tty.
-v Verbose; display verbose debugging messages. Multiple -v increases verbosity.
-V Display version number only.
-q Quiet; do not display any warning messages.
-f Fork into background after authentication.
-e cha Set escape character; "none"' = disable (default: ~).
-c cipher Select encryption algorithm.
-m macs Specify MAC algorithms for protocol version 2.
-p port Connect to this port. Server must be on the same port.
-L listen-port:host:port
Forward local port to remote address
-R listen-port:host:port
Forward remote port to local address.
These cause ssh to listen for connections on a port, and forward them to the other side by connecting to host:port.
-D port Enable dynamic application-level port forwarding.
-C Enable compression.
-N Do not execute a shell or command.
-g Allow remote hosts to connect to forwarded ports.
-1 Force protocol version 1.
-2 Force protocol version 2.
-4 Use IPv4 only.
-6 Use IPv6 only.
-o 'option' Process the option as if it was read from a configuration file.
-s Invoke command (mandatory) as SSH2 subsystem.
-b addr Local IP address.
sslcert
Use the sslcert command to generate a new self-signed SSL certificate and reboot the JBoss Application Server.
To use this command, you will be prompted to provide the following information:
•The common name of the MARS Appliance
•The name of your organizational unit (OU)
•The name of your organization (O)
•The name of your City or Locality (L)
•The name of your State or Province (SP)
•The two-letter country code for the unit (C)
To generate a new self-signed certificate for use with this MARS Appliance, use the sslcert command:
sslcert
Syntax Description
none The default behavior of this command launches an interactive program that collects the information required to generate a certificate. You are prompted to verify that you want to generate a new self-signed certificate. Enter YES to begin the interview process that will collect the data required to generate the certificate. Enter NO to cancel without generating a new certificate.
Examples
The following command generates a new self-signed certificate:
Sslcert command will generate a new ssl certificate and restart jboss.
Please type YES if you want to proceed: YES
What is the common name of this device? (CN)
What is the name of your organizational unit? (OU)
What is the name of your organization? (O)
What is the name of your City or Locality? (L)
What is the name of your State or Province? (SP)
What is the two-letter country code for this unit? (C)
Certificate stored in file <server.cert>
Certificate was added to keystore
ssllist
Use the ssllist command to display the list of ssl certificates that exist in your keystore.
ssllist
Syntax Description
There are no arguments or keywords for this command.
Command History
Release
|
Modification
|
5.2.4
|
This command was introduced in the 5.2.4 release.
|
Examples
The following command displays the SSL certificates:
Your keystore contains 2 entries
global, Dec 29, 2006, trustedCertEntry,
Certificate fingerprint (MD5): 85:2A:05:46:4E:6B:AB:15:B4:EE:77:FE:3C:4A:EE:65
server, Dec 28, 2006, trustedCertEntry,
Certificate fingerprint (MD5): 6A:C8:50:8C:FA:65:BB:E2:08:F1:75:80:A4:69:47:90
syslogrelay setcollector
To set, change, or clear the IP address of a host to which the Local Controller forwards the syslog messages it receives, use the syslogrelay setcollector command.
syslogrelay {setcollector | unsetcollector} ip_address
Command History
Release
|
Modification
|
4.3.1
|
This command was introduced in the 4.X release train.
|
5.3.1
|
This command was introduced in the 5.X release train.
|
Syntax Description
setcollector
|
Indicates the provided IP address is the collector.
|
unsetcollector
|
Clears the provided IP address, and disables the syslog relay feature.
|
ip_address
|
Indicates one IP address. You cannot define more than one collector.
|
Usage Guidelines
The syslogrelay setcollector command allows you to specify the IP address of the syslog server to which syslog messages should be forwarded. This command must be used in conjunction with the syslogrelay src command, which designates the reporting devices for which syslog messages should be forwarded.
Examples
The following example specifies that the Local Controller should forward the syslog messages to 192.168.1.25, which is the designated address of the collector.
[pnadmin]$ syslogrelay setcollector 192.168.1.25
The following example changes the address of the collector defined in the previous
example.
[pnadmin]$ syslogrelay setcollector 192.168.1.26
syslogrelay setcollector 192.168.1.26
Changing collector ip from 192.168.1.25 to 192.168.1.26. Continue? [y/n]:
The following example clears the address of the collector defined in the previous example, effectively disabling the syslog relay feature until a new collector address is set.
[pnadmin]$ syslogrelay unsetcollector 192.168.1.26
Related Commands
Command
|
Description
|
syslogrelay src
|
Add to, exclude from, or clear the list of IP addresses for which the Local Controller forwards syslog messages to the collector.
|
syslogrelay list
|
Displays the list of IP addresses used by the syslogrelay. This list includes the collector, as well as reporting devices in the include and/or exclude lists.
|
syslogrelay src
To add to, remove from, or clear the lists of sources (reporting devices) for which the Local Controller forwards the syslog messages it receives to the collector, use the syslogrelay src command.
syslogrelay src {include | exclude} {ANY | ip_address}
syslogrelay src reset
Command History
Release
|
Modification
|
4.3.1
|
This command was introduced in the 4.X release train.
|
5.3.1
|
This command was introduced in the 5.X release train.
|
Syntax Description
include
|
Indicates that syslog messages received by MARS from the listed IP addresses to be relayed to the configured collector.
|
exclude
|
Indicates that syslog messages received by MARS from the listed IP addresses should not be forwarded to the configured collector.
|
ANY
|
Adds all IP addresses to the selected source list.Used in conjunction with either the include or exclude parameter.
|
ip_address
|
Indicates between one and ten IP addresses in a comma separated list. Used in conjunction with the include and exclude parameters. You can only add up to ten addresses at one time; however, you can use the command repeatedly to add to the list.
|
reset
|
Clears the active syslog relay source configuration—both the include and exclude lists. If a syslog relay source is configured, the following prompt appears:
One or more device addresses are currently configured. Proceed
further? [yes/no]:
Enter yes to clear the source configuration or no to cancel.
|
Usage Guidelines
The syslogrelay src command designates the set of reporting devices for which the Local Controller forwards the syslog messages it receives to the collector. You can exclude all addresses, defining the few exceptions for which the syslog messages should be forwarded; or you can enable all addresses, and define the exceptions that should not be forwarded.
The ANY token cannot be used simultaneously in both the include and exclude lists. If the value is set on one list, and you apply it to the other list, it is removed from the first.
The syslogrelay src include ANY command indicates that all syslog messages received by MARS be relayed to the configured collector, excepting those that originate from the addresses configured as exclusions. If exclusions are configured, the following prompt appears:
One or more device ip addresses are currently excluded. Proceed further? [y/n]:
Enter y to retain the current exclusions and forward the syslog messages of from all other reporting devices, or enter n to cancel.
The syslogrelay src exclude ANY command indicates that all syslog messages received by MARS should not be forwarded to the configured collector, excepting those that originate from addresses configured as inclusions. If inclusions are configured, the following prompt appears:
One or more device ip addresses are currently included. Proceed further? [y/n]:
Enter y to retain the current inclusions and prevent the forwarding of syslog messages from all other devices, or enter n to cancel.
Examples
The following example specifies that the Local Controller should forward the syslog messages it receives from any reporting device to the collector (as long as the source IP address of the message is not in the source exclude list).
[pnadmin]$ syslogrelay src include ANY
The following example specifies that the Local Controller should not forward the syslog messages it receives from 192.168.1.1 or 192.168.2.1 to the collector.
[pnadmin]$ syslogrelay src exclude 192.168.1.1, 192.168.2.1
The following example clears the source include and exclude lists of all values:.
[pnadmin]$ syslogrelay src reset
One or more device ip addresses are currently configured. Proceed further?[yes/no]: yes
Related Commands
Command
|
Description
|
syslogrelay setcollector
|
Set or clear the IP address that identifies the syslog collector to which the Local Controller forwards syslog messages. If the address is cleared, this feature is turned off.
|
syslogrelay list
|
List syslog relay configuration. Displays the list of IP addresses used by the syslogrelay. This list includes the collector, as well as reporting devices in the include and/or exclude lists.
|
syslogrelay list
To display the IP addresses of the reporting devices to which the Local Controller forwards the syslog messages as well as the IP address of the collector to which they are sent, use the syslogrelay list command.
syslogrelay list [all | collector | src]
There are no arguments or keywords for this command.
Command History
Release
|
Modification
|
4.3.1
|
This command was introduced in the 4.X release train.
|
5.3.1
|
This command was introduced in the 5.X release train.
|
Syntax Description
-h
|
Displays usage guidelines
|
all
|
(default) Displays the IP address of the collector and the union of those sources on the include list and exclude list.
|
collector
|
Displays the IP address of the collector, or destination, of the forwarded messages.
|
src
|
Displays the IP addresses of the sources on the include list and exclude list.
|
Usage Guidelines
Using the syslogrelay list command, you can verify the list of addresses in the include and exclude lists. If a reporting device device appears in the include list, the Local Controller forwards any syslog messages that it receives from that device to the syslog collector. The exclude list identifies the IP addresses for which the Local Controller does not forward the syslog messages. The collector identifies the IP address to which the specified syslog messages are forwarded. This address represents a syslog server or other collector as defined in RFC 3164: The BSD syslog Protocol.
If the collector address is not set, the syslogrelay feature is disabled.
Examples
The following example displays the t syslog relay configuration.
[pnadmin]$ syslogrelay list all
Related Commands
Command
|
Description
|
syslogrelay setcollector
|
Set or clear the IP address that identifies the syslog collector to which the Local Controller forwards syslog messages. If the address is cleared, this feature is turned off.
|
syslogrelay src
|
Add to, exclude from, or clear the list of IP addresses for which the Local Controller forwards syslog messages to the collector.
|
sysstatus
The sysstatus command is a system-defined alias for the Linux top command, which displays and updates information about the top CPU processes. It provides a real-time view of the processor activity. It lists the most CPU-intensive tasks on the system, and can provide an interactive interface for manipulating processes. It can sort the tasks by CPU usage, memory usage, and runtime.
To view the current CPU activities, enter:
sysstatus -hvbcisqS -d delay -p pid -n iterations
If you execute the command and you do not select the batch mode option, you are running in an interactive environment. In this environment, you can interact with the output as follows:
•Press H or ? to get the list of interactive commands.
•Press the space key to refresh the data immediately.
•Press Ctrl+L to erase and redraw the screen.
•Press K to kill a specific process ID (pid).
•Press Q to quit viewing the real-time data and return to the command prompt.
•Press Ctrl+C to break the batch mode display.
•Press I to toggle ignoring idle and zombie processes.
•Press N or # to specify the number of processes to display on the screen. The value of zero (0) restores the default, which is the number of processes that fit on the screen.
•Press S to toggles the cumulative mode, the equivalent of -S, that includes a process's defunct children as part of the CPU times.
•Press f or F to add fields or remove fields from the display.
•Press o or O to change the order of the displayed fields.
•Press L to toggle the display of load average and uptime information.
•Press M to toggle the display of memory information.
•Press T to toggle the display of processes and CPU states information.
•Press C to toggle the display of command name or full command line.
•Press N to sort the tasks numerically by pid.
•Press A to sort the tasks by age (newest first).
•Press P to sort the tasks by CPU usage (default).
•Press M to sort the tasks by resident memory usage.
•Press T to sort the tasks by time/cumulative time.
Syntax Description
none The default behavior of this command displays the current CPU activities.
-h Displays the detailed command's usage guidelines.
-d Specifies the delay between screen updates. You can change this delay using the -s interactive command.
-p Monitors only those processes with the given process id. This flag can be given up to twenty times. This option is not available interactively.
-q This causes sysstatus to refresh without any delay.
-S Specifies cumulative mode, where each process is listed with the CPU time it has spent. It also lists the CPU time of the dead children for each process.
-s Tells sysstatus to run in secure mode. This option disables the potentially dangerous interactive commands.
-i Start sysstatus ignoring any idle or zombie processes.
-C Display total CPU states in addition to individual CPUs. This option only affects SMP systems.
-c Display the command line instead of the command name only. The default behavior has been changed as this seems to be more useful.
-n Number of iterations. Update the display this number of times and then exit.
-b Batch mode. Useful for copying output from sysstatus to a file. In this mode, sysstatus does not accept command line input. It runs until it reaches the number of iterations specified by the n option or until killed. Output is plain text suitable for display on a dumb terminal.
tcpdump
Tcpdump prints out the headers of packets on a network interface that match the boolean expression. To analyze packet headers, enter:
tcpdump [-adeflnNOpqRStuvxX] [-c count] [ -i interface ] [ -s snaplen ] [ -T type ] [ -U user ] [
expression ]
Note For more information on this command and its use, please refer to a Linux manual or man page.
Syntax Description
none The default behavior of this command displays current CPU activities.
-h Displays the detailed command's usage guidelines.
-i interface Identifies the interface to sniff.
-c count Exit after receiving count number of packets.
Ctrl+c Exit the tcpdump screen.
telnet
The telnet command is used to communicate with another host using the TELNET protocol. In this mode, it accepts and executes the commands listed below. If it is invoked with arguments, it performs an open command with those arguments.
telnet [-8] [-E] [-L] [-S tos] [-a] [-c] [-d] [-e char] [-l user] [-n tracefile] [-b hostalias ] [-r]
[hostname [port]]
Syntax Description
none If telnet is invoked without the host argument, it enters command mode, indicated by its prompt (telnet>).
-h Displays the detailed command's usage guidelines.
-8 Specifies an 8-bit data path, which forces telnet to attempt to negotiate the BINARY option on both input and output.
-E Stops any character from being recognized as an escape character.
-L Specifies an 8-bit data path on output. This causes the BINARY option to be negotiated on output.
-a Attempt automatic login. The name used is that of the current user.
-b hostalias Uses bind on the local socket to bind it to an aliased address (see ifconfig and the "alias" specifier) or to the address of another interface than the one naturally chosen by connect. This can be useful when connecting to services which use IP addresses for authentication and reconfiguration of the server is undesirable (or impossible).
-c Disables the reading of the user's .telnetrc file.
-d Sets the initial value of the debug toggle to TRUE.
-e escapechar Sets the initial telnet escape character to escapechar. If escapechar is omitted, there will be no escape character.
-l user When a host connects to the remote system, if the remote system understands the ENVIRON option, the user will be sent to the remote system as the value for the variable USER. This option implies the -a option. This option may also be used with the open command.
-n tracefile Opens tracefile for recording trace information.
-r Specifies a user interface similar to rlogin. In this mode, the escape character is set to the tilde (~) character, unless modified by the -e option.
hostname Indicates the official name, an alias, or the Internet address of a remote host.
port Indicates a port number (address of an application) used to connect on the remote host. If a number is not specified, the default telnet port is used.
time
To display the current time, enter:
timezone
To set the time to 11:15 p.m., enter:
time [hh:mm:ss]
Note Time changes on the appliance are immediate, which can affect active incident correlation. If you change the time by greater than one half hour, you should restart your appliance to ensure that all processes synchronize using the new time.
Syntax Description
hh:mm:ss Identifies the time in hh:mm:ss format, where hh is 01-24, mm is 00-59 and ss is 00-59.
Examples
To display the current time, enter:
timezone
To set the time to 11:15 p.m., enter:
time 23:15:00
timezone
To display the current timezone setting, enter:
timezone
To set a new timezone, enter:
timezone set
When configuring a Global Controller\Local Controller hierarchy, you should ensure that all the Local Controllers are set to the same timezone as the reporting devices that they are monitoring.
Note Time changes on the appliance are immediate, which can affect active incident correlation. If you change the time by greater than 30 minutes, you should restart your appliance to ensure that all processes synchronize using the new time.
Syntax Description
set Displays a menu system that allows you to select the appropriate timeszone based on continent/country/region or using the POSIX TZ format.
Examples
To display the current timezone setting, enter:
timezone
To set the timezone to CST, enter:
timezone set
traceroute
To display the network route that packets take to reach a specified host, enter:
traceroute [hostname | ip_address]
Traces the route that IP packets take from the MARS appliance to another host on a network by listing the intermediate gateways that the packet traverses to reach the host.
Traceroute displays the IP address and hostname (if possible) of the gateways along the route taken by the packets. Traceroute is used as a network debugging tool. If you are having network connectivity problems, traceroute will help you diagnose where the trouble might exist along the route.
Syntax Description
none The default behavior of this command displays the command's usage guidelines.
hostname Identifies the host by hostname for which you want to trace the route.
ip_address Identifies the host by IP address for which you want to trace the route.
unlock
Use the unlock command to restore access to the MARS Appliance GUI for all or specified user accounts after login failures.
unlock {-a} | {{-l | -g | -b } login_name}
Command History
Release
|
Modification
|
4.3.1/5.3.1
|
This command was introduced.
|
Syntax Description
-a
|
Unlocks all accounts on the MARS Appliance.
|
-l
|
Unlocks the local account for the specified login name.
|
-g
|
Unlocks the global account for the specified login name.
|
-b
|
Unlocks global and local accounts for the specified login name.
|
login_name
|
Specifies the login name of the account to be unlocked.
|
Usage Guidelines
For both Local or AAA authentication methods, GUI access is prevented (locked) for an account upon login failure, which occurs when a specified number of incorrect password entries are made for a single login name. The administrator GUI access can be locked like any other account.
The CLI access through the console or through SSH is never locked. The unlock CLI command can unlock GUI access for some or all accounts.
Unlocking is not replicated through Global Controller-Local Controller communications, it applies only to the local appliance. An account locked on a Global Controller does not replicate the locked status to global accounts on Local Controllers. A global account locked on two different appliances must be unlocked manually on each appliance.
For more information on account locking and login failure, see the section, "Information About Authenticating MARS User Accounts with External AAA Servers" at the following URL:
http://www.cisco.com/en/US/docs/security/security_management/cs-mars/5.3/user/guide/local_controller/authen.html
Examples
The following example unlocks GUI access for a local account with the login name bleistiftansatz:
[pnadmin]$ unlock -l bleistiftansatz
Related Commands
Command
|
Description
|
passwd
|
Changes the password of the system administrative account (pnadmin) associated with the appliance.
|
version
To display the version of MARS software that is running on the appliance, use the version command. The version number appears in the following format: major.minor.patch (build no.)
Syntax Description
This command has no arguments or keywords.
Examples
To display the current version, enter: