SDK Samples: Configuring Key Management System (KMS) Licensing for Windows and Office2010 in Different Scenarios #citrix

SDK Samples: Configuring Key Management System (KMS) Licensing for Windows and Office2010 in Different Scenarios

Configuring Key Management System (KMS) Licensing for Windows and Office2010 in Different Scenarios

Document ID: CTX128276 / Created On: Feb 9, 2011 / Updated On: Feb 15, 2012

Average Rating: (1 ratings)

View products this document applies to

Introduction

This article helps an Administrator configure Provisioning Services 5.6 Service Pack 1 Target Devices that are using Microsoft Key Management Server (KMS) in the best way to fit their environment. KMS can be configured on a virtual disk image with the help of Provisioning Services to apply volume licenses for Microsoft Server 2008, Microsoft Server 2008 R2, Windows 7 and Windows Vista, as well as Office 2010.

In Provisioning Services, 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 Administrator’s Guide, Section “Managing Microsoft KMS Volume Licensing” provides further details on KMS configuration for a Provisioning Services virtual disk.

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 steps accordingly. It is recommended that the administrators completes all steps in the proper order for a successful configuration.

KMS configuration can be done in the following ways in accordance with various environment: Customers can configure KMS for:

Both Windows and Office
Only Windows
Only Office

The Scenario’s below help the administrator to configure KMS accordingly.

SCENARIO 1: Configure KMS by building a virtual disk using Imaging Wizard

Assumptions:

For both Windows and Office 2010: The physical or virtual machine with the operating system and Office 2010 installed on it.

For Only Windows or Only Office 2010: The physical or virtual machine with the operating system installed on it. (Optional: Office 2010 is included in the image)

Steps:

Install Provisioning Services Client software (Provisioning Services 5.6.1)
Run Imaging wizard to build a virtual disk.
On the page of Microsoft Volume Licensing select KMS.
Build the virtual disk.
Shut down the target device.
Boot the device off virtual disk in Private Image mode.
Rearm the system for both Windows & Office, one after the other. If KMS is configured for “Only” one of them, then rearm one of them accordingly.

For Windows Vista, 7, 2008, and 2008R2: Run cscript.exe slmgr.vbs -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(x32)\Common Files\microsoft shared\OfficeSoftwareProtectionPlatform\OSPPREARM.EXE

Note: It is important to perform this operation on a system booted from the virtual disk in Private Image mode so that the master target device hard disk's rearm count is not reduced. Also, if the system is rearmed once, an administrator never needs to rearm it again.

A message appears to reboot the system, DO NOT REBOOT- Instead, shut down the Target device.
Set the virtual disk mode to Standard Image mode.
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 2008R2: Run cscript.exe slmgr.vbs –dlv
For Office 2010: Run C:\Program Files\Microsoft Office\Office14\cscript ospp.vbs /dcmid

SCENARIO 2: Configure KMS for the first time to a pre-existing vDisk

Assumptions:

A virtual disk was pre-build using a tool like XenConvert or the Imaging wizard (with Microsoft Licensing Option set to None)

For both Windows and Office 2010: a virtual disk that has operating system and Office 2010 installed on it; is pre-build using XenConvert/Imaging Wizard but KMS has never been configured.

For Only Windows or Only Office 2010: a virtual disk that has the operating system installed on it (Optional: Office 2010 is included in the image); that was pre-built using XenConvert/Imaging wizard but KMS has never been configured.

Steps:

Go to Provisioning Services Server: In the Console, right-click on the virtual disk, then select the File Properties menu option. The vDisk File Properties dialog appears
Click on the Microsoft Volume Licensing tab, then set the licensing option to None.
Boot the device from the virtual disk in Private Image mod.
Rearm the system for both Windows and Office2010, one after the other. If KMS is configured for “Only” one of them, then pick your option to rearm one of them accordingly.

For Windows Vista, 7, 2008, and 2008 R2: Run cscript.exe slmgr.vbs -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(x32)\Common Files\microsoft shared\OfficeSoftwareProtectionPlatform\OSPPREARM.EXE

Note: It is important to perform this operation on a system booted from the virtual disk in Private Image mode so that the master target device hard disk's rearm count is not reduced. Also, once the system is rearmed once, you never need to rearm it again.

A message appears to reboot the system, DO NOT REBOOT- Instead, shut down the Target device.
Go to Provisioning Services Server: In the Console, right-click on the vDisk, then select the File Properties menu option. The vDisk File Properties dialog appears
Click on the Microsoft Volume Licensing tab, then set the licensing option to KMS.
On the Mode tab, set the vDisk access mode to Standard Image mode
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

SCENARIO 3: 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 2010: a virtual disk is already configured for KMS for both Windows and Office2010 and is deployed successfully.

For Only Windows or Only Office 2010: VDisk is already configured for KMS for “Only Windows” or “Only Office2010” and is deployed successfully.

Steps:

From the Provisioning Services Console: Set the virtual disk mode to Private Image mode.
Boot up a target device.
Apply the required operating system Application/Service Pack/Update.
Shut down the target device.
Set the virtual disk mode back to Standard Image mode.
Stream the virtual disk to one or more target devices.

SCENARIO 4: Installing Microsoft Office 2010 to an existing KMS configured (for Windows) vDisk during Maintenance

Assumptions:

A virtual disk is already KMS configured for Windows and is deployed successfully.

Steps:

In the Console, right-click on the virtual disk, then select the File Properties menu option
Click on the Microsoft Volume Licensing tab, then change the licensing option from KMS to None.
On the Mode tab, set the virtual disk access mode to Private Image mode.
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(x32)\Common Files\microsoft shared\OfficeSoftwareProtectionPlatform\OSPPREARM.EXE
Repeat for Windows Vista, 7, 2008, and 2008R2: Run cscript.exe slmgr.vbs –rearm.

A message appears to reboot the system, DO NOT REBOOT- Instead, shut down the Target device.
In the Console, right-click on the virtual disk, then select the File Properties menu option.
Click on the Microsoft Volume Licensing tab, then change the license option from None to KMS.
On the Mode tab, set the virtual disk access mode to Standard Image mode.
Stream the virtual disk to one or more target devices.

Note: Administrators can validate 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

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 above cases for a successful KMS configuration for a Provisioning Services virtual disk, you never need to rearm the virtual disk except the first time when you configure it.
We recommend that you rearm the system booted from the virtual disk in Private Image mode so that the master target device hard disk's rearm count is not reduced.

This document applies to:

• Provisioning Services 5.6