	INSTALL_sneep.txt  08/16/05 06:57:46

Installation instructions for "sneep" : Serial Number in EEProm .
Sneep provides persistent storage of the Chassis Serial Number on
virtually all Sun platforms.

As some platforms like the Sun SF12000/SF15000, natively support 
software access to the Chassis Serial Number (CSN) on the 
System Controller via SMS commands "setcsn" and "showplatform",
it is not strictly necessary to install sneep on the System Controllers.
	[ setcsn/showplatform became available in 
	  System Management Services 1.4 (SMS1.4) ]

However, sneep is desirable on those platforms for administrative consistency,
and in order to take advantage of sneep's explorer and CST integration,
and its ability to store user-defined data.





1)	Obtain sneep.
	Public Sites:
		Sun Download Center	http://www.sun.com/download
			Category -> Systems Administration / Systems Management
			or
			Downloads A-Z  -> S -> Sneep
			or
			http://javashoplm.sun.com/ECom/docs/Welcome.jsp?StoreId=8&PartDetailId=SNEEP-2.5-SOL-F&TransactionId=try

		Big Admin:		http://www.bigadmin.com (soon)
		Sun Parter Exchange:	https://spe.sun.com 	(soon)

	Sun internal Sites:
		http://webhome.east/mshon/solutions/sneep
		( moved from
			 http://webhome.central/fca-eng/solutions/sneep )

	Download the most recent version of sneep .
	Release X Revision Y will download as  "SUNWsneepX_RY.tar.Z" 

	The compressed, downloaded file will be referred to as $DOWNLOAD.
	For the purposes of this example installation, we will assume 

		#	The name of the downloaded, compressed package
		DOWNLOAD=/tmp/SUNWsneepX_RY.tar.Z

	The file contains the SUNWsneep package with all programs
	and documentation, including this file.

	The default installation directory is /opt/SUNWsneep,
	so the path to the sneep executable is 
		/opt/SUNWsneep/bin/sneep


2)	Extract the files.

		$ cd <directory of $DOWNLOAD file>	# e.g.   cd /tmp
		$ zcat $DOWNLOAD | tar xvpf -

3)	Install the sneep package.
		The installation can be non-interactive.
	
		#	first, uninstall any previous versions
		#	Any sneep data remains intact.
		$ pkgrm -n SUNWsneep


		#	install the new version
		$ cd <directory of $DOWNLOAD file>	# e.g.   cd /tmp
		$ pkgadd -n -d . SUNWsneep

	If you have configured Solaris Zones on your system, you may see 
	some extra output from pkgadd/pkgrm regarding starting the zones
	and adding or removing sneep in the zones.

	Sneep will not have to be installed into the zones individually,
	but it will have to be configured in each zone, because they
	do not share any data.


4)	Install optional explorer plug-in for sneep

	"explorer" is a Sun Service tool for collecting static
	configuration information from your system.  It is available as
	a download from sunsolve.sun.com . Sun recommends that explorer
	should be installed on every customer machine and run regularly,
	and that if possible, the results should be transmitted to
	Sun.

	The explorer data can be used for problem analysis, recovery of
	configuration data, and is used by Sun analysis tools to find
	configuration problems, recommend patch sets, identify hosts
	which are affected by Field Change Orders, etc. .  The system
	serial number is a very important piece of this information.

	Explorer will be updated shortly to collect the serial number
	using sneep.  Until that work is completed, sneep includes a
	script which installs a plugin into explorer for this purpose.

		$ /opt/SUNWsneep/bin/install_explorer_plugin

	Any time that explorer is re-installed or updated, the plugin
	must be reinstalled using the command provided. This will not
	be necessary after explorer includes sneep support natively.


5)	Optionally add sneep to the default "bin" directory

	Sneep is installed in /opt/SUNWsneep/bin .
	As it may be used very infrequently, it may be relatively 
	difficult to remember where it is when you need it.

	To make it easier to find, the package includes a program which
	makes a link to sneep in /usr/sbin (or a directory which you
	specify), where it is more likely to appear on a user's default
	search path.  This program also registers the link as part of
	sneep so that it is removed if the sneep package is removed.

		$ which sneep
		no sneep in /usr/sbin /usr/bin /usr/ccs/bin
		$
		$ /opt/SUNWsneep/bin/add_sneep_to_bin
		$
		$ which sneep
		/usr/sbin/sneep


6)      Optionally review the manual page for sneep

		man -M /opt/SUNWsneep/man sneep

	For more information, see the User Guide and other documents
	in the documentation directory

		/opt/SUNWsneep/Docs



7)      Manage Chassis Serial Number and other data using sneep.

	At this point, sneep can be used to manage your chassis serial number.
	For much more information on usage, see the User Guide and the
	manual page found in the package.

		/opt/SUNWsneep/bin/sneep -s serial_number
		/opt/SUNWsneep/bin/sneep

	If you performed step 4, and if /usr/sbin is in your search path
	(as it is usually in the path for the "root" user),
	you may be able to access sneep without specifying the path.

		sneep -s serial_number
		sneep -a

	"setcsn" and "showplatform" are links to the "sneep" executable
	which provide an alternate interface emulating the one introduced in
	System Management Services 1.4

		/opt/SUNWsneep/bin/setcsn -c serial_number
		/opt/SUNWsneep/bin/showplatform -p csn
		



Removal of "sneep"

	Note that when sneep is removed from the system, it is
	generally preferable to leave the data intact.  It will be
	included in any explorer output from the system, and will be
	available from OBP and Solaris in the EEPROM nvramrc variable.

	Optionally remove the serial number and other sneep settings.
	This is NOT normally recommended.

		If the only sneep data is the Chassis Serial Number, 
		remove it by setting it to the null value.

		$ /opt/SUNWsneep/bin/sneep -s ""
		$

		If there are multiple sneep tags, it may be simpler to
		let sneep tell you what to do to remove all of them.
		The combination of options -T -v and -e will output
		commands to erase all sneep tags. Piping these commands
		to a shell will result in their removal.

		$ /opt/SUNWsneep/bin/sneep -veT 
		/opt/SUNWsneep/bin/sneep -t "ChassisSerialNumber"   -s ""
		/opt/SUNWsneep/bin/sneep -t "ASSET_ID"   -s ""
		/opt/SUNWsneep/bin/sneep -t "StorageC3Serial"   -s ""
		$
		$ /opt/SUNWsneep/bin/sneep -veT | sh
		$ /opt/SUNWsneep/bin/sneep
		$
		
	
	# Remove the SUNWsneep package; no interaction necessary
	# pkgrm -n SUNWsneep

For detailed information on sneep usage, see the manual page and the
User Guide included in the "Docs" directory of the SUNWsneep package.

