• Article

Tools to configure client computers in Office 2010

 

Applies to: Office 2010

Topic Last Modified: 2011-08-05

Banner stating end of support date for Office 2010 with link to more info

The Office Software Protection Platform script and the Volume Activation Management Tool (VAMT) tools will help you configure and test Volume License editions of Microsoft Office 2010. But, before you read this article, we recommend that you read Volume activation overview for Office 2010, Plan volume activation of Office 2010, and Deploy volume activation of Office 2010.

Important

This information applies to volume-licensed editions of Office 2010. It does not apply to Office Professional Plus for Office 365, which is licensed through subscription.

In this article:

  • The ospp.vbs script

  • VAMT 2.0

The ospp.vbs script

The Office Software Protection Platform script (ospp.vbs script) enables you to configure volume editions of Office 2010 client products. You must open a command prompt by using administrator permissions and navigate to the folder that contains the script. The script is located in the %installdir%\Program Files\Microsoft Office\Office14 folder. If you are running 32-bit Office 2010 on a 64-bit operating system, the script is located in the %installdir%\Program Files (x86)\Microsoft Office\Office14 folder.

Running ospp.vbs requires the cscript.exe script engine. To see the Help file, type the following command, and then press ENTER:

cscript ospp.vbs /?

The general syntax is as follows:

cscript ospp.vbs [Option:Value] [ComputerName] [User] [Password]

Option   Specifies the option and value to use to activate a product, install or uninstall a product key, install and display license information, set Key Management Service (KMS) host name and port, and remove KMS host. The options and values are listed in the tables in this section.

ComputerName   Name of the remote computer. If a computer name is not provided, the local computer is used.

User   Account that has the required permission on the remote computer.

Password   Password for the account. If a user account and password are not provided, the current credentials are used.

The following tables list the ospp.vbs options and values.

Global option Description

/act

Activates installed Office 2010 product keys.

/inpkey:value

Installs a product key (replaces existing key) with user-provided product key. Value parameter required.

/unpkey:value

Uninstalls an installed product key with the last five digits of the product key to uninstall (as displayed by the /dstatus option). Value parameter required.

/inslic:value

Installs a license with user-provided path of the .xrm-ms license. Value parameter required.

/dstatus

Displays license information for installed product keys.

/dstatusall

Displays license information for all installed licenses.

/dinstid

Displays Installation ID for offline activation.

/actcid:value

Activates product with user-provided Confirmation ID. Value parameter required.

/puserops

Permits administrator-privileged license operations including Internet or telephone activation by standard users. This sets HKEY_LOCAL_MACHINE\Software\Microsoft\OfficeSoftwareProtectionPlatform\UserOperations =dword:00000001.

/duserops

Denies administrator-privileged license operations including Internet or telephone activation by standard users. This sets HKEY_LOCAL_MACHINE\Software\Microsoft\OfficeSoftwareProtectionPlatform\UserOperations =dword:00000000.

/ddescr:value

Displays the description for a user-provided error code. Value parameter applies.
KMS client option Description

/dhistorykms

Displays KMS client activation history.

/dcmid

Displays KMS client machine ID (CMID).

/sethst:value

Sets a KMS host name with a user-provided host name. Value parameter applies. This sets HKLM\Software\Microsoft\OfficeSoftwareProtectionPlatform\KeyManagementServiceName (REG_SZ).

/setprt:value

Sets a KMS port with a user-provided port number. Value parameter applies. This sets HKLM\Software\Microsoft\OfficeSoftwareProtectionPlatform\KeyManagementServicePort (REG_SZ).

/remhst

Removes KMS host name (sets port to default).
OSPPSVC option Description

/osppsvcrestart

Restarts Office Software Protection Platform service.

/osppsvcauto

Sets Office Software Protection Platform service startup type to automatic. This is recommended for Windows XP computers so that KMS reactivation attempts occur even if Office is not running.

Scenarios that use ospp.vbs

The following scenarios assume that you are running ospp.vbs in an elevated command prompt.

Note

Any changes that you make affect only the Office 2010 client products. You need to configure the Windows client separately by using the slmgr.vbs script. For more information about how to use slmgr.vbs, see Deploy volume activation of Office 2010.

To change the product key to a MAK key on a remote computer

  1. If the remote computer is named contoso1, run the following command to enter the product key. This assumes that you have administrator credentials on the remote computer. If your credentials on the remote computer differ from your logon name and password, you must type your logon name and password at the command line, and then press ENTER:

    cscript ospp.vbs /inpkey:xxxxx-xxxxx-xxxxx-xxxxx-xxxxx contoso1

  2. To activate the remote computer, type the following command, and then press ENTER:

    cscript ospp.vbs /act contoso1

To diagnose KMS activation errors

  1. If the computer has the KMS client key installed, check the licensing status. To do this, type the following command, and then press ENTER:

    cscript ospp.vbs /dstatusall

  2. To check the KMS activation history, type the following command, and then press ENTER:

    cscript ospp.vbs /dhistorykms

  3. To trigger activation, type the following command, and then press ENTER:

    cscript ospp.vbs /act

  4. Check the error message for error code 0xC004F042. If you see an error code in the notification dialog boxes shown to the users, you can also use that code to check the error message. To do this, type the following command, and then press ENTER:

    cscript ospp.vbs /ddescr:0xC004F042

To set test KMS host name, and then set to auto-discovery

  1. If you are testing a KMS host named kmstest.contoso.com, and you want to specify it in the KMS client, type the following command, and then press ENTER:

    cscript ospp.vbs /sethst:kmstest.contoso.com

    Note

    If you change the default port on the KMS host, you must run ospp.vbs with the /setprt parameter.

  2. To trigger activation, type the following command, and then press ENTER:

    cscript ospp.vbs /act

  3. To check the KMS activation history to see whether the host was successfully contacted, type the following command, and then press ENTER:

    cscript ospp.vbs /dhistorykms

  4. Now you want this KMS client to use Domain Name System (DNS) for auto-discovery of the production KMS host. To remove the KMS host name, type the following command, and then press ENTER:

    cscript ospp.vbs /remhst

Generally, you do not have to configure Office KMS clients if the Office KMS host was correctly set up and configured. The KMS client automatically searches for the KMS host by using DNS and attempts activation. The KMS service uses service (SRV) resource records (RR) in DNS to store and communicate the locations of KMS hosts.

By default, KMS hosts automatically publish the information that KMS clients need to find and connect to them by using DNS dynamic update protocol. By default, KMS clients query the DNS server for KMS service information.

You can manually configure KMS hosts and clients, depending on the network configuration and security requirements. For example, if the network environment does not use SRV records, you can manually configure a KMS client to use a specific KMS host. For more information about how to configure the KMS client, see The ospp.vbs script earlier in this article and Prepare and configure the Office 2010 client in Deploy volume activation of Office 2010. For more information about how to configure the KMS host, see Prepare and configure the KMS host in Deploy volume activation of Office 2010.

VAMT 2.0

The Volume Activation Management Tool (VAMT) 2.0 gives you a graphical user interface to manage volume activation. For more information, see Volume Activation Management Tool (VAMT) 2.0 (https://go.microsoft.com/fwlink/p/?LinkId=183042) and the Help file that is included with VAMT 2.0.