Chapter 13 - Using SMS 2.0 Tools - Part 1

Archived content. No warranty is made as to technical accuracy. Content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Using SMS 2.0 Tools Part 1 and Part 2 explain how to use the Systems Management Server (SMS) tools provided in the Microsoft BackOffice 4.5 Resource Kit CD-ROM. In addition to the information contained in these two chapters, you can find additional up-to-date information about SMS 2.0 tools in the SMS 2.0 Tools Help, which is included as part of the Resource Kit Tools Help.

These two chapters are written for those who are already familiar with Microsoft Windows NT. For general information about Windows NT (including keyboard equivalents to menu and mouse actions), see the Windows NT Help.

This chapter, Using SMS 2.0 Tools — Part 1, covers the following categories of tools:

  • System Setup Tools 

  • Site Maintenance and Administration Tools 

  • Client Maintenance Tools 

The next chapter, Using SMS 2.0 Tools — Part 2, covers the following categories of tools:

  • Log File, Schedule File, and Error Code Tools 

  • Discovery and Inventory Tools 

  • Software Distribution Tools 

  • Remote Control Tools 

  • Scalability Tools 

  • SMS 1.2 Interoperability Tools 

Disclaimers

Many BackOffice tools were created at Microsoft as in-house development aids. Use these tools at your own risk.

  • These tools are provided "as is," without warranty of any kind. Microsoft disclaims any implied warranty of merchantability or fitness for a particular purpose. 

  • These tools have not been localized; they are written and tested in English only. Using these tools with a different language version of a Windows NT product might produce unpredictable results. 

  • Many of these tools are designed to work only if you have logged on as a member of an Administrators group. 

Feedback

You can send feedback, comments, or bug reports for these tools or for any Microsoft BackOffice Resource Kit documentation to the following Internet address: rkinput@microsoft.com.

Installing SMS Tools

You install the SMS tools by running the Microsoft BackOffice 4.5 Resource Kit CD-ROM Setup program, which will run automatically when you insert the compact disc. By default, all SMS tools are installed and accessed through the Microsoft Tools Management Console. However, you can customize the installation by selecting Custom setup and selecting only the categories of tools you want to install, such as System Setup tools or Client Maintenance tools.

The Tools Management Console, shown in the following figure, is an integrated application that you can use to explore and run the BackOffice 4.5 Resource Kit tools, and to open Help. You can access all the SMS 2.0 tools from this location.

Cc723590.smc14027(en-us,TechNet.10).gif

Important The SMS tools require that the Windows Management Instrumentation (WMI) core components be installed. If you do not already have the WMI core components installed, you can install them from the Systems Management Server 2.0 compact disc by running the Setup program from the following location: SMSsetup\Bin\<Platform>\Wbemsdk.exe. Note that two of the tools (the Delete Group Class tool and the Site Utilities tool) can only be installed on an SMS site server. If the Setup program cannot verify that the computer is an SMS site server, these tools will not be installed. This additional requirement is noted in the text for these tools.

Finally, you can install some of the tools on other computers, such as client computers, by copying the required files to the local hard drive. This will be noted in the text for the applicable tools.

The Microsoft BackOffice 4.5 Resource Kit Setup program creates a Resource Kit program group on the Start menu. This program group consists of the following three menu items: Resource Kit Tools Help, Resource Kit Online Books, and Tools Management Console. The Resource Kit program group also contains a Release Notes folder. By default, the Microsoft BackOffice 4.5 Resource Kit is installed to the following directory on your local drive: C:\Program Files\Resource Kit folder.

Overview of Tool Categories

For convenience and manageability, the SMS 2.0 tools have been divided into several broad categories. It is important to note that many of the tools could be listed under more than one category but are listed only once under the best matching category. Therefore, it is important to familiarize yourself with all SMS 2.0 tools by reviewing the list of categories and the brief descriptions of each tool.

When categorizing tools, many factors are considered, including the purpose of the tool, the product area it services, and specific installation considerations. Because the Microsoft BackOffice Resource Kit 4.5 Setup options allow you to install tools by category, the tool categories also represent logical groupings of tools that you might want to install together.

SMS 2.0 tools are organized using the following categories:

  • System Setup Tools 

  • Site Maintenance and Administration Tools 

  • Client Maintenance Tools 

  • Log File, Schedule File, and Error Code Tools 

  • Discovery and Inventory Tools 

  • Software Distribution Tools 

  • Remote Control Tools 

  • Scalability Tools 

  • SMS 1.2 Interoperability Tools 

Each of these categories is listed with a short description of the tools that belong in the category. In addition to the short descriptions, each tool is described in more detail within its category. Detailed descriptions of the first three categories are presented in this chapter and the rest of the categories are presented in Chapter 14.

System Setup Tools Overview

The Microsoft BackOffice 4.5 Resource Kit CD-ROM includes these system setup tools:

Administrator Console Setup (v20Admin.ini, v20Admin.sms)

Installs the SMS 2.0 Administrator console on a computer other than the site server.

Client Preload (CliStage.ipf)

Installs SMS client software on a computer before that computer is added to an SMS site.

Query Backup and Restore (QryEdit.exe) 

Exports and imports an SMS query. You can use this tool for backing up and restoring queries.

Site Maintenance and Administration Tools Overview

The Microsoft BackOffice 4.5 Resource Kit CD-ROM includes these site maintenance and administration tools:

Delete Group Class (DelGrp.exe) 

Deletes a group class and its tables from the SMS site database.

License Reports (LicenseReports.mdb) 

Accesses the software metering database and generates reports that use the software metering data.

Load Site Boundary (SiteBndy.exe) 

Loads site boundaries from a text file.

Load Network Discovery (NDiscLdr.exe) 

Loads resources for Network Discovery from a text file. You can specify subnets, domains, SNMP devices, and DHPC servers.

Make Collection (Makecoll.exe) 

Creates a new collection by using a text-file list of machine names or IP addresses.

Preferred Server (Localsvr.exe, SetSMSsvr.exe) 

Two tools that query the site database for distribution point group and client access point (CAP) network abstraction layer (NAL) paths. These tools place the paths in the client registry to specify preferred distribution point groups and CAPs for the client to use.

Query Extract (SMSExtract.xlt, SMSExtract.xls, SMSExtract.mdb) 

Extract SMS query results into individual spreadsheets of a Microsoft Excel workbook or into a Microsoft Access 97 table.

Site Utilities (Preinst.exe) 

Diagnoses and repairs an SMS site.

Client Maintenance Tools Overview

The Microsoft BackOffice 4.5 Resource Kit CD-ROM includes these client maintenance tools:

APM Spy (APMSpy.exe)

Displays internal Advertised Program Manager data for a client.

Client Cleaner (20CliCln.bat)

Removes an SMS 2.0 client by removing all SMS client components.

Client Utilities (Cliutils.exe) 

Performs various SMS functions on a client, including starting or stopping a client component, displaying schedule information for a client component, and registering an application to be started by the client launchers.

Process Viewer (Pview95.exe) 

Displays information about processes on local and remote Windows 95 or Windows 98 computers through a graphical user interface. This tool is especially useful for investigating process memory use.

Set Client Event Tool (SetEvnt.exe) 

Triggers client component events on a client. By default, this tool forces Client Configuration Installation Manager (CCIM) and Copy Queue to cycle on the client. Other events can be specified.

Set Preferred Distribution Point and CAP Tool (PrefServ.exe) 

Specifies a preferred distribution point group or CAP for a client.

Set New ID Tool (Newuid.exe)

Assigns a new unique SMS identifier (ID) to a client.

Zap (Zap.exe) 

Deletes a file that is in use or that cannot otherwise be deleted.

Log File, Schedule File, and Error Code Tools Overview

The Microsoft BackOffice 4.5 Resource Kit CD-ROM includes these log file, schedule file, and error code tools:

Convert Schedule and Read Schedule Tools (SchedCnv.exe and ReadSche.exe) 

Displays schedule string data in a readable format for troubleshooting schedule problems.

Dump Error Messages (Error32.exe) 

Displays error messages for Win32 error codes.

Dump Scheduler Data (DumpSend.exe) 

Displays data from a Scheduler send request (.srq) file.

Log Span (LogSpan.exe) 

Displays log file entries from multiple log files for a specified time period.

NAL Logging (Turn_on_nal.reg) 

Enables or disables NAL logging on an SMS client or server.

SMS Trace and Tracer (Smstrace.exe, Tracer.exe) 

Displays the SMS service log files in real time. When you use these tools, log file data is automatically displayed as it is added to the log file.

Discovery and Inventory Tools Overview

The Microsoft BackOffice 4.5 Resource Kit CD-ROM includes these discovery and inventory tools:

Dump Discovery Data (Discdump.exe) 

Displays network discovery data from the local client discovery data record (DDR) file in a readable format.

Inventory Synchronizer (InvSync.exe) 

Sends a hardware or software inventory resynchronization request to client.

MIF Checker (MIFCheck.exe) 

Validates the syntax of a Management Information Format (MIF) file and reports syntax errors. This tool also parses a MIF file and displays it.

MIF Form Generator and MIF Entry (Mifgen.exe, Mifwin.exe)

Extends a client's computer inventory to include additional types of information by creating custom groups.

MOF Manager (MofMan.exe) 

Modifies the classes and attributes that are collected for hardware inventory by editing the SMS_def.mof file.

Software Inventory Viewer (SinvView.exe)

Displays data generated by the SMS Software Inventory Processor in a readable format. Displays both full inventory (.sic) and delta inventory (.sid) files and data from the software inventory history file (Sinv.his).

Software Distribution Tools Overview

The Microsoft BackOffice 4.5 Resource Kit CD-ROM includes these software distribution tools:

Advertisement Info (AdvInfo.exe) 

Displays information from the header of a package file or an advertised programs offer file, including the package ID, name, version, language, MIF file information, the command line for the executable file, and disk space requirements.

Configure Client Desktop (SetStart.exe) 

Configures program shortcuts on a client's desktop or on the client's Start menu.

Delete PDF (DeletPDF.exe) 

Deletes package definition files (PDFs) from the SMS site database.

Make CAP (MakeCAP.exe) 

Assigns the client access point (CAP) role to a server.

Make Distribution Point (MakeDist.exe) 

Assigns the distribution point role to a server.

Make Distribution Point Group (MakeDPG.exe) 

Creates a distribution point group from a text file.

PDF Wizard (Pdfwiz.exe) 

Creates a PDF from a package ID.

Test Application (TestApp.exe) 

A dummy application used to test software distribution packages.

Remote Control Tools Overview

The Microsoft BackOffice 4.5 Resource Kit CD-ROM includes these Remote Control tools:

Remote Control Settings (RCCliopt.exe) 

Sets the default protocol and Lana number for a remote control client. This tool also disables the Update Enable setting on the client so that these settings cannot be changed by the client or by an administrator at another SMS site.

Set NIC Tool (Multinic.exe) 

Specifies which network interface card (NIC) a client will bind to for use with Remote Tools.

Stop Remote Control (StopRC.exe) 

Stops the Remote Control Client Agent on a client that is connected to the network through a Microsoft Remote Access Service (RAS) account. The client agent can then bind to the assigned IP address when it is restarted.

Scalability Tools Overview

The Microsoft BackOffice 4.5 Resource Kit CD-ROM includes these scalability tools:

Site Properties Manager (SMSSPMan.exe) 

Imports and exports site properties through a graphical user interface, enabling you to quickly create a hierarchy of sites.

SMS Console Load Simulation (UILoad.exe)

Simulates the load that multiple SMS Administrator consoles might generate on an SMS site.

SMS Object Generator (SMSObgn.exe, SMSObldr.exe) 

Generates data that mimics the expected or actual client load you will have on your SMS sites.

SMS 1.2 Interoperability Tools Overview

The Microsoft BackOffice 4.5 Resource Kit CD-ROM includes these SMS 1.2 interoperability tools:

Add/Remove 1.2 Console (V12Admin.ipf)

Adds or removes the SMS 1.2 Administrator console.

PGC Migration Wizard (SMS_MPGC.exe) 

Converts SMS 1.2 Program Group Control (PGC) data to SMS 2.0 APM format.

System Setup Tools

You use the SMS 2.0 system setup tools to perform the following tasks:

  • Install an SMS 2.0 Administrator console. 

  • Install SMS 2.0 client software to a computer before it is added to an SMS 2.0 site. 

  • Back up and restore an SMS query. 

Administrator Console Setup Tool (v20Admin.ini, v20Admin.sms)

Use the Administrator Console Setup tool to install the SMS 2.0 Administrator console on a computer other than the site server. To use this tool, you must be familiar with the SMS 2.0 software distribution process and perform the following tasks:

  • Create a disk image of the SMS 2.0 compact disc and place this image on a package source directory. 

  • Copy V20Admin.ini to the \SMSSetup\Bin directory of the package source directory you just created. 

  • Create a software distribution package by using v20Admin.sms as the PDF and the directory you just created as the package source directory. 

  • Create an advertisement for the package and specify the target computers that you want to install the SMS 2.0 Administrator console on. The package will perform a silent installation of the SMS Administrator console. 

Administrator Console Setup Runs On

Processors: i386, Alpha
Operating systems: Windows NT 4.0

Files Required for Administrator Console Setup

V20Admin.ini
V20Admin.sms

Client Preload Tool (CliStage.ipf)

Use the Client Preload tool to install SMS client software on a computer before it is added to an SMS site. For more information about this tool, see the SMS 2.0 Tools Help.

Client Preload Runs On

Processors: i386, Alpha
Operating systems: Windows NT 4.0, Windows NT 3.51, Windows 98, Windows 95

Files Required for Client Preload

CliStage.ipf

Query Backup and Restore Tool (QryEdit.exe)

Use the Query Backup and Restore tool to back up and restore SMS queries. This tool will only back up user-defined queries, not SMS 2.0 default queries. When you restore queries, the queries you restore are added as new queries to the SMS Administrator console. You can also use this tool to export a query from one site and import it to another site.

Query Backup and Restore Runs On

Processors: i386, Alpha
Operating systems: Windows NT 4.0

Files Required for Query Backup and Restore

QryEdit.exe

Query Backup and Restore Syntax

qryedit [/export file | /import file]

/export file 

Backs up the specified query file.

/import file 

Restores the specified query file to the SMS Administrator console. The file will be added as a new query.

Using Query Backup and Restore

When restoring a query to a site or importing it to another site, be sure to use the exact query output from this tool. Do not strip any data. If you want to modify the query, first restore or import the query and then use the SMS Administrator console to modify the query.

Site Maintenance and Administration Tools

You use the SMS 2.0 site maintenance and administration tools to perform the following tasks:

  • Delete group classes from the SMS site database. 

  • Generate reports that use software metering data. 

  • Load site boundaries from a text file. 

  • Load resources for Network Discovery from a text file. 

  • Create new collections by using a text file. 

  • Set preferred distribution points and CAPs for clients to access. 

  • Extract SMS query results into individual spreadsheets of a Microsoft Excel workbook or into a Microsoft Access 97 table. 

  • Diagnose, repair, and shut down an SMS site. 

Delete Group Class Tool (DelGrp.exe)

Use the Delete Group Class tool to delete a group class and its tables from the SMS site database. For information about how to obtain the correct group class syntax to use with this tool, see "Using Delete Group Class."

Delete Group Class Runs On

Processors: i386, Alpha
Operating systems: Windows NT 4.0

Installing Delete Group Class

Note In order for the Delete Group Class tool to run correctly, you must install this tool on an SMS primary site server.

Files Required for Delete Group Class

DelGrp.exe

Delete Group Class Syntax

delgrp "group"

group 

The name of the group class to delete. The name must be encased within double quotation marks.

Using Delete Group Class

Before you can use the Delete Group Class tool, you must first obtain the proper name of the group that you want to delete. You can obtain a list of group classes by running the following query in SQL:

select GroupClass from GroupMap

When you have retrieved the proper group class name, you can use this tool to delete it. For example:

c:\winnt\profiles\administrator\desktop\newfolder\delgrp.exe "MICROSOFT|WORKSTATION_STATUS|1.0" 

If you do not encase the group class name within double quotation marks, the tool will misinterpret the group class name and return an error.

Note This tool will delete the group table and its contents from the SMS site database.

License Reports (LicenseReports.mdb)

Use the License Reports tool to access the software metering database and to generate reports by using Microsoft Access 97. In order for this tool to work, the following requirements must be met on the computer that this tool is run on:

  • An open database connectivity (ODBC) data source connection must be created and configured. 

  • Microsoft Access 97 must be installed. 

  • Both the computer and the Access database must have a network connection to the software metering server. 

  • The account that is used to access the software metering server must have sufficient rights to the SQL Server database. 

  • LicenseReports.mdb must be installed on the computer. 

For information about creating an ODBC data source connection and preparing reports, see "Using License Reports."

License Reports Runs On

Processors: i386, Alpha
Operating systems: Windows NT 4.0

Files Required for License Reports

LicenseReports.mdb

Using License Reports

This section includes procedures for performing the following tasks:

  • Creating and configuring an ODBC data source connection 

  • Configuring and testing the ODBC data source connection from Access 97 

  • Preparing reports by using the License Reports tool 

Creating and configuring an ODBC data source connection

Before you can use the License Reports tool, you must first create and configure an ODBC data source connection.

To configure an ODBC data source connection 

  1. Click the Start button, point to Settings, and then click Control Panel

  2. Double-click the ODBC icon. 

  3. In the ODBC Data Source Administrator dialog box, click the System DSN tab, and then click Add

    Cc723590.smc14016(en-us,TechNet.10).gif  

  4. In the Create New Data Source dialog box, select SQL Server from the list of drivers, and then click Finish

    Cc723590.smc14017(en-us,TechNet.10).gif

  5. In the Create New Data Source to SQL Server dialog box, complete the Name, Description, and Server fields. The server is the name of the software metering server you want to use. 

    Note If you are using SQL Server version 6.5, the next four dialog boxes are replaced by one dialog box (the ODBC SQL Server Setup dialog box), which prompts you to enter the equivalent information. 

    Cc723590.smc14018(en-us,TechNet.10).gif  

  6. Click Next, and then select the authentication method for the SQL Server logon. Windows NT authentication requires that the software metering database be set up with integrated security. 

    Cc723590.smc14019(en-us,TechNet.10).gif

  7. In the Create a New Data Source to SQL Server dialog box, use the default settings (Use ANSI quoted identifiers and Use ANSI nulls, paddings and warnings), and then click Next

    Cc723590.smc14020(en-us,TechNet.10).gif

  8. In the Create a New Data Source to SQL Server dialog box, use the default settings, and then click Finish

    Cc723590.smc14021(en-us,TechNet.10).gif

  9. In the ODBC Microsoft SQL Server Setup dialog box, click Test Data Source

    Cc723590.smc14022(en-us,TechNet.10).gif 

  10. When the test is successfully completed, click OK in the SQL Server ODBC Data Source Test dialog box. 

    Cc723590.smc14023(en-us,TechNet.10).gif 

Configuring and testing the ODBC data source connection in Access 97

After you create and configure the ODBC data source connection, you must configure and test the connection in Access 97, as described in the following procedure.

To configure and test the data source connection in Access 97 

  1. In Access 97, open LicenseReports.mdb. 

  2. In the Software Metering Reports dialog box, click Modify ODBC Settings

    Cc723590.smc14024(en-us,TechNet.10).gif  

  3. In the ODBC Settings dialog box, complete the settings so that they match the settings you used to create and configure the ODBC data source connection. You must complete the following settings: 

    SQL DSN Name 

    The name of the ODBC data source connection. 

    SQL DSN UID 

    The Windows NT account or SQL Server User ID, depending on the authentication method you selected when configuring the ODBC connection. 

    SQL DSN Database 

    The name of the software metering database. 

    SQL DSN PWD 

    The password for the Windows NT account or SQL Server User ID. 

    SQL DSN ReadOnly 

    The table open mode of the SQL Server data: 1 = Read Only, 0 = Full Access 

    Cc723590.smc14025(en-us,TechNet.10).gif 

  4. After you complete the settings in the ODBC_Settings dialog box, click Done

  5. In the Software Metering Reports dialog box, click Test ODBC Connections

  6. In the ODBC Connection Tester dialog box, click SQL DSN.

If the test runs without generating an error message, you are ready to start preparing reports.

Preparing reports by using the License Reports tool

If the ODBC data source connection tested correctly, you can start generating reports. To do so, use the following procedure.

To prepare reports by using the License Reports tool 

  1. In the Software Metering Reports dialog box, click Prepare Metering Reports.

    If an error occurs at this point, the ODBC data source connection has not been configured correctly. Otherwise, you can select a report and begin reporting. 

    Cc723590.smc14026(en-us,TechNet.10).gif

  2. To prepare a report, select the desired report from the Report Selection list. 

  3. Modify the appropriate information in Parameters for Usage Data, and then click Prepare Report.

    All available parameters are listed, even though they are not required for all reports. For example, the Ignored Programs report requires no parameters and prints the list. Any parameters you select will persist across sessions, which allows you to prepare reports without having to reenter the parameters. 

The License Reports tool creates tables linked to the ODBC connection. When you close this tool, the connections are also closed.

Load Site Boundary Tool (SiteBndy.exe)

Use the Load Site Boundary tool to load site boundaries from a text file. If your site includes many subnets, using this tool to enter the site boundaries listed in a text file might be more efficient than entering each subnet by hand from within the SMS Administrator console.

Before using this tool, you must create a text file with a list of site boundaries — one IP subnet per line or one IPX number per line. For more information about creating this text file, see "Using Load Site Boundary."

This tool includes a command-line option that you can use to export existing site boundaries to a text file, which you can then modify. If you choose to do this, you must run the Load Site Boundary tool twice, the first time to export the existing site boundaries; the second time to impose the changes to the modified text file.

By default, the site boundaries specified in the text file are appended to any existing site boundaries. However, you can also overwrite existing site boundaries as well, which is necessary if you are modifying site boundaries that were exported from the site.

For more information about defining site boundaries, see "Site Boundaries" in Chapter 3, "Planning for SMS in Your Organization," in the SMS 2.0 Administrator's Guide.

Load Site Boundary Runs On

Processors: i386, Alpha
Operating systems: Windows NT 4.0

Files Required for Load Site Boundary

SiteBndy.exe
Your test file

Load Site Boundary Syntax

sitebndy filename server sitecode [/s:sitecode] [/e | /i] [/u: user [password | *]]

filename 

The text-file list of site boundaries. If you are using the /e option, the current site boundaries are exported to this text file.

server 

The name of the site server where the SMS Provider resides.

sitecode 

The three-letter SMS site code of the site that you want to connect to.

/s sitecode 

Processes the site boundaries at the specified site. Specify the site by typing the three-letter SMS site code. By default, the site boundaries are processed at the site that the user is logged onto. So, use this option if you want to process the site boundaries at a different site.

/e 

Exports existing site boundary addresses to the text file specified in filename. If you use the /i option to overwrite existing site boundaries, you should first use this option to save a copy of the old site boundaries. You can use the resulting text file to modify site boundaries. However, you cannot use the /e and /i options simultaneously. You must run the tool once for each of these options.

/i 

Overwrites existing site boundaries with the site boundaries specified in the accompanying text file. This option deletes all previously specified site boundaries. If you use this option, you can first use the /e option to save a copy of the old site boundaries to a text file. Keep in mind that you must run the tool once for each of these options.

/u user [password | *]

Specifies a user and password for server to complete the SMS site code changes. If this option is not specified, the user and password that is currently logged on will be used. If used, this command-line option must be specified last. Otherwise, another command-line option will be interpreted as part of the password. If you want to be prompted to enter a password, type an asterisk (*) after the user name. If no password is specified and an asterisk is not used, the password is interpreted as null.

Using Load Site Boundary

The Load Site Boundary tool allows you to enter site boundaries in many different formats. However, by default, this tool reads the input file for IP addresses. To specify a different address type, such as IPX numbers, you must use the following format:

address,<type_of_address>

For example, the following input specifies both IPX addresses and IP addresses:

12121212,IPX Network Number
21212121,IPX Network Number
123.123.123.123
100.100.100.100

Load Network Discovery Tool (NDiscLdr.exe)

Use the Load Network Discovery tool to load resources from a text file for Network Discovery. You can specify subnets, domains, SNMP devices, and DHPC servers. Before using this tool, you must create a text file with a list of network resources — one resource per line. For more information about creating the input text file, see "Using Load Network Discovery."

Load Network Discovery Runs On

Processors: i386, Alpha
Operating systems: Windows NT 4.0

Files Required for Load Network Discovery

NDiscLdr.exe
Your text file

Load Network Discovery Syntax

NdiscLdr filename server sitecode [/s:sitecode] [/e | /i | /a ] [/u:user [ password | * ] ]

filename 

The text-file name. If you are using the /e option, the current settings are exported to this file.

server 

The name of the site server where the SMS Provider resides.

sitecode 

The three-letter SMS site code of the site that you want to connect to.

/s sitecode 

Processes the Network Discovery data at the specified site. Indicate the site by typing the three-letter SMS site code. By default, the Network Discovery data is processed at the site that the user is logged onto. So, use this option if you want to process the site Network Discovery data at a different site.

/e 

Exports existing site boundary addresses to the text file specified in filename. If you use the /i or /a option to overwrite existing Network Discovery data, you should first use this option to save a copy of the old Network Discovery data. You can also use the resulting text file to modify Network Discovery data. However, you cannot use the /e, /a, and /i options simultaneously. You must run the tool once for each of these options.

/i 

Overwrites existing Network Discovery data with the Network Discovery data specified in the accompanying text file. This option deletes all previously specified Network Discovery data. If you use this option, you can first use the /e option to save a copy of the old Network Discovery data to a text file. Keep in mind that you must run the tool once for each of these options.

/a 

Appends the data in the input text file to the existing Network Discovery data. Duplicate entries are ignored. However, you cannot use the /e, /a, and /i options simultaneously. You must run the tool once for each of these options.

/u user [password | *]

Specifies a user and password for server to complete the SMS site code changes. If this option is not used, the user and password that is currently logged on will be used. If used, this command-line option must be specified last. Otherwise, another command-line option will be interpreted as part of the password. If you want to be prompted to enter a password, type an asterisk (*) after the user name. If no password is specified and an asterisk is not used, the password is interpreted as null.

Using Load Network Discovery

When creating the input text file, you can enter domains by name and subnets, SNMP devices, and DHCP servers as IP addresses. When entering IP addresses into the input text file, list the addresses, one per line. Place a header prior to each domain or IP address to indicate what type of data you are entering. The following is an example of input text for the Load Network Discovery tool:

[subnets]
001.012.123.234 255.255.255.0
[domains]
aDomainName
[SNMP Devices]
111.222.33.44
[DHCP]
255.121.255.121

Make Collection Tool (Makecoll.exe)

Use the Make Collection tool to create a new collection from a text-file list of computer names or IP addresses that you provide. Before using this tool, you must create a text file with a list of NetBIOS computer names or IP addresses — one name or address per line. By default, Make Collection reads the text file for computer names. If your text file specifies IP addresses, use the /i option to have Make Collection read the text file for IP addresses instead. For more information about creating the text file, see "Using Make Collection."

Make Collection Runs On

Processors: i386, Alpha
Operating systems: Windows NT 4.0

Files Required for Make Collection

Makecoll.exe
Your text file

Make Collection Syntax

makecoll filename collection server [**/s:sitecode] [/i] [/u:**user [password | *]]

filename 

The text-file list of computer names or IP addresses.

collection 

The name of the collection being created.

server 

The name of the site server where the SMS Provider resides.

/s sitecode 

Specifies the site that the collection will belong to, where sitecode is the three-letter SMS site code.

/i 

Reads IP addresses from the text file rather than machine names.

/u user [password | *]

Specifies a user and password for server to create the collection. If this option is not used, then the user and password that is currently logged on will be used. If used, this command-line option must be specified last. Otherwise, another command-line option will be interpreted as part of the password. If you want to be prompted to enter a password, type an asterisk (*) after the user name. If no password is specified and an asterisk is not used, the password is interpreted as null.

Using Make Collection

If your collection name includes spaces, enclose the collection name in quotation marks as follows:

makecoll MyList.txt "New Collection" MySiteServer /s:ABC

The /u option prompts you for a user name and password to create the collection. If used, the /u option must be the last command-line option specified. To specify a user name (such as Administrator) and prompt a user to enter a password, use the following syntax:

makecoll MyList.txt "New Collection" MySiteServer /s:ABC 
/u:Administrator *

To specify both a user name and a password for a user to enter when accessing the collection, use the /u option and specify both a user name and the password:

makecoll MyList.txt MyNewCollection MySiteServer /s:ABC /i
/u:SMSAdmin My_password

Preferred Server Tools (LocalSvr.exe, SetSMSSvr.exe)

Use the Preferred Server tools to specify preferred distribution point groups and CAPs for a client. The Preferred Server tools include two tools. The first tool, LocalSvr.exe, queries the SMS site database for the NAL paths of distribution point groups and CAPs. The second tool, SetSMSSvr.exe, places these NAL paths in the client registry to specify preferred distribution point groups and CAPs for the client to use. For more information about the Preferred Server tools, see the SMS 2.0 Tools Help.

Query Extract Tools (SMSExtract.xlt, SMSExtract.xls, SMSExtract.mdb)

Use the Query Extract tools to extract SMS query results into individual spreadsheets of a Microsoft Excel workbook (SMSExtract.xlt and SMSExtract.xls) or into a Microsoft Access 97 table (SMSExtract.mdb).

By placing the query data into an Excel workbook, you can analyze, format, and print the information within Excel or export it to other applications, such as Access or Microsoft Word. By placing query data into an Access 97 table, you can use the Access report wizards to generate reports based on SMS data.

Using the Query Extract tools, you can easily create custom reports suited to your organization's needs and requirements. For more information about using the Query Extract tools, see Chapter 15, "Reporting Options for SMS 2.0" in this guide.

Site Utilities Tool (Preinst.exe)

The Site Utilities tool passes commands to Hierarchy Manager while Hierarchy Manager is running. Use this tool to diagnose problems in a site, repair a site, or stop all SMS services at a site. For example, suppose that you incorrectly removed an SMS site by removing a child site from its parent site without detaching it first. You can use the Site Utilities tool to bypass the SMS Administrator console and delete the incorrectly removed site from the parent site database.

Site Utilities Runs On

Processors: i386, Alpha
Operating systems: Windows NT 4.0

Installing Site Utilities

You must install the Site Utilities tool on an SMS primary or secondary site. If you run the Microsoft BackOffice 4.5 Resource Kit Setup program on a computer that does not meet this requirement, this tool will not be installed.

Files Required for Site Utilities

Preinst.exe

Site Utilities Syntax

preinst options

Where options are:

/deinstall:{ sitecode } 

Sends a command to remove a specific secondary site from a site hierarchy. The sitecode parameter specifies the site to remove. Note that the braces are required.If you want to remove a secondary site from the site hierarchy, you should first try to remove it by using SMS Administrator console. If this approach fails for any reason, use the /deinstall command.

/deljob: sitecode 

Deletes all jobs, or commands, that are targeted to the specified site. The sitecode parameter specifies the site to remove jobs for.

/delsite: { sitecode, parentsite**}** 

Deletes incorrectly removed sites from the SMS site database at the parent site. Use this option if you removed a site before you detached it from its parent site. Note that the braces are required.The sitecode parameter specifies the site to delete; parentsite is the SMS site code of the parent site of the site you are deleting. When you specify parentsite, this parameter prevents the unwanted deletion of a site that was previously relocated under a different parent site in another part of the site tree. For example, typing preinst /delsite:{chl,par} deletes site CHL only if it has a parent site of PAR. This transaction propagates up the site hierarchy to all parent sites of the current site.Note This command does not remove the target site. It only removes the site and its SMS domains from the local SMS site database and propagates the change up the site hierarchy.

/dump 

Writes site control images* *for all sites to the SMS\Site.srv\Sitecfg.box directory. (An image is a binary representation of the site control file, which is stored in the SMS site database.)

/stopsite 

Stops all the SMS services at the site.

/syncchild: sitecode 

Synchronizes a child site with the parent site. The sitecode parameter specifies the site to synchronize with.

/syncparent 

Forces all site control images in the SMS site database to simultaneously propagate up to the parent site of the current site and all its subsites or child sites. Use this option when sites are out of synchronization due to time lags or other failures.

/upgrade:{ sitecode } 

Selectively upgrades a specific secondary site. The sitecode parameter specifies the site to upgrade. If a global upgrade fails to upgrade all secondary sites, use this option to upgrade the failed sites. Note that the braces are required.

Client Maintenance Tools

You use SMS 2.0 client maintenance tools to perform the following tasks:

  • Display information from the header of a package file (.pkg) or an offer file (.ofr). 

  • Remove an SMS 2.0 client by removing all the SMS client components. 

  • Start or stop client components and client events and view other information related to client components, such as schedule information. 

  • Display and end system processes on a Windows 95 or Windows 98 computer. 

  • Specify a preferred distribution point and CAP for a client. 

  • Assign a new unique SMS ID to a client. 

  • Delete files that are in use or that cannot otherwise be deleted. 

APM Spy Tool (APMSpy.exe)

Use the APM Spy tool to view internal Advertised Program Manager data for a client in a readable format. APM Spy is a command-line tool that should be installed and run on a client.

APM Spy Runs On

Processors: i386; Alpha
Operating systems: Windows NT 4.0, Windows 98, Windows 95

Installing APM Spy

You can install the APM Spy tool by running the Microsoft BackOffice 4.5 Resource Kit Setup program or you can install it on a client by copying APMSpy.exe to the \MS\SMS\Core\Bin directory on the client. The APM Spy tool also uses CliBase.dll and CliLog.dll, which should already be located in this directory.

Files Required for APM Spy

APMSpy.exe
CliBase.dll
CliLog.dll

APM Spy Syntax

apmspy 

Using APM Spy

When you run the APM Spy tool, you are prompted to enter a value to indicate the type of information you want to view. The following is a list of values you can enter with a description of the information that appears:

O program_number 

Displays the merged advertisement information (offer) received by the client for the specified program.

I program_number 

Displays the items (list information) that appear in the Advertised Programs Monitor and Advertised Programs Wizard for the specified program.

D program_number 

Displays the program properties that appear in the Advertised Programs Monitor and Advertised Programs Wizard for the specified program.

S 

Displays the programs that are scheduled to run on the client.

T 

Displays the programs that are waiting for a trigger before they can run on the client. Triggers include logon, logoff, or another program that must run first.

C 

Displays the interprocess communications (IPC) connections for the client. The Advertised Programs Monitor, Advertised Programs Wizard, Offer Data Provider, and Program Execution Agent all rely on the IPC mechanism to communicate with the Advertised Programs Manager (SMSAPM32).

X 

Quits the APM Spy tool.

Client Cleaner Tool (20CliCln.bat)

Use the Client Cleaner tool to remove an SMS 2.0 client by removing all SMS client components.

Note You must have Administrator rights on the client computer. Otherwise some SMS 2.0 files and registry settings will not be removed.

Client Cleaner Runs On

Processors: i386, Alpha
Operating systems: Windows NT 4.0, Windows NT 3.51, Windows 98, Windows 95

Installing Client Cleaner

You can install the Client Cleaner tool by running the Microsoft BackOffice 4.5 Resource Kit Setup program or by copying the required files to the desired location. However, all required files must reside in the same directory.

Files Required for Client Cleaner

20CliCln.bat
Hammer.exe
Kill.exe
SetEvnt.exe

Client Cleaner Syntax

20clicln.bat 

Client Utilities Tool (Cliutils.exe)

Use the Client Utilities tool to perform various SMS functions on an SMS client, including the following:

  • Signal a Start Cycle event for a client component. The Start Cycle event forces the client component to cycle. 

  • Start a client component. 

  • Stop a client component. 

  • Display the schedule of a client component in readable format. 

  • Register an application to be started by the client launchers. 

For a list of client components that can be used with this tool, see "Using Client Utilities."

Client Utilities Runs On

Processors: i386, Alpha
Operating systems: Windows NT 4.0, Windows NT 3.51, Windows 98, Windows 95

Files Required for Client Utilities

Cliutils.exe

Client Utilities Syntax

CliUtils command parameter_list 

/kick component_name 

Initiates the Start Cycle event for the specified client component.

/start component_name 

Initiates the Start event for the specified client component.

/stop component_name 

Initiates the Stop event for the specified client component.

/sched component_string 

Decodes the Schedule List string.

/appreg 

Registers an application to be started by the client launchers. After this command is issued, the Client Utilities tool prompts the user to enter information about how the application should be registered. To use this command-line option, you must understand the client launchers.

Using Client Utilities

When using the Client Utilities tool, the following client components can be specified:

Clisvcl (Client Service NT) 

Runs on Windows NT clients and starts and monitors the state of all service-context SMS client components (those that run even when the user is logged off). This client component runs continually on all Windows NT clients. CCIM and Copy Queue run as threads of Client Service NT.

Clisvc95 (Client Service 98/95) 

Runs on Windows 98 and Windows 95 clients and starts and monitors the state of all service-context SMS client components (those that run even when the user is logged off). This client component runs continually on all Windows 98 and Windows 95 clients. CCIM and Copy Queue run as threads of Client Service 98/95.

Ccim32 (Client Configuration Installation Manager) 

Ensures that each client is correctly installed and assigned to the correct sites. As mentioned earlier, this client component also keeps the client data and the SMS site server data synchronized. CCIM runs as a thread of the SMS Client service.

SMSapm32 (Available Programs Manager) 

Runs software on the client, including advertised programs. This client component also runs the installation programs for the optional SMS client components.

SMSmon32 (Advertised Programs Monitor) 

Runs the software distribution process on clients. This client component is only installed when the Advertised Programs Client Agent is enabled for the client.

Process Viewer Tool (PView95)

Process Viewer is a Windows 95 tool that is especially useful for investigating process memory use. You can use this tool's graphical user interface to display information about processes on local and remote Windows 95 or Windows 98 computers. Process Viewer is similar to Windows NT Task Manager. You can use Process Viewer to stop a running process and change the base priority class of the process.

Process Viewer Runs On

Processors: i386, Alpha
Operating systems: Windows 98, Windows 95

Installing Process Viewer

In addition to installing the Process Viewer tool by running the Microsoft BackOffice 4.5 Resource Kit Setup program, you can install this tool by copying the required files to the desired location.

Files Required for Process Viewer

PView95.exe

Process Viewer Syntax

pview95 

Set Client Event Tool (SetEvnt.exe)

Use the Set Client Event Tool to trigger events on a client. The Set Client Event tool forces both CCIM and Copy Queue to cycle on the client. By using the Set Client Event tool, you can force these client components into action without having to wait for the scheduled cycle. You can also use this tool to trigger other client components. For more information, see "Using Set Client Event."

CCIM is the SMS client component that ensures that each client is correctly installed and assigned to the correct SMS sites. CCIM also keeps the client data and the SMS site server data synchronized by creating DDRs and determining which optional components should be installed. This component runs as a thread of the SMS Client service. Copy Queue is an SMS client component that copies data to CAPs and logon points.

Set Client Event Runs On

Processors: i386, Alpha
Operating systems: Windows NT 4.0, Windows NT 3.51, Windows 98, Windows 95

Installing Set Client Event

You can install the Set Client Event tool by running the Microsoft BackOffice 4.5 Resource Kit Setup program or by copying the required files to the desired location.

Files Required for Set Client Event

SetEvnt.exe

Set Client Event Syntax

setevnt [/q] [cq | COMPONENT_EVENT]

/q 

Starts the client event in silent mode — no dialog boxes are displayed.

cq 

Starts only the Copy Queue client component.

COMPONENT 

The client component to start, such as CLISVCL (Client Service). COMPONENT is case-sensitive and must be entered using all uppercase letters.

EVENT 

The event to start, such as STARTCYCLE. EVENT is case-sensitive and must be entered using all uppercase letters.

Using Set Client Event

By default, the Set Client Event tool will start Ccim32.exe and Cqmgr32.exe in regular mode and, if applicable, all dialog boxes will appear on the client. To start the client event in silent mode so that the dialog boxes do not appear, use the /q option:

setevnt /q

To start only Copy Queue, use the cq option:

setevnt cq

To start a different client event, specify the event:

setevnt CLISVCL_STARTCYCLE

– or –

setevnt /q CLISVCL_STARTCYCLE

In addition to starting Ccim32.exe and Cqmgr32.exe, you can trigger both the STARTCYCLE event and CLOSE event for the following client components:

CLISVCL (Client Service NT) 

Runs on Windows NT clients and starts and monitors the state of all service-context SMS client components (those that run even when the user is logged off). This client component runs continually on all Windows NT clients. CCIM and Copy Queue run as threads of Client Service NT.

CLISVC95 (Client Service 98/95) 

Runs on Windows 98 and Windows 95 clients and starts and monitors the state of all service-context SMS client components (those that run even when the user is logged off). This client component runs continually on all Windows 98 and Windows 95 clients. CCIM and Copy Queue run as threads of Client Service 98/95.

CCIM32 (Client Configuration Installation Manager) 

Ensures that each client is correctly installed and assigned to the correct sites. As mentioned earlier, this client component also keeps the client data and the SMS site server data synchronized. CCIM runs as a thread of the SMS Client service.

SMSAPM32 (Available Programs Manager) 

Runs software on the client, including advertised programs. This client component also runs the installation programs for the optional SMS client components.

SMSMON32 (Advertised Programs Monitor) 

Runs the software distribution process on clients. This client component is only installed when the Advertised Programs Client Agent is enabled for the client.

Set Preferred Distribution Point and CAP Tool (PrefServ.exe)

Use the Set Preferred Distribution Point and CAP tool to specify a preferred distribution point and CAP for a client. The Set Preferred Distribution Point and CAP tool places an NAL path in the correct registry location on a client. When a client needs to access a distribution point or CAP, the servers specified by this tool will be tried first.

Important You must run this tool on the client computer.

See also, "Preferred Server Tools."

Set Preferred Distribution Point and CAP Runs On

Processors: i386, Alpha
Operating systems: Windows NT 4.0, Windows NT 3.51, Windows 98, Windows 95, Windows for Workgroups 3.11, Windows 3.1.

Files Required for Set Preferred Distribution Point and CAP

PrefServ.exe

Set Preferred Distribution Point and CAP Syntax

prefserv [/cap sitecode | /dp sitecode] [/add nalpath | /remove nalpath]

/cap sitecode 

Indicates that the NAL path specified for the /add or /remove options represents a CAP. Specify the site by typing the unique three-letter SMS site code. When this option is used, the NAL path for the CAP will either be added or removed from the client registry.

/dp sitecode 

Indicates that the NAL path specified for the /add or /remove options represents a distribution point. Specify the site by typing the unique three-letter SMS site code. When this option is used, the NAL path for the distribution point will either be added or removed from the client registry.

/add nalpath 

The NAL path to add to the client registry for the CAP or distribution point.

/remove nalpath 

The NAL path to remove from the client registry for the CAP or distribution point.

Using Set Preferred Distribution Point and CAP

When using the Set Preferred Distribution Point and CAP tool, you can only specify a NAL path for either the distribution point or for the CAP. To add or remove a NAL path for both a distribution point and a CAP, you must run the tool twice.

Note Unless the NAL path ends with a file name, the NAL path must end with a backslash.

To specify a NAL path for a Windows NT CAP, use the following syntax:

MSWNET:["SMS_SITE=<sitecode>"]\\<server>\cap_<sitecode>\

To specify a NAL path for a Windows NT distribution point, use the following syntax, where server_share_enumeration is the drive letter that hosts the distribution point share:

MSWNET:["SMS_SITE=<sitecode>"]\\<server>\SMSPKG<server_share_enumeration>$\

To specify a NAL path for a Windows NT distribution point with an administrator-defined share name, use the following syntax:

MSWNET:["SMS_SITE=<sitecode>"]\\<server>\<sharename>\

For more information, the following syntax and parameters indicate the elements that make up a NAL path:

<provider_qualifier_list><provider_name>:<machine_qualifier_list>\\<provider_specific_path>\<directory>\<file>

where 

provider_qualifier_list 

The list of provider qualifiers, enclosed in brackets. For example, ["Qual1","Qual2",...].

provider_name 

One of six possible provider names: generic, abexprt, local, mswnet, nwbind, or nwnds.

machine_qualifier_list 

The list of machine qualifiers. For example, an SMS site qualifier (type [SMS_site=sitecode]) or an SMS preferred server qualifier (type ["Preferred"].

provider_specific_path 

The path elements. For example, a server and share or volume, or a tree and context.

directory 

The directory in the target NOS.

file 

The file in the target NOS.

The following is an example of a generic NAL path:

["DISPLAY=\\Server1\Share1\"]MSWNET:["SMS_SITE=NNN","PREFERRED"]\\Server2\\SMS_CAP\

Set New ID Tool (Newuid.exe)

Use the Set New ID tool to assign a new unique SMS ID to a client. For more information about this tool, see the SMS 2.0 Tools Help.

Set New ID Runs On

Processors: i386, Alpha
Operating systems: Windows NT 4.0, Windows NT 3.51, Windows 98, Windows 95

Installing Set New ID

You can install the Set New ID tool by running the Microsoft BackOffice 4.5 Resource Kit Setup program or by copying the required files to the desired location.

Files Required for Set New ID

Newuid.exe

Zap Tool (Zap.exe)

Use the Zap tool to delete a file that is in use or that cannot otherwise be deleted. After you run this tool and restart the computer, the file is deleted.

Zap Runs On

Processors: i386, Alpha
Operating systems: Windows NT 4.0

Installing Zap

You can install the Zap tool by running the Microsoft BackOffice 4.5 Resource Kit Setup program or by copying the required files to the desired location.

Files Required for Zap

ZAP.exe

Zap Syntax

zap filename 

filename 

The path of the file to be deleted.Cc723590.spacer(en-us,TechNet.10).gif