In this article:
|
About installing the Unidesk Agent |
The Unidesk Agent enables the Unidesk Enterprise Layer Manager (ELM) or a Unidesk Packaging Machine VM to run PowerShell commands locally. If you supply the proper credentials, the agent can run PowerShell commands as a specific user.
The Unidesk Agent is required in cases where one of your Connector Configurations launches a PowerShell script. This includes Connector Configurations you use to:
The Unidesk Agent installer prompts you to register the agent with a Unidesk ELM. If you do not register the agent during installation, you can manually register it later. However, keep in mind that the PowerShell scripts will not run until the agent is registered with the ELM.
Before you install the Unidesk Agent, you must have the following requirements on the system where you are installing the Unidesk Agent:
An account with administrator privileges
.NET 4.5
PowerShell 3.0 or greater
PowerShell Snap-in
Before using the Unidesk Agent on a PVS server you must ensure the PowerShell Snap-in is installed. This is a manual step.
For PVS 7.7 and later, you must install the Powershell Snap-in Citrix.PVS.Snapin.dll.
For PVS 7.6 and PVS 7.1, you must install McliPSSnapIn.dll. Use the installutil.exe to install the Snap-in.
Example (7.6):
From a command prompt, go to:
c:\program files\citrix\provisioning services console
Run this command:
"C:\Windows\Microsoft.NET\Framework64\v4.0.30319\InstallUtil.exe" McliPSSnapIn.dll
Example (7.7):
From a command prompt, go to:
c:\program files\citrix\provisioning services console
Run this command:
"C:\Windows\Microsoft.NET\ Framework64\v4.0.30319\InstallUtil.exe" Citrix.PVS.snapin.dll
On Windows 2008 R2, you must also enable PowerShell remote commands. For background information, see this Microsoft article:
https://technet.microsoft.com/en-us/library/hh849694.aspx
If your 2008 R2 OS does not have PowerShell remoting enabled, run the following PowerShell command on the PVS server:
Enable-PSRemoting
Log in as an administrator on the system where you are installing the agent.
Download the Unidesk Agent from the Unidesk Download page.
Copy the Unidesk_agent_installer.exe file from the Unidesk Agent folder to a convenient location on the PVS server.
Run the Unidesk_agent_installer.exe as Administrator, and when prompted, enter the path to the directory where you want to install the Unidesk Agent. The default location is C:\\Program Files (x86)\Unidesk\Agent.
The Unidesk Agent installer checks to see if all Prerequisites are present. If any prerequisites are missing, the installer reports this and exits without installing.
The installer prompts you for an Agent Port number. You can accept the default port number (8016) or specify a different one if the default port is already in use.
The installer prompts you for the credentials (address, username, and password) for your Unidesk ELM. Register the Unidesk Agent with the ELM by entering the IP address and login credentials for a Unidesk Management Console (UMC) user on the ELM with Administrator privileges, (for example, the credentials you use to log into the UMC).
Note: If the Unidesk ELM is not available yet or you choose not to register with it now, you can manually register at a later time using the procedure described in Register with the Unidesk ELM manually.
Click Finish to exit the wizard.
The Unidesk Agent registration appears in the Audit log for the Management Service in the Unidesk Management Console.
If the Unidesk Agent was not registered with a Unidesk ELM during installation, you can register it later by using the following procedure.
To manually register the Unidesk Agent with the ELM:
As an administrator, log in to the server where you installed the Unidesk Agent.
Open a command window (cmd.exe) as administrator and navigate to the directory where the Unidesk Agent is installed. (The default location is C:\\Program Files (x86)\Unidesk\Agent.)
Run the following command, using the IP address of the ELM where indicated:
Unidesk.Agent.Service.exe register /i /e:IP_address_of_ELM /u:Administrator
When prompted, enter the password for a user who has Administrator privileges in the Unidesk Management Console (UMC) on the ELM.
When the registration process completes, a message appears informing you of the successful outcome. The Unidesk Agent registration appears in the Audit log for the Management Service in the UMC.
If the process does not succeed, examine the \Unidesk\Agent\Logs\unidesk.agent.log file in the Unidesk Agent installation directory. You can also view Help for the Unidesk Agent command line options by running the following command: Unidesk.Agent.Service.exe /?.