MCS Microsoft Office Rearm Error

book

Article ID: CTX212449

calendar_today

Updated On:

Description

Reported failures:

  • Rearm count exceeded
  • Rearm failure
  • Rearm Warning on machine catalog

 

Environment

"The above mentioned sample code is provided to you as is with no representations, warranties or conditions of any kind. You may use, modify and distribute it at your own risk. CITRIX DISCLAIMS ALL WARRANTIES WHATSOEVER, EXPRESS, IMPLIED, WRITTEN, ORAL OR STATUTORY, INCLUDING WITHOUT LIMITATION WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NONINFRINGEMENT. Without limiting the generality of the foregoing, you acknowledge and agree that (a) the sample code may exhibit errors, design flaws or other problems, possibly resulting in loss of data or damage to property; (b) it may not be possible to make the sample code fully functional; and (c) Citrix may, without notice or liability to you, cease to make available the current version and/or any future versions of the sample code. In no event should the code be used to support ultra-hazardous activities, including but not limited to life support or blasting activities. NEITHER CITRIX NOR ITS AFFILIATES OR AGENTS WILL BE LIABLE, UNDER BREACH OF CONTRACT OR ANY OTHER THEORY OF LIABILITY, FOR ANY DAMAGES WHATSOEVER ARISING FROM USE OF THE SAMPLE CODE, INCLUDING WITHOUT LIMITATION DIRECT, SPECIAL, INCIDENTAL, PUNITIVE, CONSEQUENTIAL OR OTHER DAMAGES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Although the copyright in the code belongs to Citrix, any distribution of the sample code should include only your own standard copyright attribution, and not that of Citrix. You agree to indemnify and defend Citrix against any and all claims arising from your use, modification or distribution of the sample code."

Cause

The rearm process used during preparing MCS image is primarily applicable to traditional versions of Microsoft Office (like Office 2010, 2013, and 2016) that utilize KMS activation. 

The MCS (Machine Creation Services) does not support the activation method of Office 365 due to the lack of a rearm process. When attempting to create a Machine Catalog with Office 365 installed, errors related to Office Rearm Failure may occur because the system looks for a rearm that cannot be found .

You can Exclude officeRearm from the provisioning scheme if not using KMS version of MS office in the image.

Resolution

      • Some Microsoft Office runtimes can cause the office rearm to be invoked, resulting in a failure

      OR

      • A KMS version of Microsoft Office is not installed.


      The Machine Catalog Provisioning Scheme can be reconfigured to skip the office rearm step using PowerShell.

      If the environment control plane uses on-prem DDCs use PowerShell on the DDC. If the environment control plane is DAAS use PowerShell with the Citrix DaaS™ Remote PowerShell SDK.

      1. Identify the machine catalog ProvScheme UID of interest, by listing all ProvScheme names and associated UIDs
        • get-provscheme | select ProvisioningSchemeName,ProvisioningSchemeUid
        • image.png
      2. Output the configuration of this ProvScheme and exam the MetaData value, checking for ImageManagementPrep_Excluded_Steps
        • get-provscheme -ProvisioningSchemeUid <Provscheme UID of interest>
        • image.png
      3. Configure the ProvScheme to skip office rearm
        • Set-ProvSchemeMetadata -ProvisioningSchemeUid <Provscheme UID of interest> -Name ImageManagementPrep_Excluded_Steps -Value OfficeRearm
      4. Output the configuration of this ProvScheme and exam the MetaData value and confirm ImageManagementPrep_Excluded_Steps now includeds OfficeRearm
        • get-provscheme -ProvisioningSchemeUid <Provscheme UID of interest>
        • image.png

       

       

Issue/Introduction

MCS supports KMS versions of Office and as part of the preparation stage, office is rearmed.

There can be a number of KMS rearm failures that can happen during the Office rearm stage.

Additional Information

Citrix DaaS Remote PowerShell SDK

https://docs.citrix.com/en-us/citrix-daas/sdk-api#citrix-daas-remote-powershell-sdk