FACT Quick Start Guide
From DocWiki
m (→Annotating a Log File) |
m (Quick Start Guide (SVBU) moved to FACT Quick Start Guide: Make title reflect name of product, not responsible BU.) |
Revision as of 23:11, 1 April 2008
Contents |
Installing FACT
FACT runs on Linux with the following supported distributions:
- RedHat Enterprise Linux, versions 4 and 5
- SUSE Linux Enterprise Distribution, versions 9 and 10
FACT is distributed as an RPM file. To install the RPM, log in as a superuser, and enter the following command:
- # rpm -i fact-v0.9.0.1-noarch.rpm
Creating the Main Configuration File
To create the main configuration follow, perform the following steps:
- Create the file .fact.conf in your home directory by using a text editor and entering the following line into the file: credential-file: ~/.fact-credentials
- Add lines to the file that specify the DNS names or IP addresses of each of your managed IB switches. Optionally, specify the names of each of your hosts. If you are using the High-Performance Subnet Manager (HSM), you must specify that host in the fact.conf file.
- The lines for a Cisco SFS Server Switch running SFS-OS appear as the following:
- managed-nodes: SFSOS switch name
- The lines for a Cisco SFS 7012 or Cisco SFS 7024 Server Switch appear as the following:
- managed nodes: OEM switch name
- The lines for a host appear as the following:
- managed-nodes: host name
- You can use a pattern for the name if several devices have similar names. For example, if you have a small network with eight hosts, a Cisco SFS 3001 Server Switch, and a Cisco SFS 7012 Server Switch, the DNS names would be myhost1 through myhost8, my3001, and my7012, respectively. Therefore, you would create the following .fact.conf file:
- credentials-file: ~/.fact-credentials
- managed-nodes: host myhost[1-8]
- managed-nodes: SFSOS switch my3001
- managed-nodes: OEM switch my7012
Creating a Credentials File
Create a file named .fact-credentials in your home directory using a text editor. For each managed node (switch or host) that you listed in fact.conf, add a username and a password that FACT can use to log in to that managed node. Optionally, you can use wildcards if several devices use the same username and password.
- host myhost[1-8]
- user: myname
- password: secret
FACT has default usernames and passwords. If your switches use the defaults, you do not need to enter them into the credentials file. For Cisco switches that use SFS OS, use "super" as the default username and as the password; for Cisco EOM switches, which are the SFS 7012 and SFS 7024, use "admin" as the default username and as the password, as shown in the following examples:
- Cisco SFS OS switch
- user: super
- password: super
- OEM switch
- username: admin
- password: admin
Collecting a Scan
To collect a scan, enter the following command:
- fact scan fabric
FACT will log in to each switch and host that you listed in the .fact.conf file and collect information from it. FACT then searches that subnet to find the master Subnet Manager and collect more information from it, as shown in the following example:
- $ fact scan fabric
- Scanning myswitchA
- Scanning myswitchB
- Scanning myhost1
- Scanning myhost2
- Scanning myhost3
- Scanning myhost4
- Scanning myhost5
- Scanning myhost6
- Scanning myhost6
- Scanning myhost7
- Scanning myhost8
- Scanning Master Subnet Manager at myswitchA
- $
Viewing a Network
Use the following commands to see information about the current scan:
- show subnet-managers
- show versions
- show chassis
- show chips
- show ports
The following examples show possible output for the previous commands:
$
- fact> show chassis
[find output to place here]
- fact> show subnet-managers
[find output to place here]
- fact> show ports myswitchA
[find output to place here]
- fact> show subnet-managers
[find output to place here]
- fact> exit
$
Annotating a Log File
FACT can annotate a log file, or any other type of file. When FACT annotates a file, it finds GUIDs and inserts meaningful names inline in the text. FACT also includes information about the port in an annotation, such as the port location, the port neighbor, and the last-known neighbor, as shown in the following example:
- $fact annotate pass-though mysubnetmanagerlog.text
[add output here] $
Viewing a History Scan
FACT retains all scans, which you can view by using the show history command, as shown in the following example:
- $ fact
- fact> show history
[add output here]
Learning More About FACT
To learn more about FACT, enter the fact --help command to view the command-line options, or enter the fact --help-commands command to view a short list of the commands that FACT understands.
