Configuring a vDisk for Microsoft Volume Licensing
Configure a vDisk for Microsoft Key Management Service (KMS) or Multiple Activation Key (MAK) volume licensing when running the Imaging Wizard. If the vDisk was not configured using the Imaging Wizard, it can still be configured from the Citrix Provisioning console.
Important:
Citrix配置不支持麦activation for Microsoft Office products.
Using MCLI and SOAP server command line interfaces for Microsoft volume licensing
MCLI and SOAP Server command-line interfaces can be used to configure Microsoft Volume Licensing using the following procedure:
- Select the vDisk in the Citrix Provisioning console, then right-click and selectFile Properties. ThevDisk File Propertiesdialog appears.
- Click theMicrosoft Volume Licensingtab, then select theMAKorKMSlicensing method.
- ClickOK.
Configuring Microsoft KMS volume licensing
This section describes how to use KMS license access codes with Citrix Provisioning.
Note:
Support for KMS licensing requires the SOAP Server user account is a domain user with the right to perform volume maintenance tasks. The domain user is typically found in
Local\\Computer Configuration\\Windows Settings\\Security Settings\\Local Policies\\User Rights Assignment
. By default, a member of the local administrators group has this right.
KMS volume licensing utilizes a centralized activation server. This server runs in the data center, and serves as a local activation point (opposed to having each system activate with Microsoft over the internet).
Note:
Preparing or updating a KMS configured vDisk that is copied or cloned includes completing the final configuration task. Change the vDisk mode fromPrivate Image ModetoShared Image Mode. Prepare the vDisk before copying or cloning the vDisk to other Provisioning Servers. Copy the
pvp
andvhdx
file to retain the properties and KMS configuration of the original vDisk.
The tasks involved in configuring a vDisk image to use KMS volume licensing and managing that vDisk in a Citrix Provisioning farm includes:
- Enabling KMS licensing on the created vDisk. Select theKMSmenu option on the Microsoft Volume Licensing tab when running the Imaging Wizard. See theImaging Wizardfor details.
- Preparing the new base vDisk image
- Maintaining or upgrading the vDisk image
Note:If KMS licensing was not configured on the vDisk when running the Imaging Wizard, alternatively configure it using the Console. You can also configure it using the MCLI and PowerShell command-line interface.
Preparing the new base vDisk image for KMS volume licensing
After you create a vDisk using the Imaging Wizard, it must be reset to a non-activated state using therearmcommand.
Perform this operation on a system booted from the vDisk inPrivate Image Mode. This process ensures that the master target device hard disk’s rearm count is not reduced.
Tip:Microsoft limits the number of times you can run rearm on an installed OS image. Reinstall the operating system if you exceed the number of allowed rearm attempts.
- Boot the target device from the vDisk in private image mode to rearm.
Note:
OSPPPREARM.EXE must be run from an elevated command prompt.
- A message prompts you to reboot the system, DO NOT REBOOT. Instead shut down the target device.
- If the KMS option was not selected when the vDisk image was created, click theMicrosoft Volume Licensingtab and set the licensing option toKMS.
- Set the vDisk mode to standard image mode.
- Stream the vDisk to one or more target devices.
Use the information in the following sections to configure various KMS scenarios.
Maintaining or upgrading a vDisk image that uses KMS volume licensing
To maintain or upgrade a vDisk image that is configured to use KMS volume licensing:
- Set the vDisk mode toPrivate Image mode.
- Stream the vDisk to a target device.
- Apply the OS/application service pack/update, then shut down the target device.
- Set the vDisk mode back toShared Image mode.
- Stream the vDisk to the target device in shared image mode.Note:If Office 2010 is installed as a vDisk update, or after the vDisk has gone through the base disk preparation process once, repeat the base disk preparation using the following procedure:
- In the Citrix Provisioning console, right-click on the vDisk, then select theFile Propertiesmenu option. ThevDisk File Propertiesdialog appears.
- Click theMicrosoft Volume Licensingtab, then change the licensing option fromKMStoNone.
- On theModetab, set the vDisk access mode toPrivate Image mode.
- PXE boot to the vDisk in private image mode to rearm.Note:OSPPPREARM.EXE must be run from an elevated command prompt.
- A message prompts you to reboot the system, DO NOT REBOOT. Instead shut down the target device.
- In the console, right-click the vDisk you are configuring, then select theFile Propertiesmenu option. ThevDisk Propertiesdialog appears.
- Click theMicrosoft Volume Licensingtab, then change the license option fromNonetoKMS.
- On theModetab, set the vDisk access mode toShared Image mode.
- Stream the vDisk to the target devices.
Maintaining or upgrading a vDisk image enabled with versioning that is currently using KMS
In this scenario, a vDisk is already configured for KMS and is deployed successfully. The disk is enabled to usevDisk versioning, so versions can exist. Consider:
- For both Microsoft Windows and Microsoft Office: A vDisk is already configured for KMS and is deployed successfully.
- For environments with only Microsoft Windows or only Microsoft Office: The vDisk is already configured for KMSOnly WindowsorOnly Officeand is deployed successfully.
To maintain or upgrade the vDisk:
- In the Citrix Provisioning console, right-click the virtual disk, and selectVersions.
- Create a disk version.
- Access the target device properties and setTypetoMaintenance.
- Start the target device.
- Access the target device machine and selectMaintenancefrom theBootmenu when prompted.
- Select the required operating system inApplication/Service Pack/Update.
- Shut down the target device.
- Access the Citrix Provisioning console, select the vDisk and right-click to display the contextual menu.
- SelectVersions. Promote the vDisk fromMaintenancetoProductionorTest.
- Access the Citrix Provisioning console. UnderTarget device properties, change theTypetoProductionorTest.
Stream the vDisk with this version to one or more target devices.
Installing Microsoft Office to an existing KMS configured vDisk during Maintenance
A vDisk already uses KMS, is configured for Microsoft Windows and is deployed successfully.
To install Microsoft Office to a vDisk during maintenance:
- In the Citrix Provisioning console, right-click on the vDisk and selectProperties.
- Select theMicrosoft Volume Licensingtab and change the licensing option fromKMStoNone.
- On theGeneraltab, set the vDisk access mode toPrivate Imagemode.
- PXE boot to the vDisk in Private Image mode to rearm:
- For Office (for 64-bit client):
Program Files(x86)\Common Files\microsoft shared\OfficeSoftwareProtectionPlatform\OSPPREARM.EXE
- For Office (for 32-bit client):
Program Files\Common Files\microsoft shared\OfficeSoftwareProtectionPlatform\OSPPREARM.EXE
- Repeat for other Windows versions: Run
cscript.exe slmgr.vbs –rearm
- For Office (for 64-bit client):
- 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 selectProperties.
- Select theMicrosoft Volume Licensingtab and change the license option fromNonetoKMS.
- On theGeneraltab, set the vDisk access mode toStandard Imagemode.
- Stream the vDisk to one or more target devices.
Tip:
You can validate the KMS configuration by verifying that the
CMID
for each device is unique. For Windows versions, runcscript.exe slmgr.vbs –dlv
. For Office versions, runC:\Program Files\Microsoft Office\Office14\cscript ospp.vbs /dcmid
.
Important information on rearm
Consider the following when rearming:
- Microsoft limits the number of times you can run rearm on an installed operating system image and Microsoft Office. The operating system and Office image must be reinstalled accordingly if you exceed the number of allowed rearm attempts.
- For a successful KMS configuration using a Citrix Provisioning vDisk, you are not required to rearm the disk except the first time when you configure it.
- Citrix recommends that you rearm the system that is started from the vDisk inPrivate Imagemode. This ensures that the rearm count of the master target device hard disk is not reduced.
Installing Microsoft Office to an existing KMS configured for a Windows vDisk
A vDisk is already configured for KMS using Microsoft Windows and is deployed successfully. To install Microsoft Office to an existing KMS that is configured for Microsoft Windows:
- In the Citrix Provisioning console, right-click the vDisk and selectProperties.
- Select theMicrosoft Volume Licensingtab and change the licensing option fromKMStoNone.
- On theGeneraltab, set thevDisk Access ModetoPrivate Imagemode.
- PXE boot to the vDisk inPrivate Imagemode to rearm. An OS rearm is required along with the Microsoft Office rearm.
- For Microsoft Windows, run
cscript.exe slmgr.vbs -rearm
. - For Microsoft Office 2010, run
%ProgramFiles%\Common Files\MicrosoftShared\OfficeSoftwareProtectionPlatform\OSPPREARM.EXE
. - For Microsoft Office 2013 and 2016, run
%ProgramFiles%\Microsoft Office\%Office%\OSPPREARM.EXE
.
- For Microsoft Windows, run
- 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 selectProperties.
- Select theMicrosoft Volume Licensingtab and change the license option fromNonetoKMS.
- On theGeneraltab, set thevDisk Access ModetoStandard Imagemode.
- Stream the vDisk to one or more target devices.
You can validate the KMS configuration by verifying that theCMID
for each device is unique. For Windows versions, runcscript.exe slmgr.vbs –dlv
. For Office versions, change the directory to%ProgramFiles%\Microsoft Office\%Office%
and then run:
cscript ospp.vbs /dcmid
cscript ospp.vbs /dstatus
. The OS and Microsoft Office discovery of KMS is independent from each other./dstatus
appears if Microsoft Office has located KMS on the network.cscript ospp.vbs /act
. This command expedites the activation process.
Upgrading Microsoft Office on an existing KMS configured for a Microsoft Windows vDisk
A vDisk is already configured for KMS that uses Microsoft Windows and Microsoft Office. To upgrade:
- In the Citrix Provisioning console, right-click on the vDisk and selectProperties.
- On theGeneraltab, set thevDisk Access ModetoPrivate Imagemode.
- Start the target device.
- Run the new Microsoft Office setup. Choose to perform an upgrade.
- Reboot the target device as required by the installation.
- Shut down the target device.
- Connect to the Citrix Provisioning Server. In the console, right-click on the vDisk and selectProperties.
- On theGeneraltab, set thevDisk Access ModetoStandard Imagemode.
- Stream the vDisk 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 Microsoft Office. The operating system and Office image must be reinstalled accordingly if you exceed the number of allowed rearm attempts.
- For Windows and Office products utilizing KMS activation, the available rearm count increments from 0 to 1 on a successful activation against a KMS host server.
- 如果你的枪支泛滥,激活用公里S host lets you rearm once. This ensures that once you activate a KMS client, they can issue a rearm. For example, a KMS client with a rearm count of 1 issues a rearm using the remaining single rearm, and reboots. Upon reboot after the KMS client activates, the rearm count will return to a count of 1.
Tip:
A successful KMS configuration for a Citrix Provisioning vDisk does not require you to rearm the vDisk except the first time when it is configured.
Configuring Microsoft MAK volume licensing
This section describes the use of Multiple Activation Keys (MAK). A MAK corresponds to some purchased OS licenses. The MAK is entered during the installation of the OS on each system. The installation activates the OS and decrements the count of purchased licenses centrally with Microsoft. Alternatively, a process ofproxy activationis done using the Volume Activation Management Toolkit (VAMT). Proxy activation works on systems that do not have access to the Internet. Citrix Provisioning applies this proxy activation mechanism for standard image mode vDisks that have the MAK licensing mode selected when creating the disk.
激活量管理工具(VAMT)中on 3.1 must be installed and configured on all provisioning servers within a farm. This tool is available from the Microsoft Windows Assessment and Deployment Kit (Windows ADK). For more information, seeInstall VAMT.
When you first run the VAMT, a VAMT database is created. This database caches all device activations and allows for the reactivation of Citrix Provisioning.
Volume Activation Management Tool 3.1 requires:
- PowerShell 3.0 or later – the OS is newer than Windows Server 2012 or Windows 8
- SQL 2012 express or newer
Citrix供应MAK交流tivation requires you to configure one of three user types:
- Volume Activation Management Tool/Provisioning Services installation user— This user is a local administrator possessing rights on SQL 2012 or newer (VAMT 3.1 requirement). These rights are used to create a database for VAMT.
- MAK user— The user defined in the site’s properties. This user handles the MAK activation on both server and client side. This user is a local administrator on both the provisioning server and the master client. This user requires full access to the VAMT database.
- Citrix Provisioning SOAP/stream services user— the stream process handles the reactivation when the target device restarts. This user requires read access to the VAMT database.
Provisioning servers use PowerShell to interface with the VAMT. These manual configuration steps are required one time per server:
- Install PowerShell 3.0 or later.
- Install VAMT 3.1 on every provisioning server system using a Volume Activation Management Tool/Provisioning Services installation user.
- Configure a VAMT database as prompted during the initial run of VAMT 3.1. Make this database accessible to all provisioned servers used to stream VAMT activated Citrix Provisioning target devices.
- If the user who created the VAMT database is not the SOAP/stream service user, copy the VAMT configuration file
C:\\Users\\\
to\\AppData\\Roaming\\Microsoft\\VAMT\\VAMT.config C:\\Users\\\
.\\AppData\\Roaming\\Microsoft\\VAMT\\VAMT.config - Set the provisioning server security configuration to use PowerShell to interface with VAMT.
- Set-ExecutionPolicy -Scope \ (the Provisioning Services services user) tounrestricted– seeSet-ExecutionPolicyfor more information.
- WinRM quickconfig.
- Enable-WSManCredSSP -Role Client -DelegateComputer
-Force - Enable-WSManCredSSP -Role Server –Force.
- Configure the Windows firewall on the client for VAMT 3.1 – seeConfigure Client Computersfor more information. Citrix Provisioning target devices cannot be activated or reactivated if the firewall is not configured for VAMT.
Common activation errors
Error: Failed to create PSSession — Reason: MAK user is not a local administrator on the Citrix Provisioning server.
Error:Index was out of range. Must be non-negative and less than the size of the collection. Parameters name: Index.
Reason:MAK user does not have full access (read\write) permission to the VAMT database.
Setting the vDisk licensing mode for MAK
A vDisk can be configured to use Microsoft Multiple Activation Key (MAK) licensing when running theImaging Wizard. If MAK licensing was not configured when running the Imaging Wizard, the vDisk’s licensing mode property can be set using the console, MCLI, or PowerShell user interface. The licensing mode is set before activating target devices.
Note:For information on using the command-line interfaces, see the MCLI or PowerShell Programmers Guide.
Entering MAK user credentials
Before target devices that use MAK-enabled vDisks can be activated, MAK user credentials must be entered for a site.
Note:The user must have administrator rights on all target devices that use MAK-enabled vDisks, and on all Provisioning Servers that stream the vDisks to target devices.
To enter credentials:
- Right-click on the site where the target devices exist, then select thePropertiesmenu option.
- On theMAKtab, enter the user and password information in the appropriate text boxes, then clickOK.
Activating target devices that use MAK-enabled vDisks
After a vDisk is configured for MAK volume licensing, each target device assigned to the vDisk must be activated with a MAK.
Note:After all licenses for a given MAK are used, a new key is required to allow more target devices to share this vDisk image.
To activate target devices that use MAK volume licensing from the Console:
Boot all target devices that are to be activated.
In the Console, right-click on the collection or view of the individual device including those target devices requiring MAK license activation. Select theManage MAK Activations…menu option. TheManage MAK Activationsdialog appears.
In theMultiple activation keytext box, enter theMAKto activate the target devices.
The number of booted target devices requiring activation display on the dialog. From the list of booted devices, check the box next to each target device that you want to activate.
ClickOKto activate licensing for all selected target devices. Do not close the dialog until the activation process is completed. The process can be stopped by clicking theCancelbutton. Closing the dialog before the activation process completes stops the process might result in some target devices not being activated. TheStatus columnindicates if a target device is being activated or failed. If all target devices were activated successfully, clickOKto close the dialog. If one or more target devices are not activated, or if devices were not activated successfully, the dialog displays any unactivated devices. After resolving any issues, repeat this step to activate the remaining target devices.
Note:
TheManage MAK Activationsoption does not display after all currently booted target devices have been successfully activated.
Maintaining MAK activations
Typically, devices and their assigned vDisk activations are preserved automatically. When a different target device is assigned a MAK activated vDisk, it removes any saved existing MAK reactivation information. If the vDisk is reassigned in the future, the target device fails to reactivate. To prevent the loss of MAK activation, do not unassign the activated disk from the target device.
To change a target device’s vDisk, without losing the MAK activation, select one of the following methods:
- Assign more vDisks to the target device, without removing any, then set the default booting vDisk accordingly.
- Assign more vDisks to the target device and temporarily disable the MAK activated vDisk.
For you to update a MAK activated vDisk, theAuto Updatefeature must be used so that the MAK activation information is maintained. This process is required for the shared device reactivation.
More MAK considerations:
- Manual vDisk updates (unassigning one vDisk and reassigning another vDisk) results in the loss of the required MAK activation information. This process requires a new activation, which would consume another license.
- Using auto update to deploy a new vDisk from a different OS results in mismatched MAK activation information. In this case, a new activation must be performed from the command line interface, as only unactivated target devices can be activated from the Citrix Provisioning console.
In this article
- Using MCLI and SOAP server command line interfaces for Microsoft volume licensing
- Configuring Microsoft KMS volume licensing
- Configuring Microsoft MAK volume licensing
- Setting the vDisk licensing mode for MAK
- Entering MAK user credentials
- Activating target devices that use MAK-enabled vDisks
- Maintaining MAK activations