26/1/2015

ConfiguringKMSLicensingforWindowsandOffice2010and2013

ConfiguringKMSLicensingforWindowsandOffice2010and2013
CTX128276
Article

Created on Mar 26, 2014

Updated on Dec 11, 2014

Topic : Configuration, Licensing

See Applicable Products

Information
This article contains information for the Administrator about configuring the Provisioning Services (PVS) 5.6 Service Pack 1 (or later) Target Devices that are
using Microsoft Key Management Server (KMS) in the best way to fit their environment.

Background
KMS can be configured on the virtual disk (vDisk) image with the help of PVS to apply volume licenses for Microsoft Server 2008, Microsoft Server 2008 R2,
Windows 7 and Windows Vista, as well as Office 2010 and 2013.
In PVS, the option for KMS can be easily configured while building virtual disks with the Imaging Wizard. Alternatively, it can be configured at any time using the
Console or MCLI/PowerShell command-line interfaces.
The Product Administrators Guide, section Managing Microsoft KMS Volume Licensing provides further details on KMS configuration for a PVS virtual disk.
Note: Information in this article applies only to the Windows OS and Office versions specified.

KMS Configuration Scenarios

The following section outlines the steps to configure KMS in various scenarios to accommodate specific deployment environment. Read all the scenarios to
verify which one best fits your deployment and follow the procedures accordingly.
Notes:
Citrix recommends that the administrators complete all the steps in the proper order for a successful configuration.
SOAP/Stream Service account must be a member of local administrator group in PVS Servers.
KMS configuration can be done in the following ways in accordance with various environments. The customers can configure KMS for:
Both Windows and Office
Only Windows
Only Office
The following scenarios help the administrator to configure KMS accordingly:

Scenario 1: Configuring KMS for the first time to a pre-existing vDisk

Assumptions
A virtual disk was pre-built using a tool like XenConvert or the Imaging wizard (with Microsoft Licensing Option set to None).
For both Windows and Office: A virtual disk that has operating system and Office installed on it is pre-built using XenConvert/Imaging Wizard but KMS has
never been configured.
For only Windows or only Office: A virtual disk that has the operating system installed on it (Optional: Office is included in the image); that was pre-built using
XenConvert/Imaging wizard but KMS has never been configured.
Procedure
Note: It is important to perform this operation on a system started from the virtual disk in Private Image mode so that the rearm count of the master target
device hard disk is not reduced. Also, when the system is rearmed, it is not required to rearm it again.
1. Open PVS Server and in the Console, right-click the vDisk and select Properties.
2. Click the Microsoft Volume Licensing tab and set the licensing option to None.
3. Start the device from the virtual disk in Private Image mode.
4. Rearm the system for both Windows and Office, one after the other. If KMS is configured for Only one of them, then select your option to rearm one of
them accordingly:
For Windows Vista, 7, 2008, and 2008 R2: Run cscript.exe slmgr.vbs -rearm
For Office (for 64-bit client): Program Files(x86)\Common Files\microsoft shared\OfficeSoftwareProtectionPlatform\OSPPREARM.EXE

http://support.citrix.com/article/CTX128276

1/4

26/1/2015

ConfiguringKMSLicensingforWindowsandOffice2010and2013
For Office (for 32-bit client): Program Files\Common Files\microsoft shared\OfficeSoftwareProtectionPlatform\OSPPREARM.EXE
For Office 2013 (for 64-bit client): Program Files(x86)\Microsoft Office\Office15\OSPPREARM.EXE
For Office 2013 (for 32-bit client): Program Files\Microsoft Office\Office15\OSPPREARM.EXE
5. A message appears to reboot the system. Do not reboot - instead, shut down the target device.
6. Open PVS Server and in the Console, right-click the vDisk and select Properties.
7. Click the Microsoft Volume Licensing tab and set the licensing option to KMS.
8. On the Mode tab, set the vDisk access mode to Standard Image mode.
9. Stream the vDisk to one or more target devices.
Note: Administrators can validate that the KMS configuration was successful by verifying that the CMID for each device is unique.
For Windows Vista, 7, 2008, and 2008 R2: Run cscript.exe slmgr.vbs dlv
For Office 2010: Run C:\Program Files\Microsoft Office\Office14\cscript ospp.vbs /dcmid
For Office 2013: Run C:\Program Files\Microsoft Office\Office15\cscript ospp.vbs /dcmid

Scenario 2-A: Maintaining or upgrading a vDisk image that is currently using KMS
Assumptions
A virtual disk is already configured for KMS and is deployed successfully.
For both Windows and Office: A virtual disk is already configured for KMS for both Windows and Office and is deployed successfully.
For only Windows or only Office: Virtual disk is already configured for KMS for Only Windows or Only Office and is deployed successfully.
Procedure
1. From the PVS Console, right-click the virtual disk and select Properties.
2. On the General tab, set the virtual disk access mode to Private Image mode.
3. Start the target device.
4. Apply the required operating system Application/Service Pack/Update.
5. Shut down the target device.
6. Open PVS Server and in the Console, right-click the vDisk and select Properties.
7. On the General tab, set the vDisk access mode to Standard Image mode.
8. Stream the virtual disk to one or more target devices.

Scenario 2-B: Maintaining or Upgrading a vDisk Image enabled with vDisk Versioning that is currently using KMS
Assumptions
A virtual disk is already configured for KMS and is deployed successfully. The vDisk is enabled to use vDisk versioning, hence might already have versions.
For both Windows and Office: A virtual disk is already configured for KMS for both Windows and Office and is deployed successfully.
For only Windows or only Office: Virtual disk is already configured for KMS for Only Windows or Only Office and is deployed successfully.
Procedure
1. From the PVS Console, right-click the virtual disk, and select Versions.
2. Create a new disk version.
3. Access Target device properties and set Type to Maintenance.
4. Start the Target device.
5. Access the Target device machine and select Maintenance from the Boot menu when prompted.
6. Apply the required operating system Application/Service Pack/Update.
7. Shut down the Target device.
8. Access the PVS Server Console, right-click the virtual disk, and select Versions. Promote the vDisk from Maintenance to Production or Test.
9. Access the PVS Server Console. Under target device properties, change the Type to Production or Test.
10.

Stream the virtual disk with this version to one or more target devices.

Scenario 3: Installing Microsoft Office to an existing KMS configured (for Windows) vDisk during Maintenance
Assumption

http://support.citrix.com/article/CTX128276

2/4

26/1/2015

ConfiguringKMSLicensingforWindowsandOffice2010and2013
A virtual disk is already KMS configured for Windows and is deployed successfully.
Procedure
1. From the PVS Console, right-click the virtual disk and select Properties.
2. Click the Microsoft Volume Licensing tab and change the licensing option from KMS to None.
3. On the General tab, set the virtual disk access mode to Private Image mode.
4. PXE boot to the virtual disk in Private Image mode to rearm.
For Office 2010 (for 64-bit client): Program Files(x86)\Common Files\microsoft shared\OfficeSoftwareProtectionPlatform\OSPPREARM.EXE
For Office 2010 (for 32-bit client): Program Files\Common Files\microsoft shared\OfficeSoftwareProtectionPlatform\OSPPREARM.EXE
For Office 2013 (for 64-bit client): Program Files(x86)\Microsoft Office\Office15\OSPPREARM.EXE
For Office 2013 (for 32-bit client): Program Files\Microsoft Office\Office15\OSPPREARM.EXE
Windows Vista, 7, 2008, and 2008R2: Run cscript.exe slmgr.vbs rearm
5. A message is displayed to reboot the system. Do not reboot - instead, shut down the target device.
6. In the Console, right-click the virtual disk and select Properties.
7. Click the Microsoft Volume Licensing tab and change the license option from None to KMS.
8. On the General tab, set the virtual disk access mode to Standard Image mode.
9. Stream the virtual disk to one or more target devices.
Note: Administrators can validate that the KMS configuration was successful by verifying that the CMID for each device is unique.
For Windows Vista, 7, 2008, and 2008 R2: Run cscript.exe slmgr.vbs dlv
For Office 2010: Run C:\Program Files\Microsoft Office\Office14\cscript ospp.vbs /dcmid
For Office 2013: Run C:\Program Files\Microsoft Office\Office15\cscript ospp.vbs /dcmid

Scenario 4-A: Upgrading Microsoft Office from 2010 to 2013 on an existing KMS configured (for Windows) vDisk during Maintenance
Assumptions
A virtual disk is already KMS configured for Windows and Microsoft Office.
Note: Microsoft Office 2013 is only supported on PVS 7.1 and later.
Procedure
1. From the Provisioning Services Console, right-click on the virtual disk and select Properties.
2. On the General tab, set the virtual disk access mode to Private Image mode.
3. Start the target device.
4. Run the Microsoft Office 2013 setup and choose to perform an upgrade.
5. Reboot the target as required by the installation.
6. Shut down the target device.
7. Open Provisioning Services Server. In the Console, right-click on the vDisk and select Properties.
8. On the General tab, set the vDisk access mode to Standard Image mode.
9. Stream the virtual disk to one or more target devices.

Scenario 4-B: Upgrading Microsoft Office from 2010 to 2013 on an existing KMS configured (for Windows) vDisk Image enabled with
vDisk Versioning
Assumptions
A virtual disk is already KMS configured for Windows and Microsoft Office.
Note: Microsoft Office 2013 is only supported on PVS 7.1 and later.
Procedure
1. From the Provisioning Services Console, right-click the virtual disk, and select Versions.
2. Create a new disk version.
3. Access Target device properties and set Type to Maintenance.
4. Start the Target device.
5. Access the Target device machine and select Maintenance from the Boot Menu when prompted.

http://support.citrix.com/article/CTX128276

3/4

26/1/2015

ConfiguringKMSLicensingforWindowsandOffice2010and2013
6. Run the Microsoft Office 2013 setup and choose to perform an upgrade.
7. Reboot the target as required by the installation.
8. Shut down the Target device.
9. Access the Provisioning Services Server Console, right-click the virtual disk, and select Versions. Promote the vDisk from Maintenance to Production or
Test.

10.

Access the Provisioning Services Server Console. Under target device properties, change the Type to Production or Test.

11.

Stream the virtual disk with this version to one or more target devices.

Important Information on Rearm

Microsoft limits the number of times you can run rearm on an installed operating system Image and Office. The operating system and Office must be
reinstalled accordingly if the number of allowed rearm attempts is exceeded.
However, in all of the preceding scenarios, for a successful KMS configuration for a Provisioning Services virtual disk, it is not required to rearm the virtual
disk except the first time when it is configured.
Citrix recommends that you rearm the system which is started from the virtual disk in Private Image mode so that the rearm count of the master target
device hard disk is not reduced.

Additional Resources
Office 2010 KMS installation and troubleshooting
Plan KMS activation of Office 2010
Microsoft Office 2010 KMS Host License Pack
Rearm the Office 2013 Installation

Applicable Products
Provisioning Services

Share your comments or find out more about this topic

Citrix Forums

http://support.citrix.com/article/CTX128276

4/4