App to quickly add Physical Machines into a VMware Horizon Manual Pool and entitle users
There is no support for this tool - it is provided as-is
Please provide any feedback directly to me - my contact information:
Chris Halstead - Staff Architect, VMware
Email: chalstead@vmware.com
Twitter: @chrisdhalstead
Updated March 20, 2020
- 1.8 - March 23, 2020
- Allows user to continue if the Horizon Server certificate has expired
- Click yes to continue
- Before would not allow the user to proceed.
- Allows user to continue if the Horizon Server certificate has expired
- Download the latest version of HorizonUnmanagedMachines.exe
Opens in YouTube
This app is used to quickly add physical machines that have a Horizon agent installed and registered to a connection server to a manual pool and entitle the desktop and pool. The app reads from a .csv file and checks to see if the specific machine is available and if so it adds it to the selected pool. The app can be used to create a manual pool to use with unregistered machines.
if you are processing many machines, it would be recommended to setup a dedicated connection server in the pod if you can to run these processes against so other servers are not affected.
Please review the logfile that was created after an import - there are lots of details on what was done
- All connections to Horizon via REST
- Certificate Validation
- Multi-threaded
- Logging and Error Trapping
- Manual Pool Creation
- Shows live progress
- .NET Framework 4.6.1 or later
- Windows Operating System
- Horizon 7.7 or later (Official Horizon support added - prior versions may work just not supported)
- Admin Credentials to Horizon Connection Server
-
Download and Run
HorizonUnmanagedMachines.exe
from this repository -
Enter the Horizon Connection Server FQDN and click Connect
-
Enter Username, Password and Domain and Click OK - the first time you connect you will be asked to accept the certificate on the Horizon server
-
If you have no manual pools that are configured for unmanaged machines - you will see the following prompt:
The app will create a manual pool that is configured for use with unregistered machines. Click OK to continue.
-
Enter a Pool Name, and optionally a display name. This is what users will see if the Horizon Client. If you leave it blank, users will see the name of the pool. Select a default protocol (users will be able to change on the client), select an access group and choose if you would like HTML access and Session Collaboration (Blast only). Click ok to create the pool. Click OK twice to confirm pool creation and on the box to show the pool is complete.
You will now see the pool under Pool Name - this dropdown will show all manual pools that are configured for unmanaged machines
In the Horizon Console, you can identify pools created by this tool by looking at the description.
-
Create .CSV File
- This file should contain physical devices which have been registered with the Horizon Connection Server (See More in "Installing Horizon Agent on Physical" below) and the user to associate with the desktop. This user will have a direct entitlement added to the desktop and one added to the pool. the username must be formatted as domain\username.
- The format of the CSV file should be as follows:
- Header Line: Machine,User
- Data: mydesktop,domain\user
-
Import CSV file
- Click the "Import Mappings from .CSV button" - select the .CSV and click Open. There are several validations that happen during the import process. There is a maximum of 2000 items that can be imported at a time. 2000 is the maximum size of a pool in Horizon, so if you have more that 2000 devices to import them should be broken up into .csv files of less that 2000 each.
-
Once you have imported the data you are ready to add the machines to the selected pool and entitle them. Click "Add Machines and Entitle". Click yes on the message box to start the process. The listview will be updated live as action are done in Horizon
You will see the success or failure of the following actions:
*Adding Machine to Pool *Adding an entitlement for the user to the desktop *Adding an entitlement for the user to the pool
-
The process is finished - you can view the log file to see exactly what happened. It is called Horizon_Manual[date].log. It is located in the %temp% directory.
-
The actions can also be verified in the Horizon Console
-
Additional manual pools can be created at any time by clicking the "Create Manual Pool" Button.
-
You can export the results returned to a CSV to review the process by right-clicking the results pane
You can use the tool that Andrew Morgan developed that installs the Agent and creates the .csv file that this utility needs or use any tool for distributing software such as SCCM. This app will push the Horizon Agent and install it via PSRemoting and will adjust power policies. It is in active development and he is adding wake on lan in a future release. Andrew was awesome to brainstorm with on trying to tackle this process.
Install string for installing the Horizon Agent as unmanaged and register to a connection server:
VMware-Horizon-Agent-x86_64-7.XX.0-XXXX.exe /s /v” /qn VDM_VC_MANAGED_AGENT=0 VDM_SERVER_NAME=<connserver> VDM_SERVER_USERNAME=<domain\username> VDM_SERVER_PASSWORD=<pw>”
- 1.0 - March 15, 2020
- Initial Release
- 1.1 - March 16, 2020
- Fixed an issue where the CSV contains the quote character - if found, remove it.
- 1.2 - March 16, 2020
- Prevent a user from being assigned two machines in a pool
- Fix some API queries that sometimes caused 400 errors
- Other UI fixes
- 1.3 - March 17, 2020
- Fix when usernames are similar (ex chalstead and chalstead-adm) - before it would grab the first one that matched (chalstead in this case) causing issues
- Cache 2000 domain users to speed up entitlement
- 2000 is the maximum that can be returned (no pagination support).
- The 7.12 REST API may be able to return more - looking into that as a option
- Persist connection server name, username and domain name in the registry
- More logging detail
- Optimized adding machines and entitlements
- UI Fixes
- Hid Pool Details dialog as results were inconsistent across versions of Horizon
- 1.4 - March 17, 2020
- Fixed "An item with the same key has already been added" error
- Generate the new machine name Base64 value directly without making an expensive API call
- After added to pool
- Fixed AD Caching - note: It will pause for 3 seconds while that query is run
- If a user is not found, but the desktop is - the desktop will be added to the pool
- 1.5 - March 18, 2020
- Fixed Issue when creating pool and immediately importing into it
- 400 errors
- Optimized create manual pool flow
- Added the name of the call that is made to the API to message box and log for easier troubleshooting
- Fixed Issue when creating pool and immediately importing into it
- 1.6 - March 19, 2020
- Added button to export registered machines to .csv
- Machines not assigned to a pool
- Added button to export registered machines to .csv
- 1.7 - March 20, 2020
- Added ability to right-click the results pane to export the results of importing machines and entitling users to a CSV file
- Windows 7 may work with the RDP protocol
- Connecting to View desktops using RDP protocol fails with the error code 2825