Configure the Palo Alto Networks Terminal Services Agent for User Mapping
Use the following procedure to install and configure the TS agent on the terminal server. To map all your users, you must install the TS agent on all terminal servers that your users log in to.
- If you are using version 7.0 or later of the TS agent, make sure to disable any Sophos anti-virus software on the TS agent host. Otherwise, the source ports allocated by the TS agent will be overwritten.
- If you are installing the TS agent version 8.0 or later on a Windows Server 2008 R2, download and install the security advisory patchon the server before installing the TS agent. Otherwise, the TS agent service fails to launch with the following error written to the logs: service fails with error 577.
For information about the supported terminal servers supported by the TS Agent, refer to the Palo Alto Networks Compatibility Matrix.
- Download the TS agent installer.
- Log in to the Palo Alto Networks Customer Support Portal.
- Select UpdatesSoftware Updates.
- Set Filter By to Terminal Services Agent and select the version of the agent you want to install from the corresponding Download column. For example, to download the 8.1 version of the agent, select TaInstall-8.1.1.msi.
- Save the TaInstall.x64-x.x.x-xx.msi or TaInstall-x.x.x-xx.msi file (be sure to select the appropriate version based on whether the Windows system is running a 32-bit OS or a 64-bit OS) on the systems where you plan to install the agent.
- Run the installer as an administrator.
- Open the Windows Start menu, right-click the Command Prompt program, and select Run as administrator.
- From the command line, run the .msi file you downloaded.
For example, if you saved the .msi file to the Desktop you would
enter the following:
- Follow the setup prompts to install the agent using the default settings. By default, the agent gets installed to the C:\Program Files (x86)\Palo Alto Networks\Terminal Server Agent folder, but you can Browse to a different location.
- When the installation completes, Close the
setup window.If you are upgrading to a TS Agent version that has a newer driver than the existing installation, the installation wizard prompts you to reboot the system after upgrading in order to use the new driver.
- Define the range of ports for the TS Agent to allocate
to end users.The System Source Port Allocation Range and System Reserved Source Ports fields specify the range of ports that will be allocated to non-user sessions. Make sure the values specified in these fields do not overlap with the ports you designate for user traffic. These values can only be changed by editing the corresponding Windows registry settings. The TS agent does not allocate ports for network traffic emitted by session 0.
- Open the Windows Start menu and select Terminal Server Agent to launch the Terminal Services agent application.
- Select Configure in the side menu.
- Enter the Source Port Allocation Range (default 20000-39999). This is the full range of port numbers that the TS agent will allocate for user mapping. The port range you specify cannot overlap with the System Source Port Allocation Range.
- (Optional) If there are ports/port ranges within the source port allocation that you do not want the TS Agent to allocate to user sessions, specify them as Reserved Source Ports. To include multiple ranges, use commas with no spaces, for example: 2000-3000,3500,4000-5000.
- Specify the number of ports to allocate to each individual user upon login to the terminal server in the Port Allocation Start Size Per User field (default 200).
- Specify the Port Allocation Maximum Size Per User, which is the maximum number of ports the Terminal Services agent can allocate to an individual user.
- Specify whether to continue processing traffic from the user if the user runs out of allocated ports. By default, the Fail port binding when available ports are used up is selected, which indicates that the application will fail to send traffic when all ports are used. To enable users to continue using applications when they run out of ports, clear this check box. Keep in mind that this traffic may not be identified with User-ID.
- (Optional) Assign your own certificates for
mutual authentication between the TS agent and the firewall.
- Obtain your certificate for the TS agent
for your enterprise PKI or generate one on your firewall. The private
key of the server certificate must be encrypted. The certificate
must be uploaded in PEM file format.
- Generate a Certificate and export it for upload to the TS agent.
- Export a certificate from your enterprise certificate authority (CA) and the upload it to the TS agent.
- Add a server certificate to TS agent.
- On the TS agent, select Server Certificate and click Add.
- Enter the path and name of the certificate file received from the CA or browse to the certificate file.
- Enter the private key password.
- Click OK and then Commit.
- Configure and assign the certificate profile for the
- Select DeviceCertificate ManagementCertificate Profile to Configure a Certificate Profile.You can only assign one certificate profile for Windows User-ID agents and TS agents. Therefore, your certificate profile must include all certificate authorities that issued certificates uploaded to connected Windows User-ID and TS agents.
- Select DeviceUser IdentificationConnection Security and click the edit button to assign the certificate profile.
- Select the certificate profile you configured in the previous step from the User-ID Certificate Profile drop-down.
- Click OK.
- Commit your changes.
- Obtain your certificate for the TS agent for your enterprise PKI or generate one on your firewall. The private key of the server certificate must be encrypted. The certificate must be uploaded in PEM file format.
- Configure the firewall to connect to the Terminal Services
agent.Complete the following steps on each firewall you want to connect to the Terminal Services agent to receive user mappings:
- Select DeviceUser IdentificationTerminal Server Agents and click Add.
- Enter a Name for the Terminal Services agent.
- Enter the IP address of the Windows Host on
which the Terminal Services agent is installed.When you configure a TS agent connection, the Best Practice is to set the Host and any Alternative IP Addresses to a static IP address that never changes or to an FQDN that resolves to a static IP address.
- Enter the Port number on which the agent will listen for user mapping requests. This value must match the value configured on the Terminal Services agent. By default, the port is set to 5009 on the firewall and on the agent. If you change it here, you must also change the Listening Port field on the Terminal Services agent Configure screen.
- Make sure that the configuration is Enabled and then click OK.
- Commit the changes.
- Verify that the Connected status displays as connected (a green light).
- Verify that the Terminal Services agent is successfully
mapping IP addresses to usernames and that the firewalls can connect
to the agent.
- Open the Windows Start menu and select Terminal Server Agent.
- Verify that the firewalls can connect by making sure the Connection Status of each firewall in the Connection List is Connected.
- Verify that the Terminal Services agent is successfully mapping port ranges to usernames by selecting Monitor in the side menu and making sure that the mapping table is populated.
- (Windows 2012 R2 servers only) Disable Enhanced
Protected Mode in Microsoft Internet Explorer for each user who
uses that browser.This task is not necessary for other browsers such as Google Chrome or Mozilla Firefox.Perform these steps on the Windows Server:
- Start Internet Explorer.
- Select Internet optionsAdvanced and scroll down to the Security section.
- Clear Enable Enhanced Protected Mode.
- Click OK.In Internet Explorer, Palo Alto Networks recommends that you do not disable Protected Mode, which differs from Enhanced Protected Mode.
Configure User Mapping for Terminal Server Users
Configure User Mapping for Terminal Server Users Individual terminal server users appear to have the same IP address and therefore an IP address-to-username mapping is ...
Retrieve User Mappings from a Terminal Server Using the PAN...
Retrieve User Mappings from a Terminal Server Using the PAN-OS XML API The PAN-OS XML API uses standard HTTP requests to send and receive data. ...
Device > User Identification > Terminal Services Agents
Device > User Identification > Terminal Services Agents On a system that supports multiple users who share the same IP address, a Terminal Services (TS) ...
Port Mapping In environments with multi-user systems—such as Microsoft Terminal Server or Citrix environments—many users share the same IP address. In this case, the user-to-IP ...
Ports Used for User-ID
Ports Used for User-ID User-ID is a feature that enables mapping of user IP addresses to usernames and group memberships, enabling user- or group-based policy ...
Install the Windows-Based User-ID Agent
Install the Windows-Based User-ID Agent The following procedure shows how to install the User-ID agent on a member server in the domain and set up ...
Want to know if there are any addressed issues related to the Windows User-ID™ agent 8.1 release? ...
Want to know if there are any issues addressed in a Terminal Services (TS) agent 8.1 release? ...