FACT Quick Start Guide

From DocWiki

(Difference between revisions)
Jump to: navigation, search
m (Quick Start Guide (SVBU) moved to FACT Quick Start Guide: Make title reflect name of product, not responsible BU.)
(Obtaining FACT Software)
 
(13 intermediate revisions not shown)
Line 1: Line 1:
-
==Installing FACT==
+
This section includes the minimal tasks involved in installing and configuring FACT. For details about these installation and configuration tasks, see [[Obtaining and Installing FACT|Obtaining and Installing FACT]] and [[Creating FACT Configuration Files|Creating FACT Configuration Files]].
-
FACT runs on Linux with the following supported distributions:
+
= Obtaining and Installing FACT Software =
-
* RedHat Enterprise Linux, versions 4 and 5
+
Before you obtain and install FACT, ensure that you are running the following software on your system: RedHat Enterprise Linux, Version 4 or 5, or SUSE Linux Enterprise Distribution, Version 9 or 10, and Python, Version 2.3 or later.
-
* 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'''
+
==Obtaining FACT Software==
 +
FACT is distributed as an RPM file. To obtain a copy of the FACT RPM, perform the following steps:
-
==Creating the Main Configuration File==
+
'''Step 1''' Navigate to the Cisco software download site at the following URL: http://www.cisco.com/kobayashi/sw-center/index.shtml
-
To create the main configuration follow, perform the following steps:
+
::If you are not already a registered user, you must register at the above URL to gain access to software downloads.
-
#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'''
+
'''Step 2''' Select the software product category by clicking the '''Server Network and Virtualization''' link.
-
#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:
+
'''Step 3''' Select a device by choosing '''Server Fabric Software > InfiniBand Management Software > Cisco Fabric Analysis and Correlation Toolkit'''.
-
::'''managed-nodes: SFSOS switch ''name'''''
+
==Installing FACT Software==
-
:The lines for a Cisco SFS 7012 or Cisco SFS 7024 Server Switch appear as the following:
+
To install the FACT software RPM, perform the following steps:
-
::'''managed nodes: OEM switch ''name'''''
+
'''Step 1''' Log in to your console as a super user.
-
:The lines for a host appear as the following:
+
'''Step 2''' Install the RPM by entering the following command:
-
::'''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:
+
::'''rpm -i cisco-fact-''' ''version'' '''.noarch.rpm'''
 +
'''Step 3''' FACT installs the software without status messages. To verify that you have installed the correct version of FACT, enter the '''fact -v''' command, and verify the version number in the command output.
-
::'''credentials-file:  ~/.fact-credentials'''
+
=Configuring FACT Software=
-
::'''managed-nodes:    host        myhost[1-8]'''
+
To configure FACT software you must create the master configuration file and create the credentials file.
-
::'''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.
+
==Creating the Master Configuration File==
 +
For more information about master configuration files, see [[About FACT Configuration Files#About Master Configuration Files|About Master Configuration Files.]]
 +
To create the master configuration file, perform the following steps:
-
:'''host myhost[1-8]'''
+
'''Step 1''' Log in to your host as a super user.
-
:: user:    ''myname''
+
-
:: password: ''secret''
+
 +
'''Step 2''' Using a text editor, create a master configuration file names .fact.conf in your home directory.
-
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:
+
'''Step 3''' Enter the following line into the configuration file:
 +
::'''credential-file: ~/.fact-credentials'''
-
: '''Cisco SFS OS switch'''
+
'''Step 4''' For each managed switch that is running SFS OS in your network, add a line to the master configuration file that specifies the hostname or IP address:
-
:: user:    '''super'''
+
::'''managed-nodes: SFSOS switch''' ''name''
-
:: password: '''super'''
+
-
:'''OEM switch'''
+
::For information about managed nodes, see [[About FACT Configuration Files#About Managed Node Definitions Files|About Managed Node Definitions Files]].
-
::username: '''admin'''
+
-
::password: '''admin'''
+
-
==Collecting a Scan==
+
'''Step 5''' For each managed OEM switch that is in your network (either a Cisco SFS 7012 or Cisco SFS 7024), add a line to the file that specifies the hostname or IP address:
 +
::'''managed-nodes: OEM switch''' ''name''
-
To collect a scan, enter the following command:
+
'''Step 6''' If you are using the High-Performance Subnet Manager, specify each host that runs the High-Performance Subnet Manager in the master configuration file:
-
: '''fact scan fabric'''
+
::'''managed-nodes: host''' ''name''
-
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:
+
'''Step 7''' (Optional) FACT usually determines the names of hosts on the network without needing to log in to them. If FACT does not identify the hosts or if you want FACT to collect additional diagnostic information from the hosts, add each host in your network to the master configuration file:
 +
::managed-nodes: host ''' ''name''
-
: $ '''fact scan fabric'''
+
'''Step 8''' (Optional) If you have unmanaged switches in your network, add a line to the master configuration file that specifies the GUID name and creates a name for the switch. (For more information about GUID names, see [[About FACT Configuration Files#About Credentials Files|About GUID Name Definitions]].) You may use any name for the switch, but you must use the following format for the line that you add to the file:
-
: Scanning myswitchA
+
::guid-name: 00:1b:0d:00:00:ca:a6 switchA
-
: Scanning myswitchB
+
::guid-name: 00:1b:0d:00:00:ca:aa switchB
-
: 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:
+
==Creating the Credentials File==
 +
For more information about the credentials file, see [[About FACT Configuration Files#About Credentials Files|About Credentials Files.]]
 +
To create a credentials file, perform the following steps:
-
$
+
'''Step 1''' Using a text editor, create a file named .fact-credentials in your home directory.
-
:'''fact> show chassis'''
+
-
[find output to place here]
+
-
:'''fact> show subnet-managers'''
+
'''Step 2''' For each managed node (switch or host) that you listed in the master configuration file, add a username and a password that FACT can use to log in to that managed node. Choose Case 1 or Case 2 from the following steps:
-
[find output to place here]
+
-
:'''fact> show ports myswitchA'''
+
::'''Case 1'''--If each switch or host in your network has a different username or password, create a separate stanza in the credentials file for each switch and each host, as shown in the following example:
-
[find output to place here]
+
:::SFSOS switch ''name''
 +
::::user: ''username''
 +
::::password: ''password''
-
:'''fact> show subnet-managers
+
:::OEM switch ''name''
-
[find output to place here]
+
::::host myhost[1-8]
 +
::::user: ''username''
 +
::::password: ''password''
-
:'''fact> exit
+
:::host ''name''
-
$
+
::::user: ''username''
 +
::::password: ''password''
-
==Annotating a Log File==
+
::'''Case 2'''--If all managed nodes of a given type (host, SFS OS switch, or OEM switch) have the same username and password, create one stanza for each node type, as shown in the following examples:
-
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:
+
:::SFSOS switch *
 +
::::user: ''username''
 +
::::password: ''password''
-
:'''$fact annotate pass-though mysubnetmanagerlog.text
+
:::OEM switch *
-
[add output here]
+
::::user: ''username''
-
$
+
::::password: ''password''
-
==Viewing a History Scan==
+
:::host *
 +
::::user: ''username''
 +
::::password: ''password''
-
FACT retains all scans, which you can view by using the '''show history''' command, as shown in the following example:
+
'''Step 3''' Save the credentials file that you just created.
-
:$ '''fact'''
+
'''Step 4''' Verify the configuration by entering the '''fact scan fabric''' command, which scans the managed nodes in the master configuration file.
-
:'''fact> show history'''
+
-
[add output here]
+
 +
'''Step 5''' If FACT reports errors while scanning, see [[FACT Quick Start Guide#Troubleshooting FACT Configuration|Troubleshooting FACT Configuration]].
-
==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.
+
 
 +
=Troubleshooting FACT Configuration=
 +
 
 +
 
 +
If FACT reports errors while scanning, consult this section for common symptoms, possible causes, and recommended actions.
 +
 
 +
 
 +
 
 +
'''Symptom''': FACT returns an error message indicating that permission is denied: <code>"name: permission denied."</code>
 +
 
 +
:'''Possible cause''': The credentials file is either missing or incorrect.
 +
 
 +
:'''Recommended action''': Correct the credentials file. (See [[Creating FACT Configuration Files#Creating the Credentials File|Creating the Credentials File]].)
 +
 
 +
 
 +
 
 +
'''Symptom''': FACT returns a time-out message: <code>"ScanError: timeout scanning name."</code>
 +
 
 +
:'''Possible cause''': The master configuration file has an incorrect host name or IP address, or the host is not reachable using the name that appears in the file.
 +
 
 +
:'''Recommended action''': Verify that you have entered the correct host name or IP address in the master configuration file. (See [[Creating FACT Configuration Files#Creating the Master Configuration File|Creating the Master Configuration File]].) Also, verify that the managed node is reachable through SSH.
 +
 
 +
 
 +
 
 +
'''Symptom''': When you attempt to scan the network, FACT returns a message saying that multiple master Subnet Managers are found: <code>"ScanError: multiple Master Subnet Managers found."</code>
 +
 
 +
:'''Possible cause''': The master configuration file contains managed nodes from multiple subnets. FACT can scan a single subnet only.
 +
 
 +
:'''Recommended action''': Enter the FACT '''show subnet-managers''' command to see all of the master and standby Subnet Managers that FACT found. From the master configuration file and from the credentials file, remove the Subnet Managers that are not in the subnet that you are scanning.
 +
 
 +
 
 +
 
 +
'''Symptom''': FACT cannot find a master Subnet Manager: <code>"ScanError: no Master Subnet Manager found."</code>
 +
 
 +
:'''Possible cause''': The node that is running the master Subnet Manager is not in the master configuration file. (See [[Creating FACT Configuration Files#Creating the Master Configuration File|Creating the Master Configuration File]].)
 +
 
 +
:'''Recommended action''': Check the master configuration file, and add the node that is running the master Subnet Manager if it does not exist in the file.

Latest revision as of 18:22, 12 June 2008

This section includes the minimal tasks involved in installing and configuring FACT. For details about these installation and configuration tasks, see Obtaining and Installing FACT and Creating FACT Configuration Files.

Contents

Obtaining and Installing FACT Software

Before you obtain and install FACT, ensure that you are running the following software on your system: RedHat Enterprise Linux, Version 4 or 5, or SUSE Linux Enterprise Distribution, Version 9 or 10, and Python, Version 2.3 or later.


Obtaining FACT Software

FACT is distributed as an RPM file. To obtain a copy of the FACT RPM, perform the following steps:

Step 1 Navigate to the Cisco software download site at the following URL: http://www.cisco.com/kobayashi/sw-center/index.shtml

If you are not already a registered user, you must register at the above URL to gain access to software downloads.

Step 2 Select the software product category by clicking the Server Network and Virtualization link.

Step 3 Select a device by choosing Server Fabric Software > InfiniBand Management Software > Cisco Fabric Analysis and Correlation Toolkit.

Installing FACT Software

To install the FACT software RPM, perform the following steps:

Step 1 Log in to your console as a super user.

Step 2 Install the RPM by entering the following command:

rpm -i cisco-fact- version .noarch.rpm

Step 3 FACT installs the software without status messages. To verify that you have installed the correct version of FACT, enter the fact -v command, and verify the version number in the command output.

Configuring FACT Software

To configure FACT software you must create the master configuration file and create the credentials file.


Creating the Master Configuration File

For more information about master configuration files, see About Master Configuration Files. To create the master configuration file, perform the following steps:

Step 1 Log in to your host as a super user.

Step 2 Using a text editor, create a master configuration file names .fact.conf in your home directory.

Step 3 Enter the following line into the configuration file:

credential-file: ~/.fact-credentials

Step 4 For each managed switch that is running SFS OS in your network, add a line to the master configuration file that specifies the hostname or IP address:

managed-nodes: SFSOS switch name
For information about managed nodes, see About Managed Node Definitions Files.

Step 5 For each managed OEM switch that is in your network (either a Cisco SFS 7012 or Cisco SFS 7024), add a line to the file that specifies the hostname or IP address:

managed-nodes: OEM switch name

Step 6 If you are using the High-Performance Subnet Manager, specify each host that runs the High-Performance Subnet Manager in the master configuration file:

managed-nodes: host name

Step 7 (Optional) FACT usually determines the names of hosts on the network without needing to log in to them. If FACT does not identify the hosts or if you want FACT to collect additional diagnostic information from the hosts, add each host in your network to the master configuration file:

managed-nodes: host name

Step 8 (Optional) If you have unmanaged switches in your network, add a line to the master configuration file that specifies the GUID name and creates a name for the switch. (For more information about GUID names, see About GUID Name Definitions.) You may use any name for the switch, but you must use the following format for the line that you add to the file:

guid-name: 00:1b:0d:00:00:ca:a6 switchA
guid-name: 00:1b:0d:00:00:ca:aa switchB


Creating the Credentials File

For more information about the credentials file, see About Credentials Files. To create a credentials file, perform the following steps:

Step 1 Using a text editor, create a file named .fact-credentials in your home directory.

Step 2 For each managed node (switch or host) that you listed in the master configuration file, add a username and a password that FACT can use to log in to that managed node. Choose Case 1 or Case 2 from the following steps:

Case 1--If each switch or host in your network has a different username or password, create a separate stanza in the credentials file for each switch and each host, as shown in the following example:
SFSOS switch name
user: username
password: password
OEM switch name
host myhost[1-8]
user: username
password: password
host name
user: username
password: password


Case 2--If all managed nodes of a given type (host, SFS OS switch, or OEM switch) have the same username and password, create one stanza for each node type, as shown in the following examples:
SFSOS switch *
user: username
password: password
OEM switch *
user: username
password: password
host *
user: username
password: password

Step 3 Save the credentials file that you just created.

Step 4 Verify the configuration by entering the fact scan fabric command, which scans the managed nodes in the master configuration file.

Step 5 If FACT reports errors while scanning, see Troubleshooting FACT Configuration.


Troubleshooting FACT Configuration

If FACT reports errors while scanning, consult this section for common symptoms, possible causes, and recommended actions.


Symptom: FACT returns an error message indicating that permission is denied: "name: permission denied."

Possible cause: The credentials file is either missing or incorrect.
Recommended action: Correct the credentials file. (See Creating the Credentials File.)


Symptom: FACT returns a time-out message: "ScanError: timeout scanning name."

Possible cause: The master configuration file has an incorrect host name or IP address, or the host is not reachable using the name that appears in the file.
Recommended action: Verify that you have entered the correct host name or IP address in the master configuration file. (See Creating the Master Configuration File.) Also, verify that the managed node is reachable through SSH.


Symptom: When you attempt to scan the network, FACT returns a message saying that multiple master Subnet Managers are found: "ScanError: multiple Master Subnet Managers found."

Possible cause: The master configuration file contains managed nodes from multiple subnets. FACT can scan a single subnet only.
Recommended action: Enter the FACT show subnet-managers command to see all of the master and standby Subnet Managers that FACT found. From the master configuration file and from the credentials file, remove the Subnet Managers that are not in the subnet that you are scanning.


Symptom: FACT cannot find a master Subnet Manager: "ScanError: no Master Subnet Manager found."

Possible cause: The node that is running the master Subnet Manager is not in the master configuration file. (See Creating the Master Configuration File.)
Recommended action: Check the master configuration file, and add the node that is running the master Subnet Manager if it does not exist in the file.

Rating: 0.0/5 (0 votes cast)

Personal tools