FACT Configuration - Revision history

Lorlando at 19:51, 9 April 2008

2008-04-09T19:51:14Z

← Older revision		Revision as of 19:51, 9 April 2008
Line 1:		Line 1:
-	FACT uses four types of configuration files that you must create before you can use the FACT software. These configuration files provide information about the network that you want FACT to analyze. You create these files after you install the FACT RPM (see [[Installing FACT Software]]) and before you use FACT. After familiarizing yourself with the fact configuration file types in [[About FACT Configuration Files]], proceed to [[Creating FACT Configuration Files]].	+	FACT uses four types of configuration files that you must create before you can use the FACT software. These configuration files provide information about the network that you want FACT to analyze. You create these files after you install the FACT RPM (see [[Obtaining and Installing FACT#Installing FACT Software\|Installing FACT Software]]) and before you use FACT. After familiarizing yourself with the fact configuration file types in [[About FACT Configuration Files]], proceed to [[Creating FACT Configuration Files]].

	'''Note''': FACT can operate with no configuration; however, the application is minimally useful in an unconfigured state.		'''Note''': FACT can operate with no configuration; however, the application is minimally useful in an unconfigured state.

Lorlando at 19:27, 3 April 2008

2008-04-03T19:27:45Z

← Older revision		Revision as of 19:27, 3 April 2008
Line 1:		Line 1:
	FACT uses four types of configuration files that you must create before you can use the FACT software. These configuration files provide information about the network that you want FACT to analyze. You create these files after you install the FACT RPM (see [[Installing FACT Software]]) and before you use FACT. After familiarizing yourself with the fact configuration file types in [[About FACT Configuration Files]], proceed to [[Creating FACT Configuration Files]].		FACT uses four types of configuration files that you must create before you can use the FACT software. These configuration files provide information about the network that you want FACT to analyze. You create these files after you install the FACT RPM (see [[Installing FACT Software]]) and before you use FACT. After familiarizing yourself with the fact configuration file types in [[About FACT Configuration Files]], proceed to [[Creating FACT Configuration Files]].
		+
		+	'''Note''': FACT can operate with no configuration; however, the application is minimally useful in an unconfigured state.

	*[[About FACT Configuration Files]]		*[[About FACT Configuration Files]]

	*[[Creating FACT Configuration Files]]		*[[Creating FACT Configuration Files]]

Lorlando at 19:24, 3 April 2008

2008-04-03T19:24:46Z

← Older revision		Revision as of 19:24, 3 April 2008
Line 1:		Line 1:
-	~~==Configuring~~ FACT Files==	+	FACT uses four types of configuration files that you must create before you can use the FACT software. These configuration files provide information about the network that you want FACT to analyze. You create these files after you install the FACT RPM (see [[Installing FACT Software]]) and before you use FACT. After familiarizing yourself with the fact configuration file types in [[About FACT Configuration Files]], proceed to [[Creating FACT Configuration Files]].

-	FACT ~~has four types of configuration files:~~	+	*[[About FACT Configuration Files]]
-	*.fact.conf files	+
-	*managed-nodes files	+
-	*credential files	+
-	*guid-names files	+

-	~~===Configuring .fact.conf Files===~~	+	*[[Creating FACT Configuration Files]]
-		+
-	~~The .fact.conf file is the primary configuration file. It gives the locations of the other files, and it also contains other configuration information.~~	+
-		+
-	~~Each line of the .fact.conf file is a parameter that follows the format of ''name:value''. The following parameters are available:~~	+
-	*~~repository: ''directory''~~	+
-	*credential-file: ''file''	+
-	*managed nodes: ''type hostname-list''	+
-	*managed-node-file: ''file''	+
-	*guid-name: ''guid name''	+
-	*guid-names-file: ''file''	+
-	*log-file ''file''	+
-	*subnet-manager: ''hostname''	+
-		+
-	~~===Configuring Managed Nodes Files===~~	+
-		+
-	A managed node is a machine that FACT logs into when it scans the network. Managed nodes have three types: host, SFS OS switch, and OEM switch. An OEM switch is a Cisco SFS 7012 or a Cisco SFS 7024. An SFS OS switch is any other Cisco InfiniBand switch. Managed nodes can be given directly in .fact.conf using the "managed nodes" directive or in a separate file. A separate managed nodes file has a type and a list on each line. The list expands to a set of hostnames, as shown in the following example:	+
-		+
-	~~:SFSOS switch rack~~[~~A,C]leaf~~[~~1-3~~]	+
-	~~:host rack[B,C~~]~~compute[01-32]~~	+
-		+
-	This file expands to six switch names, rackAleaf1 through rackAleaf3 and rackCleaf1 through rackCleaf3. It also expands to 64 host names: rackBcompute01 through rackDcompute32. If your managed nodes follow this type of a simple name scheme, you may place them into a .fact.conf file, as shown in the following example with managed-node parameters in .fact.conf:	+
-		+
-	~~:managed-nodes: SFSOS switch rack[A,C]leaf[1-3]~~	+
-	~~:managed-nodes: host rack[B,D]compute[01-32]~~	+
-		+
-	~~===Configuring Credentials===~~	+
-		+
-	FACT must know the username and password to use for each managed node that in logs into. The credentials file provides this information. A credentials file is organized into stanzas. Each stanza starts with a managed node type and a pattern that matches hostnames. The remaining lines are ''name: value'' pairs. The most important names are ''user:'' and ''password''.	+
-		+
-	~~The credentials file contains the following legal parameters:~~	+
-	*method: (ssh or direct)	+
-	*port: ''TCP-port-number''	+
-	*username: ''username''	+
-	*password: ''password''	+
-	*HSM-command: '''path'''	+
-	*vstat-command: '''path'''	+
-		+
-	~~The ssh method uses secure shell (ssh) to connect to the managed node. The direct method is only used to scan the host upon which FACT is running.~~	+
-		+
-	~~If your HSM command is not installed at one of the following locations, then place the full path into the HSM-command parameter:~~	+
-	*/usr/local/topspin/sbin/ib_sm_cli	+
-	*/usr/sbin/ib_sm_cli	+
-		+
-	~~Similarly, use the vstat-command if vstat is not in /usr/local/topspin/bin/vstat.~~	+
-	~~Note: vstat is part of the Cisco host driver stack. If you are using OFED host drivers, you can safely ignore vstat.~~	+
-		+
-	~~The following example shows how to enter a credentials file:~~	+
-		+
-	~~:host rack '''host'''~~	+
-	~~::username: ''username''~~	+
-	~~::password: ''password''~~	+
-		+
-	~~:SFS OS switch rack '''switch'''~~	+
-	~~::username: '''super'''~~	+
-	~~::password: '''super'''~~	+
-		+
-	~~===Configuring GUID Names===~~	+
-		+
-	You can assign an arbitrary name to any GUID. FACT uses that name when showing information, so you can use either the assigned name or the actual GUID to refer to the object. Assigned GUID names are most useful for unmanaged switches. Without an assigned GUID name, FACT displays an unmanaged switch by its node GUID.	+
-		+
-	If you do not want FACT to log in to each host in your cluster, and if FACT cannot determine the host names from the Subnet Manager, you can use GUID names to help FACT display useful names for your hosts.	+
-		+
-	~~Also, you can attach a name to a system image GUID, a chassis GUID, or a port GUID.~~	+
-		+
-	~~GUID names are entirely optional. You do not need to use them.~~	+
-		+
-	~~The GUID name format contains the GUID name on one line, separated by white space, as shown in the following example:~~	+
-		+
-	~~:00:05:ad:00:00:12:34 myunmanagedA~~	+
-	~~:00:05:ad:00:00:56:78 myunmanagedB~~	+

Fenton: FACT Configuration (SVBU) moved to FACT Configuration: Remove BU reference from title

2008-04-01T23:14:04Z

FACT Configuration (SVBU) moved to FACT Configuration: Remove BU reference from title

← Older revision

Revision as of 23:14, 1 April 2008

Lorlando at 22:00, 5 February 2008

2008-02-05T22:00:27Z

← Older revision

Revision as of 22:00, 5 February 2008

Lorlando at 22:00, 5 February 2008

2008-02-05T22:00:27Z

New page

==Configuring FACT Files==

FACT has four types of configuration files:
*.fact.conf files
*managed-nodes files
*credential files
*guid-names files

===Configuring .fact.conf Files===

The .fact.conf file is the primary configuration file. It gives the locations of the other files, and it also contains other configuration information.

Each line of the .fact.conf file is a parameter that follows the format of ''name:value''. The following parameters are available:
*repository: ''directory''
*credential-file: ''file''
*managed nodes: ''type hostname-list''
*managed-node-file: ''file''
*guid-name: ''guid name''
*guid-names-file: ''file''
*log-file ''file''
*subnet-manager: ''hostname''

===Configuring Managed Nodes Files===

A managed node is a machine that FACT logs into when it scans the network. Managed nodes have three types: host, SFS OS switch, and OEM switch. An OEM switch is a Cisco SFS 7012 or a Cisco SFS 7024. An SFS OS switch is any other Cisco InfiniBand switch. Managed nodes can be given directly in .fact.conf using the "managed nodes" directive or in a separate file. A separate managed nodes file has a type and a list on each line. The list expands to a set of hostnames, as shown in the following example:

:SFSOS switch rack[A,C]leaf[1-3]
:host rack[B,C]compute[01-32]

This file expands to six switch names, rackAleaf1 through rackAleaf3 and rackCleaf1 through rackCleaf3. It also expands to 64 host names: rackBcompute01 through rackDcompute32. If your managed nodes follow this type of a simple name scheme, you may place them into a .fact.conf file, as shown in the following example with managed-node parameters in .fact.conf:

:managed-nodes: SFSOS switch rack[A,C]leaf[1-3]
:managed-nodes: host rack[B,D]compute[01-32]

===Configuring Credentials===

FACT must know the username and password to use for each managed node that in logs into. The credentials file provides this information. A credentials file is organized into stanzas. Each stanza starts with a managed node type and a pattern that matches hostnames. The remaining lines are ''name: value'' pairs. The most important names are ''user:'' and ''password''.

The credentials file contains the following legal parameters:
*method: (ssh or direct)
*port: ''TCP-port-number''
*username: ''username''
*password: ''password''
*HSM-command: '''path'''
*vstat-command: '''path'''

The ssh method uses secure shell (ssh) to connect to the managed node. The direct method is only used to scan the host upon which FACT is running.

If your HSM command is not installed at one of the following locations, then place the full path into the HSM-command parameter:
*/usr/local/topspin/sbin/ib_sm_cli
*/usr/sbin/ib_sm_cli

Similarly, use the vstat-command if vstat is not in /usr/local/topspin/bin/vstat.
Note: vstat is part of the Cisco host driver stack. If you are using OFED host drivers, you can safely ignore vstat.

The following example shows how to enter a credentials file:

:host rack '''host'''
::username: ''username''
::password: ''password''

:SFS OS switch rack '''switch'''
::username: '''super'''
::password: '''super'''

===Configuring GUID Names===

You can assign an arbitrary name to any GUID. FACT uses that name when showing information, so you can use either the assigned name or the actual GUID to refer to the object. Assigned GUID names are most useful for unmanaged switches. Without an assigned GUID name, FACT displays an unmanaged switch by its node GUID.

If you do not want FACT to log in to each host in your cluster, and if FACT cannot determine the host names from the Subnet Manager, you can use GUID names to help FACT display useful names for your hosts.

Also, you can attach a name to a system image GUID, a chassis GUID, or a port GUID.

GUID names are entirely optional. You do not need to use them.

The GUID name format contains the GUID name on one line, separated by white space, as shown in the following example:

:00:05:ad:00:00:12:34 myunmanagedA
:00:05:ad:00:00:56:78 myunmanagedB