Citrix Workspace Environment Management puppet module

This modules install an enterprise production grade Citrix Workspace Environment Management 4.5 broker, including WEM database creation and administrator rights setup.

The following options are available for a production-grade installation :

Fault tolerance : AlwaysOn database membership activation for Citrix WEM database

Requirements

The minimum Windows Management Framework (PowerShell) version required is 5.0 or higher, which ships with Windows 10 or Windows Server 2016, but can also be installed on Windows 7 SP1, Windows 8.1, Windows Server 2008 R2 SP1, Windows Server 2012 and Windows Server 2012 R2.

This module requires SQLServer powershell module v21.0.17199. The module will install this dependancy :

From Powershell Gallery if sqlservermodulesource parameter is set to internet
From an enterprise location if sqlservermodulesource parameter is set to offline. In this case, the ZIP file containing the SQLServer v21.0.17199 (sqlserver_powershell_21.0.17199.zip) has to be manually downloaded from Powershell Gallery using the Save-Module -Name SqlServer -Path <path> -RequiredVersion 21.0.17199 powershell command.

This module requires a custom version of the puppetlabs-dsc module compiled with CitrixWemDsc as a dependancy. Ready to use module provided on Github.

Change log

A full list of changes in each version can be found in the change log.

Integration informations

The Citrix WEM database will be installed in the default MSSQLSERVER SQL Server instance. This module does not provide the capability to install the databases in another SQL intance.

The database failover mecanism integrated in this module is SQL Server AlwaysOn.

The module can be installed on a Core, Standard, Datacenter version of Windows 2012R2 or Windows 2016. Core OS is now supported by Citrix Workspace Environment Management.

Warning : Automated installation of ‘Infrastructure Services’ and ‘Management Console’ WEM 4.5 EXE installers will make the first two puppet runs fail. Asynchronous installation of dependencies make the the first EXE file exit just after extracting and running dependencies. At this step, Puppet or Powershell can’t verify that the software is in desired state and throw an error. Start a new Puppet run which will detect the installed software and continue the run.

Usage

[String] setup_svc_username (Required): Privileged account used by Puppet for installing the software and creating the service account (spn creation, computer registration, local administrator privileges needed)
[String] setup_svc_password (Required): Password of the privileged account. Should be encrypted with hiera-eyaml.
[String] infrastructureservicessourcepath (Required): Path of the WEM infrastructure services installer EXE file. Can be a local or an UNC path.
[String] infrastructureservicesproductid (Optional): WEM infrastructure service EXE installer ProductID. The following line of code will list all products installed, including their name and IdentifyingNumber, which is the same as the ProductID Get-WmiObject Win32_Product | Format-Table IdentifyingNumber, Name, Version. Default is 40BF3158-89BA-44A4-96B0-6D806FFD5AA3 for WEM 4.5 installation.
[String] managementconsolesourcepath (Required): Path of the WEM management console installer EXE file. Can be a local or an UNC path.
[String] managementconsoleproductid (Optional): WEM management console EXE installer ProductID. The following line of code will list all products installed, including their name and IdentifyingNumber, which is the same as the ProductID Get-WmiObject Win32_Product | Format-Table IdentifyingNumber, Name, Version. Default is 0FC446DF-9BE8-4808-A838-208C2D80A2EC for WEM 4.5 installation.
[String] sqlservermodulesource (Optional, [internet,offline]): Source of SQLServer Powershell module v21.0.17199 (see requirements at the beginning of this readme). Valid values are internet or offline. Default is ‘internet’.
[String] sqlservermodulesourcepath (Optional if sqlservermodulesource = ‘internet’ ): Path of the SQLServer Powershell module v21.0.17199 ZIP file. Can be a local or an UNC path.
[String] wem_svc_username (Required): Windows service account of WEM infrastructure service.
[String] wem_svc_password (Required): Password of the service account of WEM infrastructure service. Should be encrypted with hiera-eyaml.
[String] defaultadministratorsgroup (Required): Citrix WEM default administrators group. Should be a valid Active Directory group.
[String] vuemusersqlpassword (Required): Specific password for the Citrix WEM vuemUser SQL user account.
[String] databaseserver (Required): Microsoft SQL Server hostname hosting the WEM database.
[String] databasename (Required): Citrix WEM database name.
[String] databasefilesfolder (Required): Path to the data and log files location on the SQL Server. You must provide a valid filepath on the database server, otherwise the puppet run will fail.
[Boolean] sqlalwayson (Optional): Activate Citrix WEM database AlwaysOn availability group membership ? Default is false. Needs to be true for a production grade environment.
[String] sqlavailabilitygroup (Optional if sqlalwayson = false): Name of the SQL Server Availability group on which to add the Citrix WEM database.
[String] sqldbbackuppath (Optional if sqlalwayson = false): UNC path of a writable network folder to backup/restore databases during AlwaysOn availability group membership configuration. Needs to be writable from the SQL Server nodes. Has to be prefixed with \\ instead of the classical \ if using Puppet >= 4.x or Puppet 3.x future parser.
[String] citrixlicenseserver (Required): Citrix License Server name. A valid Citrix license file is required to run Citrix Workspace Environment Management infrastructure services.
[Boolean] loadbalandedwem (Optional): Are multiple WEM broker deployed behind a loat balancer ? Default is false. Needs to be true for a production grade environment.
[String] loadbalancedwemfqdn (Optional if loadbalandedwem = false): If Citrix WEM is deployed behind a load-balancer, FQDN associated to the WEM virtual-ip configured in the load balancer.

Installing a Citrix Workspace Environment Management broker

node 'WEM' {
  class{'wembroker':
    setup_svc_username               =>'DOMAIN-TEST\Administrator',
    setup_svc_password               =>'P@ssw0rd',
    infrastructureservicessourcepath => '\\\\fileserver.local\sources\Workspace-Environment-Management-v-4-05-00\Citrix Workspace Environment Management Infrastructure Services Setup.exe',
    infrastructureServicesProductId  => '6F9F03C1-C707-4148-B45D-8DF3AE0033DC',
    managementconsolesourcepath      => '\\\\fileserver.domain-test.com\sources\Workspace-Environment-Management-v-4-05-00\Citrix Workspace Environment Management Console Setup.exe',
    managementconsoleproductid       => 'EB282EB6-C33F-4DB7-AEDA-B8F672347987',
    sqlservermodulesource            => 'offline',
    sqlservermodulesourcepath        => '\\\\fileserver.domain-test.com\sources\sqlserver_powershell_21.0.17199.zip',
    wem_svc_username                 => 'svc-wem-puppet',
    wem_svc_password                 => 'P@ssw0rd',
    defaultadministratorsgroup       =>'DOMAIN-TEST\Domain Admins',
    vuemusersqlpassword              =>'P@ssw0rd',
    databaseserver                   =>'CLDB01LI.domain-test.com',
    databasename                     =>'CitrixWEMPuppet01',
    databasefilesfolder              =>'c:\\Program Files\\Microsoft SQL Server\\MSSQL13.MSSQLSERVER\\MSSQL\\Data',
    citrixlicenseserver              =>'SRV-LIC01.domain-test.com',
    loadbalandedwem                  => true,
    loadbalancedwemfqdn              => 'wem.domain-test.com',
  }
}

Citrix Workspace Environment Management (WEM) puppet module