Applicable Products
- Provisioning Services
Information
This article contains information for administrators about configuring Citrix Provisioning, formerly Provisioning Services (PVS) 5.6 Service Pack 1 (or later) target devices that are using the Microsoft Key Management Server (KMS) in their environment.
Background
KMS can be configured on the virtual disk (vDisk) image to apply volume licenses for operating systems and Office including:
- Windows 7s and Microsoft Server 2008 R2
- Windows 8s and Microsoft Server 2012
- Windows 8.1s and Microsoft Server 2012 R2
- Windows 10s and Microsoft Server 2016
- Office 2010
- Office 2013
- Office 2016
Note: This is only a general guide for KMS with Provisioning Services. This does not imply that the previously mentioned operating systems and Offices are supported in all versions of Provisioning Services. Refer to the Provisioning Services requirements for the operating system and Office supported in the latest version of Provisioning Services.
In PVS, the option for KMS is configured while building vDisks using the Imaging Wizard. Alternatively, it can be configured at any time using the Console or MCLI/PowerShell command line interfaces. Refer to the PVS documentation for more information about managing Microsoft KMS volume licensing. Note: Information in this article applies only to specified Windows OS and Office versions.
KMS Configuration Scenarios
The following section outlines the steps to configure KMS in various scenarios to accommodate specific deployment environments. Read all the scenarios to verify which one best fits your deployment and follow the procedures accordingly.
Notes:
- Citrix recommends that administrators complete all the steps in the proper order for a successful configuration.
- The SOAP/Stream Service account must be a member of a local administrator group in PVS Servers.
- both Windows and Office
- only Windows
- only Office
Office Folder – This will be referred to as %Office% in this document.
- Office 2010 – Office14
- Office 2013 – Office15
- Office 2015 – Offcie16
Program Files folder - This will be referred to as %ProgramFiles% in this document.
- 32-bit Office in 64-bit operating system, %ProgramFiles% is Program Files (x86).
- Office and operating system are both 32-bit or 64-bit, %ProgramFiles% is Program Files.
Note – If the selected version of Provisioning Services supports versioning, the vDisk's private mode and maintenance version can be used interchangeably. If a maintenance version is used, promote the maintenance version to production or test version; set vDisk access mode from Private to Standard.
Use the following scenarios to configure KMS accordingly:
Configuring KMS for the first time to a pre-existing vDisk |
Maintaining or upgrading a vDisk image that is currently using KMS |
Maintaining or Upgrading a vDisk Image enabled with vDisk Versioning that is currently using KMS |
Installing Microsoft Office to an existing KMS configured (for Windows) vDisk |
Upgrading Microsoft Office on an existing KMS configured (for Windows) vDisk |
Scenario 1: Configuring KMS for the first time for a pre-existing vDisk
Assumptions
A vDisk 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 vDisk that has an 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 vDisk that has the operating system installed on it (Optional: Office is included in the image); the image was pre-built using the XenConvert/Imaging wizard but KMS has never been configured.
Procedure
Note: It is important to perform this operation on a system started from the vDisk 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 does not require rearming again.
- Connect to the PVS Server; in the Console, right-click the vDisk and select Properties.
- Click the Microsoft Volume Licensing tab and set the licensing option to None.
- Start the device from the vDisk in Private Image mode.
- Rearm the system for both Windows and Office, one after the other. If KMS is configured for only one of them, select your option to rearm accordingly:
- For Windows: Run cscript.exe slmgr.vbs -rearm
- For Office 2010, %ProgramFiles%Common Filesmicrosoft sharedOfficeSoftwareProtectionPlatformOSPPREARM.EXE
- For Office 2013 and 2016: %ProgramFiles%Microsoft Office%Office%OSPPREARM.EXE
- Note: When rearming both Windows and Office be sure to rearm Office first.
- A message appears requesting that you reboot the system. Do not reboot - instead, shut down the target device.
- Connect to the PVS Server; in the Console, right-click the vDisk and select Properties.
- Click the Microsoft Volume Licensing tab and 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.
- For Windows: Run cscript.exe slmgr.vbs –dlv
- For Office: Change the directory to %ProgramFiles%Microsoft Office%Office% and then run cscript ospp.vbs /dcmid
Scenario 2-A: Maintaining or upgrading a vDisk image that is currently using KMS
Assumptions
A vDisk is already configured for KMS and is deployed successfully.
- For both Windows and Office: A vDisk is already configured for KMS, both Windows and Office, and is deployed successfully.
- For Windows or Office: A vDisk is already configured for KMS 'Windows' or 'Office' and is deployed successfully.
Procedure
- In the PVS Console, right-click the vDisk and select Properties.
- On the General tab, set the vDisk Access Mode to Private Image mode.
- Start the target device.
- Apply the required operating system Application/Service Pack/Update.
- Shut down the target device.
- Connect to the PVS Server and in the Console, right-click the vDisk and select Properties.
- On the General tab, set the vDisk Access Mode to Standard Image mode.
- Stream the vDisk 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 vDisk is already configured for KMS and is deployed successfully. The vDisk is enabled to use vDisk versioning, and as a result, it might already have versions associated with it.
- For both Windows and Office: A vDisk is already configured for KMS, both Windows and Office, and is deployed successfully.
- For Windows or Office: A vDisk is already configured for KMS, 'Windows' or 'Office', and is deployed successfully.
Procedure
- In the PVS Console, right-click the vDisk, and select Versions.
- Create a new disk version.
- Access target device properties and set Type to Maintenance.
- Start the Target device.
- Access the target device machine and select Maintenance from the Boot menu when prompted.
- Apply the required operating system Application/Service Pack/Update.
- Shut down the target device.
- Access the PVS Server Console, right-click the vDisk, and select Versions. Promote the vDisk from Maintenance to Production or Test.
- Access the PVS Server Console. Under target device properties, change the Type to Production or Test.
- Stream the vDisk with this version to one or more target devices.
Scenario 3: Installing Microsoft Office to an existing KMS configured for a Windows vDisk
Assumption
A vDisk is already KMS configured for Windows and is deployed successfully.
Procedure
- In the PVS Console, right-click the vDisk and select Properties.
- Click the Microsoft Volume Licensing tab and change the licensing option from KMS to None.
- On the General tab, set the vDisk Access Mode to Private Image mode.
- PXE boot to the vDisk in Private Image mode to rearm.
Note: An OS rearm is required along with the Office rearm.
- For Windows: Run cscript.exe slmgr.vbs -rearm
- For Office 2010, %ProgramFiles%Common FilesMicrosoft SharedOfficeSoftwareProtectionPlatformOSPPREARM.EXE
- For Office 2013 and 2016: %ProgramFiles%Microsoft Office%Office%OSPPREARM.EXE
- A message is displayed to reboot the system. Do not reboot - instead, shut down the target device.
- In the Console, right-click the vDisk and select Properties.
- Click the Microsoft Volume Licensing tab and change the license option from None to KMS.
- On the General tab, set the vDisk Access Mode to Standard Image mode.
- Stream the vDisk to one or more target devices.
Note: Validate that the KMS configuration was successful by verifying that the CMID for each device is unique.
- For Windows: Run cscript.exe slmgr.vbs –dlv
- For Office: Change the directory to %ProgramFiles%Microsoft Office%Office% and then run:
- cscript ospp.vbs /dcmid
- cscript ospp.vbs /dstatus (The OS and Office discovery of KMS is independent from each other and /dstatus shows if office has located KMS on network.)
- cscript ospp.vbs /act (To expedite Activation)
- Open Word and check the activation.
- NOTE- Re-launch any Office App twice to kick off the activation service
- Restart the service if you don't get the CMID status.
- Shutdown the target device; do not reboot.
- Connect to the Provisioning Services Server. In the Console, right-click on the vDisk and select Properties.
- On the General tab, set the vDisk Access Mode to Standard Image mode.
- Stream the vDisk to one or more target devices
Scenario 4: Upgrading Microsoft Office on an existing KMS configured (for Windows) vDisk.
Assumption
A vDisk is already KMS configured for Windows and Microsoft Office.
Procedure
- In the Provisioning Services Console, right-click on the vDisk and select Properties.
- On the General tab, set the vDisk Access Mode to Private Image mode.
- Start the target device.
- Run the new Microsoft Office setup and choose to perform an upgrade.
- Reboot the target as required by the installation.
- Shut down the target device.
- Connect to the Provisioning Services Server. In the Console, right-click on the vDisk and select Properties.
- On the General tab, set the vDisk Access Mode to Standard Image mode.
- Stream the vDisk to one or more target devices.
Important Information on Rearm
- Microsoft restricts the number of rearms possible on installed operating systems and Office products.
- With Windows and Office products utilizing KMS activation, the available rearm count will increment from 0 to 1 on a successful activation against a KMS host server.
- If you run out of rearms, activating by using a KMS host lets you rearm once. This ensures that once administrators can activate a KMS client, they will be able to issue a rearm. For example, a KMS client with a rearm count of 1 issues a rearm using the remaining single rearm, and reboot. Upon reboot after the KMS client activates, the rearm count will return to a count of 1.
- In all of the preceding scenarios, a successful KMS configuration for a Provisioning Services vDisk, does not require you to rearm the vDisk except the first time when it is configured.
Additional Resources
Microsoft offers two licensing options for MS Office to suit public needs namely Retail and Volume. Finding out if your Office license is of type “company” (“volume”) or bought in shops (retail) is not straightforward as one would expect. So, here is a small script which can reveal License Type in Command Prompt.
The first, called “Retail”, is that for the general public. All copies of Office purchased from a retail outlet in the neat package shelf are of this type, as well as those that were pre-installed on certain new PCs. ISO images also downloaded via MSDN and TechNet subscriptions should be exclusively of this type.
The second way is instead called “Volume”, and is available to those who need to buy more than 5 licenses for its fleet. Only editions of “Standard” and “Professional Plus” can be purchased in this way, and those interested should apply directly to Microsoft for the purchase.
Difference between Volume and Retail License
The differences that exist between the two are numerous, and not only about the legal aspects related to the license mode.
If the point of view of aesthetics and functionality to the user are not obvious, like product activation features work quite differently: in particular, copies of “Volume” should rely to a Key Management Server (KMS) local for this procedure. This freedom eliminates the need to contact the central server by Microsoft to attend to the operation, but requires that the system draws up the server properly.
Another disadvantage is the fact that, in contrast to the inflections Retail Volume copies of Office are not enabled permanently but they should contact the KMS again every 180 days to remain operational.
On both types it is possible to bypass activation or postpone if you Rearm Office 2010 which is legal method.
Procedure to know the MS Office License type
If you purchased the software or the store you got through TechNet or MSDN, you can stop reading here: installed on your system is definitely a “Retail” version.
If you seek further confirmation prompt, open a mean any application of the suite and bring in File -> Help. Now look at the words shown at right, under the colorful logo of Microsoft Office: if you read the following, your copy is definitely Retail:
Rearm Office License
- Microsoft Office Home and Student
- Microsoft Office Home and Business
- Microsoft Office Professional (note that there is no suffix Plus!)
Notice that the opposite is true: if, for example, here the word Microsoft Office Professional Plus 2010 or Microsoft Office Standard 2010, you could have both a retail version (obtained via TechNet / MSDN, because the two editions are not sold in shop), or a volume.
How To Rearm Office 2019 Txt
For rest of you, Run a Command in Command Prompt (Run as Administrator), one of the following script:
cscript '% ProgramFiles% Microsoft OfficeOffice14ospp.vbs' /dstatus
Office 365 Rearm
cscript 'C:Program Files (x86)Microsoft OfficeOffice14ospp.vbs' /dstatus
Convert Retail to Volume License
In Official way, it is not possible to switch from one License type to another but yes, there are some forums on web which can help you to do it. Procedure is to replace some files in installation folder of MS Office with the downloaded ones in the archive.