SSM Users Guide
SSM Users Guide
SSM Users Guide
Guide
October 2005
This guide provides a functional overview of System Software Manager and a comprehensive
guide to its installation, configuration, and implementation.
© Copyright 2002-2005 Hewlett-Packard Development Company, L.P.
The information contained herein is subject to change without notice.
Microsoft, MS-DOS, Windows, and Windows NT are trademarks of Microsoft Corporation in the U.S. and other
countries. Intel is a trademark or registered trademark of Intel Corporation or its subsidiaries in the United States
and other countries.
The only warranties for HP products and services are set forth in the express warranty statements accompanying
such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall
not be liable for technical or editorial errors or omissions contained herein.
This document contains proprietary information that is protected by copyright. No part of this document may be
photocopied, reproduced, or translated to another language without the prior written consent of Hewlett-Packard
Company.
Å WARNING: Text set off in this manner indicates that failure to follow directions could result in bodily
harm or loss of life.
Ä CAUTION: Text set off in this manner indicates that failure to follow directions could result in damage to
equipment or loss of information.
This guide provides a functional overview of System Software Manager and a comprehensive
guide to its installation, configuration, and implementation.
Text Conventions
This document uses the following conventions to distinguish elements of text:
1 Getting Started
What is System Software Manager? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1
System Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2
Installing and Running SSM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2
Components of SSM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3
SSM.EXE - Installer Stub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3
SSM.CAB - Support Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3
SSM.BIN - Settings file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3
SSMCVA.MDB - Update Information Database (UID) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3
SSM Log file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3
SSM TRACE file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4
Features of SSM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4
Device Driver Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4
System ROM BIOS Flash Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4
BIOS Settings and Replicated Setup (/REPSET) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4
Customized Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4
2 Modes of Operation
Administrative Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–1
Update Information Database (UID) Performance Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . 2–3
Update Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–3
Displays Cancel Option for Low bandwidth Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–3
Reads Settings from SSM.BIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–3
Creates or Copies the Update Information Database (SSMCVA.MDB) . . . . . . . . . . . . . . . . . . 2–3
Queries the Update Information Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–4
Performs Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–4
Performs Replicated Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–4
Updates Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–4
3 Package Deployment
Can I Use SSM to Deploy Customized Software Updates? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–1
What is a CVA File? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–1
Additional Requirements for Software Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–1
Post-Operating System Silent Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–1
Detectable Deliverable Version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–1
Controlled Reboot of System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–2
Installation Recovery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–2
Installation Mechanism Must Support Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–2
Customized Packages Must Reside in a Unique Subfolder of the File store . . . . . . . . . . . . . . . 3–2
4 BIOS Configuration
Replicated Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–1
Helpful Hints: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–2
BIOS Configuration Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–3
A File Store
File Store Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–1
Adding Custom Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–1
File store examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A–1
E Error Codes
Locating Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E–1
Administrative Mode Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E–1
Update Mode Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E–1
CVA Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E–4
F Troubleshooting
System Requirements
System Requirements
Server Client
✎ Ifenvironment,
you have deployed HP Client Management Interface Software Provider (HPCMISP) in your
please update to the latest version prior to using SSM. There is an intermittent
BIOS setting modification interaction issue with HPCMISP version 1.00 Rev A and SSM.
✎ Tosuchhelpas \\MyServer\SSMFS\Video\Intel
organize the file store, create subfolders with meaningful names to hold each SoftPaq,
Extreme 2\sp27392.exe
5. Place all SSM-supported SoftPaq files in the file store created in step 3. Each customized
package must be located in separate subdirectories. Refer to Chapter 3, “Package
Deployment” for more information about Custom Packages.
6. On each client computer, run SSM in Update Mode by specifying the UNC path to the
filestore on the command line:
\\MyServer\SSMFS\SSM.exe \\MyServer\SSMFS /Accept /Report
This step updates the system software (BIOS and drivers) on the client according to the
contents of the filestore.
7. A log file of actions performed may be viewed in the user’s TEMP directory. A quick method
to view the log file on the client system is to click Start > Run then enter
%temp%\%computername%.htm.
8. Review the log file to view the list of software applicable to the system, updates performed,
and any errors. If no errors are found, the log file will not include an Error section. Refer to
Appendix C, “Log File Description” for more information.
Components of SSM
This section covers the various SSM modules and their functions. There are two modes of
operation: “Administrative Mode” and “Update Mode.” Refer to Chapter 2, “Modes of
Operation” to determine which mode is most appropriate for your purposes.
Features of SSM
Device Driver Updates
When searching for updates, SSM detects the current installed hardware configuration and
selects only the appropriate drivers for installation. The file store may contain multiple video,
NIC, and audio drivers, but SSM will install only the updates that are appropriate.
Customized Packages
If a particular SoftPaq does not contain the exact information or configuration information that is
desired, a customized package may be created. Create a subdirectory containing the customized
packages and package description file (.CVA). If the target system is out of date, SSM will copy
the files from the file store to a temporary directory on the local system and install the
customized package. Refer to Chapter 3, “Package Deployment” for more information.
Administrative Mode
Use Administrative Mode to configure options that will be used to simultaneously update
multiple networked client computers. Administrative Mode lets you
■ Set specific runtime options for the utility when updating client computers
■ Create a read-only network share for the file store
■ Create a centralized read-write network share in which to store log files
■ Encrypt setup password in a configuration file
■ Build the Update Information Database on the server (If a UID is present, it must be rebuilt
each time a SoftPaq is added or removed from the file store.)
To run Administrative Mode complete the following steps:
1. Create a directory to be used as a file store (e.g., c:\\SSMFS). This is where the updates will
be stored and accessed by client computers. SSM will share this directory with read access to
everyone.
2. Copy SSM.EXE and SSM.CAB to the root of the file store.
3. Place all SoftPaqs or customized packages in the file store.
4. Double-click SSM.EXE to launch SSM in Administrative Mode.
5. Read the license agreement and click Next to proceed. A Welcome dialog displays a brief
introduction to the steps required to configure SSM using Administrative Mode.
6. Click Next. The location of the file store and default share name will be displayed.
Optionally you can specify a different file store and share name.
7. Click Next. A dialog is displayed to remind you to copy all SoftPaqs to the file store before
proceeding.
8. Click Next. The Additional Client Options dialog is displayed.
9. Click the check box next to each client option you want to specify:
❏ Reboot client upon completion of upgrades
After applying updates, reboot client computer so that updates will take effect.
❏ Display update status bar on client system
Display a status bar on client system so that individual users can see progress and
completion of updates.
❏ Create centralized log file share
Create a log file for each client on a centralized share. If checked, you will be prompted
to enter the folder and share name for the centralized log files.
❏ Force to update clients systems
Apply "updates" to client system, regardless of whether the client system has a newer
version of the software already installed.
10. Click Next. (If you have opted to create a centralized log file share, you will be prompted to
enter the folder and share name for the centralized log files. Click Next.)
11. Click Next. (If you want to use a setup password for all client systems, click the check box
and click Next. A warning is displayed. Click OK. You will be prompted to enter a setup
password. Setup passwords are used only for system ROM BIOS updates and system BIOS
setting updates.)
✎ Ifcomputer,
you specify a setup password, it must match any setup password already set on the client
and all client computers must use the same setup password. It is a good idea to record
the password in a safe place for future reference. Additional passwords may be specified on the
SSM command line. SSM will determine which password is the correct one to use.
✎ If/NOCVAUPDATE
you modify CVA files in the file store, either write-protect the CVA file or use the
option to prevent overwriting the modified CVA file.
14. Click Build Database to begin building the software update database.
15. Click Finish to complete the process. SSM creates the SSM.BIN file.
You must rebuild the database each time you add or remove a SoftPaq from the file store.
Administrator Mode lets you rebuild the database manually. Refer to “Update Information
Database (UID) Performance Considerations” for more information. The software update
database can be rebuilt quickly by executing the following from the command line:
SSM /AM_BLD_DB
Update Mode
Update Mode updates the client system from the file store. It is invoked by specifying the file
store location as a command line parameter. Refer to Appendix B, “Command Line Parameters”
for detailed information on command line parameters. This section describes what happens
during Update Mode.
If the database is found, SSM will copy it locally and use it. If the database is not found, SSM
will build a temporary database. SSM scans the file store for EXE files and CVA files. For any
EXE files that do not have a corresponding CVA file, SSM will then attempt to extract a CVA
file. If the file store is across the network then this causes additional network traffic. Once all the
CVA files have been extracted, SSM creates a temporary database from the CVA files. After the
update process is complete, the temporary database is deleted.
Performs Updates
SSM then compares the revision level of the possible updates to the existing software. Only those
update packages that are newer than what is currently installed will be updated on the client
system unless the /FORCE option is used. SSM executes the packages in the order in which they
appear in the database. Multiple file stores may be used to install packages in a particular order.
Installation Recovery
Any installation mechanism provided must be able to gracefully recover from a failed installation
(such as not enough disk space, etc.), by exiting without requiring user interaction. The ability to
log errors is recommended.
4
BIOS Configuration
The BIOS configuration feature of SSM lets you create standard configuration settings and
deploy them across the enterprise. By creating a configuration text file with only the setting you
want to change, you can deploy it to all systems in the enterprise. If a particular system does not
support the specified setting, it will be ignored.
BIOS configuration is supported on most high end commercial HP desktops, notebooks, and
workstations. There are a few notable exceptions that do not support BIOS configuration
including dx5150, xw5000, xw8000, D510 e-PC, TC1000, and TC1100. See the HP Product
Compatibility link on www.hp.com/go/ssm for detailed level of support for each system.
Replicated Setup
To create, save, and deploy the configuration settings, complete the following instructions:
1. Run the program BIOSConfigUtility.exe provided in the SSM download package, using the
/GETCONFIG:CONFIG.TXT command line paramter.
2. Copy the file, CONFIG.TXT to the SSM file store.
3. Edit the file CONFIG.TXT. Remove properties that you do not want to change. Modify the
other properties.
Helpful Hints:
■ This /REPSET functionality is supported on select commercial desktop, workstation, and
notebook systems. Supported settings vary by model.
■ The first line must be English
■ The settings are indented with a tab character. Indenting with space characters will not work.
■ There is no space between /REPSET: and the filename.
■ The exact strings for some boot devices may vary between models. For example, the network
controller for Boot Order was identified with the tag PNP Device #1 on 1998 model Deskpro
EN systems and Network Controller on newer systems. If your environment includes a mix
of systems, then ensure that all known values for a particular boot device are placed together
in the list relative to the next type of boot device. See example above. Note that CD-ROM is
specified several different ways.
■ Asset Tag and Ownership Tag cannot be set to blank strings.
5
Using SSM with Commercial Software
Distribution Systems
HP Client Manager
There are several common methods used to integrate SSM into commercial software distribution
systems. The first and easiest is to use HP Client Manager (HPCM) by Altiris. This free platform
management solution has fully integrated SSM directly into the product. For a free download,
visit www.hp.com/go/EasyDeploy.
HPCM is a scalable solution that provides the ability to schedule delivery of SoftPaqs to
applicable systems throughout the enterprise with an easy to use interface. Low bandwidth
connections and seldom connected systems are supported with bandwidth throttling and check
point restarting.
/Drivers
SPxxx5.exe
SPxxx6.exe
Update Mode
SSM <file store UNC path> /parameters
SSM executes in Update Mode when it is launched with the file store path as a parameter and
/AM_BLD_DB is not specified.
/LOG: <path> U Specifies a UNC path location of the client log file. The
command line parameter overrides UNC path specified
in Administrative Mode. The filename will be appended
automatically, based on the computer name.
/NEWSETUPPASSWORD:”pwd” U Specifies the new setup password. This will modify any
or /NSPWD:”pwd” existing passwords. If a password is on the system, the
correct password must be provided by using the
/CURSETUPPASSWORD or /CSPWD parameters.
/NOCVAUPDATE or /NU A Used with /AM_BLD_DB. Check the hp Web site for
files that do not have an associated CVA file.
/REPSET: <Path and Filename> U Specifying this command line switch will cause SSM to
copy the appropriate file to the local client and utilize
the Replicated Setup/Security Settings component to
configure the client with these settings.
/TIMEOUT: <Numeric Value> or U Overrides SSM's default timeout of fifteen (15) minute
/TO:<Numeric Value> before aborting execution of a deliverable. The numeric
value is the number of minutes for SSM to wait before
killing the update packages installer.
/TITLE: <"Title"> or /TI:<“Title”> U Specifies the title for the slider bar dialog box (must be
specified in quotes).
A log file in HTML format is created for tracking purposes. By default, the log is stored in the
temporary folder on the client system, unless a different location is specified in the command
line. If the Create centralized logfile share option is selected when running Administrative
Mode, the log will be copied to the specified logfile share on the server. It is named according to
the name of the client computer and has an .HTM extension. Creation of the log file can be
suppressed altogether.
The log file contains the following information:
■ Date and time the log file was generated and the name of the computer that the update was
performed on.
■ Possible Updates: Lists the device identifiers and update packages that have been found in
the database that could potentially be updated on the client system.
■ Updates: Lists the devices and update packages used to update the client system.
■ Errors: Lists errors that occurred during the detection and upgrade process. This section of
the log is generated only if errors occurred.
■ Client Information: Lists the Machine ID, system ROM version, system serial number and
Asset Tag information.
■ Detected Devices: Lists any PCI or Plug and Play device IDs found in the system, along with
ROM name and date and system identifier.
Refer to the log file to get the system ID information when generating CVA files.
For example, if DOMAIN\Jsmith is the current user on a Windows 2000 machine named
COMPUTER1, then the log file will be located in the file C:\DOCUMENTS AND
SETTINGS\JSMITH.DOMAIN\LOCAL SETTINGS\TEMP\COMPUTER1.HTM
The system environment variables TEMP and COMPUTERNAME are useful for locating the log
file.
Updates Performed
Client Information
■ System Manufacturer: Compaq
■ System Product: Evo N410c
■ System Version:
■ Base Board Manufacturer: Compaq
■ Base Board Product: 07F0
■ Base Board Version: KBC Version .
■ Machine ID: 0x07F0
■ BIOS Release Date: 12/15/2003
■ BIOS Version: 686A2 Ver. F.14
■ System Serial Number: J24P000P1262
■ Asset Tag:
■ OS: WIN2000 - SP4
■ LANG: US
Detected Devices
■ Device 0: ACPI\ACPI0003\2&DABA3FF&0
■ Device 1: ACPI\FIXEDBUTTON\2&DABA3FF&0
■ Device 2: ACPI\PNP0000\4&1D6F7EAE&0
■ Device 3: ACPI\PNP0100\4&1D6F7EAE&0
■ Device 4: ACPI\PNP0200\4&1D6F7EAE&0
■ Device 5: ACPI\PNP0303\4&1D6F7EAE&0
■ Device 6: ACPI\PNP0401\5&19BE56DF&0
■ Device 7: ACPI\PNP0501\5&19BE56DF&0
■ Device 8: ACPI\PNP0700\5&19BE56DF&0
■ Device 9: ACPI\PNP0800\4&1D6F7EAE&0
■ Device 10: ACPI\PNP0A03\2&DABA3FF&0
■ Device 11: ACPI\PNP0A06\4&1D6F7EAE&0
■ Device 12: ACPI\PNP0B00\4&1D6F7EAE&0
■ Device 13: ACPI\PNP0C01\2&DABA3FF&0
■ Device 14: ACPI\PNP0C02\0
■ Device 15: ACPI\PNP0C02\1
■ Device 16: ACPI\PNP0C02\2
■ Device 17: ACPI\PNP0C04\4&1D6F7EAE&0
■ Device 18: ACPI\PNP0C0A\1
■ Device 19: ACPI\PNP0C0A\2
■ Device 49:
PCI\VEN_8086&DEV_248A&SUBSYS_00B40E11&REV_02\3&61AAA01&0&F9
■ Device 50:
PCI\VEN_8086&DEV_248C&SUBSYS_00000000&REV_02\3&61AAA01&0&F8
■ Device 51:
PCI\VEN_8086&DEV_3575&SUBSYS_00000000&REV_04\3&61AAA01&0&00
■ Device 52: PCI\VEN_8086&DEV_3575&SUBSYS_00B40E11&REV_04
■ Device 53:
PCI\VEN_8086&DEV_3576&SUBSYS_00000000&REV_04\3&61AAA01&0&08
■ Device 54: PNP0000
■ Device 55: PNP0100
■ Device 56: PNP0200
■ Device 57: PNP0303
■ Device 58: PNP0401
■ Device 59: PNP0501
■ Device 60: PNP0700
■ Device 61: PNP0800
■ Device 62: PNP0A03
■ Device 63: PNP0B00
■ Device 64: PNP0C01
■ Device 65: PNP0C04
■ Device 66: PNP0E03
■ Device 67: PNP0F13
■ Device 68: ROOT\ACPI_HAL\0000
■ Device 69: ROOT\COMPOSITE_BATTERY\0000
■ Device 70: ROOT\DMIO\0000
■ Device 71: ROOT\FTDISK\0000
■ Device 72: ROOT\LEGACY_ADPU160M\0000
■ Device 73: ROOT\LEGACY_AFD\0000
■ Device 74: ROOT\LEGACY_AHA154X\0000
■ Device 75: ROOT\LEGACY_AIC78U2\0000
■ Device 76: ROOT\LEGACY_AIC78XX\0000
■ Device 77: ROOT\LEGACY_ALKERNEL\0000
■ Device 78: ROOT\LEGACY_AMSINT\0000
■ Device 79: ROOT\LEGACY_BEEP\0000
■ Device 80: ROOT\LEGACY_CLNTMGMT\0000
■ Device 81: ROOT\LEGACY_CPQDFW\0000
Sometimes it is necessary to modify a package description (.CVA) file to meet specific needs.
This section defines the more relevant fields used by SSM. CVA files may be modified for
existing SoftPaqs or for customized packages. A customized package is a directory in the file
store that contains a CVA file and the files the package setup files.
There are several key points to remember about CVA files.
■ If a customized package is created, remove the SoftPaq= line from the CVA file.
■ For a non-SoftPaq customized package, all files in the directory and subdirectory of the CVA
are transferred as a unit during installation. Do not put customized packages in the top level
of the file store.
■ If the CVA file and setup files are packaged with Packaged For The Web to create a single
package file, the CVA filename must be the same as the Packaged for the Web file name.
CVA Syntax
[CVA File Information]
CVAVersion=<CVA file version>
[Software Title]
US=<Software Name/Title in US English>
[US.Software Description]
<General description of the software>
[General]
Version=<Software Version>
Revision=<Software Revision>
Pass=<Software Pass Number>
[DetailFileInformation]
<FileName>=<Root of folder>\relative path, <Major Version>, <Minor Version>,
<Major Revision>, <Minor Revision>
[SupportedLanguages]
Languages=<Comma Separated language values as described by the 2 letter
designator>
[Operating Systems]
<OS code>=<Minimum Service Release on which the package works on this OS>
[System Information]
SysID1=<System ID for the 1st system on which this deliverable operates>
SysName1=<Marketing name of the system><Comma separated list of models>
SysIDn=<System ID for the nth system on which this package operates>
Field Definitions
[CVA File Information]
CVAVersion=<CVA File Version>
Optional
This field has no effect on SSM functionality; however, if used properly, keeps track of changes
made to the CVA file. The value is an integer that can be incremented each time changes are
made to the CVA file.
[Software Title]
US=<Software Name/Title in US English>
Required. (Maximum = 40 characters.)
This field identifies the software update.
[US.Software Description]
<General description of the software approved by marketing>
Recommended.
This is a brief description of the software, in English.
[General]
Version=<Software Version>
Required.
This is a free-form text value. It usually follows the form: <Major version>.<Minor
version>
Revision=<Software Revision>
Required.
The revision of the software. If the revision of the software is irrelevant, then leave this key
empty.
[DetailFileInformation]
<FileName1>=<Root folder>\relative path, <Major Version>, <Minor Version>,
<Major Revision>, <Minor Revision>
Required.
To allow SSM to determine if a specific package version is installed on a system, the package
must have a significant file that will always be present and that will always have the correct
version in its resource header (this file may, for example, be the main .EXE file, .DLL, or .SYS
file). Any time the version and revision of a package change, the value in the resource header of
this significant file MUST also change.
SSM uses this information to determine whether the version of the software update is newer than
the version installed on the client computer. Therefore, the [DetailFileInformation] section
needs to describe the file that contains the version information in the resource header.
To determine the version of the package programmatically, the major and minor version as well
as major and minor revision numbers must be entered, separated by commas. This information is
the same information contained in the VS_VERSION_INFO field located in the [File Version]
section of the significant file. The DWORD value for major and minor revision is located in the
[File Version] section and is listed as hex numbers in the form
0x0000,0x0000,0x0000,0x0000. The version information needs to be entered in this
format.
The root of the folder is one of the following values:
Value Description
Value Description
For the Windows NT Matrox Graphics Controller drivers this section would look like this:
[DetailFileInformation]
mga64.dll=<WinSysDir>,0x0003,0x0000,0x0002,0x0000
or
[DetailFileInformation]
mga.sys=<WinSysDir>\drivers,0x0003,0x0000,0x0002,0x0000
A ROM version is designated with the name of the file to be the name of the ROM image CAB
file and the version in the form:
ROM, <ROM Family>,<Month>,<Day>,<Century>,<Year>
If a ROM flash utility is provided (HpFlash32, CpqFlash, PhoenixFlash) and specified on the
SilentInstall= line, then the ROM filename and family fields are not used. Note that the version
values are in decimal, whereas the version values for applications are in "0x__" hex format.
For a 686T2 ROM, this section would be:
[DetailFileInformation]
686T2.CAB=ROM,686T2,10,02,19,98
[SupportedLanguages]
Languages=<Comma Separated language values as described by the 2 letter
designator>
Required.
This key contains a comma-delimited list of languages that the software supports. Each language
is specified by a 2-character code; for example, US is US English, IT is Italian. This key lets
SSM know on which localized operating systems this software can be installed.
If the deliverable supports all languages, then GLOBAL may be specified.
0x0411 JP Japanese
0x0412 KR Korean
0x0419 RU Russian
0x041B SL Slovak
0x041E TH Thai
0x0000 US Default
[Operating Systems]
<OS Code>=<Minimum Service Pack Release>
This section lists operating systems for which the software is intended on which it can run. Each
operating system is specified by its code as follows (each code is a unique version of the
operating system):
WIN95 (Windows 95)
WIN98 (Windows 98)
WINME (Windows ME)
NT40 (Windows NT 4.0)
WIN2000 (Windows 2000)
WINXP32P (Windows XP Professional and Home Edition)
NONE (OS-independent)
Packages must also specify the minimum version service pack release. For example, a driver may
only work on Windows NT 4.0 Service Pack 3 or higher, in which case the CVA file would
contain NT40=SP3. A value MUST be present after the equal sign for each operating system.
There should be only ONE entry for each operating system.
Acceptable values for <Minimum Service Pack Release> are as follows:
OEM (Original OEM release of an operating system
OSR0 (Windows 95 retail release)
OSR1 (Windows 95 OSR1)
OSR2 (Windows 95 OSR2 )
OSR21 (Windows 95 OSR 2.1)
OSR25 ( Windows 95 OSR 2.1)
SP1 (Service Pack 1 [for Windows NT or Windows 98])
SP2 (Service Pack 2)
SP3 (Service Pack 3)
SP4 (Service Pack 4)
SP5 (Service Pack 5)
If the software is OS-independent, as would be the case for ROMPaqs, there should be only one
entry in this section:
NONE
[System Information]
SysID{AnyUniqueTag}=<System ID>
SysName{AnyUniqueTag}=<Marketing name>
Required.
The SysID{AnyUniqueTag} key (where n is a number, 1 through n, assigned to each SysID and
SysName pair) specifies a System ID information for each computer on which software updates
are to be deployed. System ID may be specified in either of two formats, system ID hexadecimal
format, or SMBIOS format. The hexadecimal format is 0xXXXX. For example, the system ID
of Deskpro EN system is 0x0400. The hexadecimal machine ID is listed in the SSM log file.
The SMBIOS format is of the syntax:
SysID{AnyUniqueTag}=<SysMan>,<SysProd>,<SysVer>,<BoardMan>,<BoardProd
>,<BoardVer>
The fields represent the SMBIOS System (record type 1) and SMBIOS Baseboard (record type
2) manufacturer, product, and version fields. Any blank field is considered a wildcard (*) "don't
care." At least one of the six fields must be non-blank. SMBIOS data is available in the SSM log
file.
The SysName key specifies the Product Marketing Name, and associated models for each
computer on which software updates are to be deployed.
[SoftPaq]
SoftPaqNumber=
The SoftPaq number of the software. For custom packages delete this line.
[Devices]
<Device ID>=<Marketing name of the device>
This section lists the Device ID and the Marketing Names of devices with which the software
deliverable is associated, if any. In general, this section is required only for device driver
software. PCI IDs may be expressed in two, three, or four-part names that follow the convention
in the Windows Registry (also displayed in the SSM log file).
SSM searches the list of devices currently present in the system as noted by the SSM log file for
the specified <Device ID> substring. If the <Device ID> substring is not found in the list of
devices on the system, the deliverable is not a possible update for the system.
[Install Execution]
SilentInstall="<Relative path and Install executable>" <command line
parameters>
Required.
This field contains the relative path, within your package folder structure, of the installation
program as well as the command line parameters (if any) required to perform a silent installation
of the software while the OS is running. Enclose the relative path and filename in quote
characters if long file name path is used.
If there is questions of how SSM parsed the command line, use the /DEBUG switch then look in
the log file to see the exact command SSM executes.
Examples:
SilentInstall=setup.exe -s
SilentInstall=disk1\setup.exe -s /parameter:"45x32"
SilentInstall="Long file name\install program.exe" -s /parameter:"45x32"
[Software Title]
US=Notepad Test File
[US.Software Description]
Launches notepad with some parameters to use as a test for SSM.
[General]
Version=5.12.01.2508
Revision=E
Pass=6
[DetailFileInformation]
;
; Version 5.12.01.2508 of notepad.exe is from Windows 2000.
;
notepad.exe=<WINSYSDIR>,0x0005,0x000c,0x0001,0x09cc
[SupportedLanguages]
Languages=GLOBAL
[Softpaq]
;
; Ensure that SoftpaqNumber= is blank or deleted for custom packages.
;
SoftpaqNumber=
SupersededSoftpaqNumber=
[Operating Systems]
;
; Specify the languages here or NONE for all operating systems.
;
;WIN95=OSR2
;WIN98=OEM
;WINME=OEM
;NT40=SP3
;WIN2000=OEM
;WINXP32P=OEM
;
;NONE
[System Information]
;
; Two formats are supported. System ID (0x0538) and
; SMBIOS based system ID information. If no system ID information
; is specified then this deliverable will be installed on all
; platforms.
SysID_538=0x0538
SysName_538=Armada M700
SysID_700=Compaq,,,,M700,
SysName_700=Armada M700
SysID_VL420=Hewlett-Packard,,VL420,,,
SysName_VL420=Hewlett-Packard VL420
[Devices]
;
; If the deliverable is a driver that required specific hardware,
; the specific all the supported PCI ID's here.
;
; ven_8086&dev_2445=ADI SoundMax Integrated Digital Audio
; ven_8086&dev_2415=ADI SoundMax Integrated Digital Audio
[Install Execution]
;
; In this example we will replace the traditional call to "Setup.exe"
; with "NotePad" and use the CVA file name as a parameter.
;
; SilentInstall="SETUP.EXE" -silent
;
SilentInstall="Notepad.EXE" notepad.cva
Install="SETUP.EXE"
Errors
SSM is not a CVA verification tool, and only performs rudimentary checks on the validity of the
data in the CVA file. Refer to Appendix E, “Error Codes” for detailed information about error
messages that may be encountered related to the CVA file. If errors occur, SSM excludes that
software component from the Update Information Database (UID) and does not deploy it. SSM
continues processing the next CVA file. Use the /DEBUG command line option to record
potential CVA file errors to the file ERROR_LOG.TXT while building the database:
SSM /AM_BLD_DB /DEBUG
See also %TEMP%\%computername%.ssmtrace for helpful debug information.
SSM is for use on Windows 95/98 and You have tried to execute SSM on an
Windows NT 4.0 or greater. - SSM Exit unsupported operating system (Windows 3. X or
Windows NT 3.5 X).
Failed to initialize client information. SSM was Detection failed. SSM was unable to obtain
unable to determine asset information on the device information on the client. This error
client system. Device detection will fail, as well. indicates a driver interaction issue.
User does not have correct privileges to update SSM was unable to elevate its privilege to
system - SSM Exit. perform updates. The elevated privilege is
achieved through the trusted client portions of
the administrative wizard.
SSM support CAB component not found - SSM SSM was unable to find the CAB support file
Exit. and aborted execution. This error does not occur
if SSM is installed locally through the /INSTALL
command line switch.
Unable to extract cab file. The support CAB file is corrupted and cannot be
expanded. This error does not occur if SSM is
installed locally through the /INSTALL
command line switch.
Cannot set the setup password with error code The value in this error message indicates the
<value>. reason the setup password could not be set. The
lower byte of <value> is the ROM return code.
(80= Invalid password because it was too long,
86=command not supported)
ROM Flash Error code <value> <symbol_name> SSM was unable to flash the system ROM. The
error code indicates the reason for the failure.
This is sometimes the result of incorrect
passwords (F6 ERROR_LOCKING_MEMORY).
<Update Package Title> has no installer. The specified update package has a blank
SilentInstall entry in its CVA file.
Unable to open <SoftPaq Filename> SSM expands SoftPaq files before executing the
installer for the update. If that expansion fails,
this message is entered in the log file. If this is a
custom deliverable, ensure that the SoftPaq=
line in the CVA file is removed.
Unable to expand ROMPaq <SoftPaq Filename> SSM is expecting a ROM BIOS SoftPaq, but was
unable to expand the files.
<Update Package Title>: Failed to terminate in a SSM waits 15 minutes before terminating an
timely manner. update package's installer. If the installer is
terminated, this message is entered into the log
file.
<Update Package Title>: Returned exit code This message is placed in the log when an
<value> update issues an exit code that is non-zero.This
may or may not represent a failed install since
many updates return non-zero exit codes. The
exit code is update-specific; refer to the
documentation provided with the update to
determine what the exit code means.
<Update Package Title>: Failed to spawn This message indicates that the installer for the
command line (<update package installer update failed to execute properly, and may be
command line with arguments>) with error corrupted.
(<value>)
Can't update the replicated setup settings. The setup password does not match. The
replicated setup/security settings module returns
this message when the system attempts to modify
configuration settings on a client system using an
incorrect password.
Password is set, but no password provided in An attempt to flash the ROM BIOS failed.
SSM.BIN.
RMSET File not found: <Filename> The file specified with the RMSET option was
not found.
Failed to initialize client information. The required device driver could not be loaded
and system information could not be obtained.
This may occur if there is a driver version conflict
or SSM does not have administrative rights.
CVA Errors
Use /DEBUG in Administrative Mode, then check the file ERROR_LOG.TXT to see these
errors.
CVA files are formatted like the INI files found in Windows. SSM uses standard Windows calls
to read the data from these files. Syntax errors in a heading or a tag field will result in that field
being ignored. A syntax error in the data portion of the tag may result in improper execution of
the deliverable, or a misspelled title in the log file.
A syntax error in the Language field or the Operating System fields will result in the whole CVA
file being rejected.
Key file path is invalid. DetailFileInformation Path for the key file is not provided or
is not valid.
Major version information is DetailFileInformation The major file version data was
invalid. omitted.
Minor version information is DetailFileInformation The minor file version data was
invalid. omitted.
Major revision information is DetailFileInformation The major file revision data was
invalid. omitted.
Minor revision information is DetailFileInformation The minor file revision data was
invalid. omitted.
Failed to commit transaction on SSM was unable to add the data from
record add. the current CVA file to the Update
Information Database. This is a
catastrophic error; you must delete the
Update Information Database and
attempt to rebuild it.
Error log contains errors, but Silent installation programs for This is not necessarily an error.
drivers installed properly. some drivers return a non-zero
return code upon completion. SSM
expects a return code of zero.
Controller is not detected by SSM. SSM only detects PCI or Plug and
Play controllers.
SSM ran, but driver was not Driver was uninstalled before Uninstalling the driver may not
updated. running SSM. have deleted all of the driver files
from the hard drive. SSM tries to
determine which version is
installed; remaining files may
indicate that the driver is still
installed. Look for the file name in
the [DetailFileInformation] of
the CVA file for driver update.
Delete the driver file from the hard
disk.
Need to uninstall SSM. Delete SSM components are only installed To remove the client components,
SSM.EXE, SSM.CAB, and the file on client systems when the delete the SSM folder and all files
store. /INSTALL switch is used. The within it.
components are stored in a folder
named SSM on the same drive as
the operating system.
Deliverable does not appear as a CVA file is not SSM compliant. Rebuild the database with the
“possible update.” /DEBUG switch:
SSM.EXE c:\Filestore /DEBUG
/AM_BLD_DB
then examine the file
%TEMP%\%COMPUTERNAME
%.SSMTRACE for clues. SSM will
reject CVA files that do not have
required fields.