End-of-Life (EoL)

Configure the Windows-Based User-ID Agent for User Mapping

The Palo Alto Networks User-ID agent is a Windows service that connects to servers on your network—for example, Active Directory servers, Microsoft Exchange servers, and Novell eDirectory servers—and monitors the logs for login events. The agent uses this information to map IP addresses to usernames. Palo Alto Networks firewalls connect to the User-ID agent to retrieve this user mapping information, enabling visibility into user activity by username rather than IP address and enables user- and group-based security enforcement.
For information about the server OS versions supported by the User-ID agent, refer to “Operating System (OS) Compatibility User-ID Agent” in the User-ID Agent Release Notes.
  1. Define the servers the User-ID agent will monitor to collect IP address to user mapping information.
    The User-ID agent can monitor up to 100 servers, of which up to 50 can be syslog senders.
    To collect all of the required mappings, the User-ID agent must connect to all servers that your users log in to in order to monitor the security log files on all servers that contain login events.
    1. Open the Windows
      menu and select
      User-ID Agent
    2. Select
      User Identification
    3. In the
      section of the screen, click
    4. Enter a
      Server Address
      for the server to be monitored. The network address can be a FQDN or an IP address.
    5. Select the
      Server Type
      Microsoft Active Directory
      Microsoft Exchange
      Novell eDirectory
      , or
      Syslog Sender
      ) and then click
      to save the server entry. Repeat this step for each server to be monitored.
    6. (
      ) To enable the firewall to automatically discover domain controllers on your network using DNS lookups, click
      Auto Discover
      Auto-discovery locates domain controllers in the local domain only; you must manually add Exchange servers, eDirectory servers, and syslog senders.
    7. (
      ) To tune the frequency at which the firewall polls configured servers for mapping information, select
      User Identification
      the Setup section. On the
      Server Monitor
      tab, modify the value in the
      Server Log Monitor Frequency (seconds)
      field. Increase the value in this field to 5 seconds in environments with older Domain Controllers or high-latency links.
      Ensure that the
      Enable Server Session Read
      setting is not selected. This setting requires that the User-ID agent have an Active Directory account with Server Operator privileges so that it can read all user sessions. Instead, use a syslog or XML API integration to monitor sources that capture login and logout events for all device types and operating systems (instead of just Windows), such as wireless controllers and Network Access Controllers (NACs).
    8. Click
      to save the settings.
  2. Specify the subnetworks the Windows User-ID agent should include in or exclude from User-ID.
    By default, the User-ID maps all users accessing the servers you are monitoring.
    As a best practice, always specify which networks to include and exclude from User-ID to ensure that the agent is only communicating with internal resources and to prevent unauthorized users from being mapped. You should only enable User-ID on the subnetworks where users internal to your organization are logging in.
    1. Select
      User Identification
    2. Add
      an entry to the Include/Exclude list of configured networks and enter a
      for the entry and enter the IP address range of the subnetwork in as the
      Network Address
    3. Select whether to include or exclude the network:
      • Include specified network
        —Select this option if you want to limit user mapping to users logged in to the specified subnetwork only. For example, if you include, the agent maps the users on that subnetwork and excludes all others. If you want the agent to map users in other subnetworks, you must repeat these steps to add additional networks to the list.
      • Exclude specified network
        —Select this option only if you want the agent to exclude a subset of the subnetworks you added for inclusion. For example, if you include and exclude, the agent will map users on all the subnetworks of except, and will exclude all subnetworks outside of
        If you add subnetworks for exclusion without adding any for inclusion, the agent will not perform user mapping in any subnetwork.
    4. Click
  3. (
    ) If you configured the agent to connect to a Novell eDirectory server, you must specify how the agent should search the directory.
    1. Select
      User Identification
      and click
      in the Setup section of the window.
    2. Select the
      tab and then complete the following fields:
      • Search Base
        —The starting point or root context for agent queries, for example:
        dc=domain1,dc=example, dc=com
      • Bind Distinguished Name
        —The account to use to bind to the directory, for example:
        cn=admin,ou=IT, dc=domain1, dc=example, dc=com
      • Bind Password
        —The bind account password. The agent saves the encrypted password in the configuration file.
      • Search Filter
        —The search query for user entries (default is
      • Server Domain Prefix
        —A prefix to uniquely identify the user. This is only required if there are overlapping name spaces, such as different users with the same name from two different directories.
      • Use SSL
        —Select the check box to use SSL for eDirectory binding.
      • Verify Server Certificate
        —Select the check box to verify the eDirectory server certificate when using SSL.
  4. (
    Optional, not recommended
    ) Configure client probing.
    Do not enable client probing on high-security networks. Client probing can generate a large amount of network traffic and can pose a security threat when misconfigured.
    1. On the
      Client Probing
      tab, select the
      Enable WMI Probing
      check box and/or the
      Enable NetBIOS Probing
      check box.
    2. Make sure the Windows firewall will allow client probing by adding a remote administration exception to the Windows firewall for each probed client.
      For NetBIOS probing to work effectively, each probed client PC must allow port 139 in the Windows firewall and must also have file and printer sharing services enabled. Although client probing is not recommended, if you plan to enable it, WMI probing is preferred over NetBIOS whenever possible.
  5. Save the configuration.
    to save the User-ID agent setup settings and then click
    to restart the User-ID agent and load the new settings.
  6. (
    ) Define the set of users for which you do not need to provide IP address-to-username mappings, such as kiosk accounts.
    Save the
    list as a text document on the agent host using the title
    and use the .txt file extension to save it to the User-ID Agent folder on the domain server where the agent is installed.
    List the user accounts to ignore; there is no limit to the number of accounts you can add to the list. Each user account name must be on a separate line. For example:
    SPAdmin SPInstall TFSReport
    You can use an asterisk as a wildcard character to match multiple usernames, but only as the last character in the entry. For example,
    would match all administrators in the
    domain whose usernames start with the string
    . You can also use the
    list to identify users whom you want to force to authenticate using Captive Portal.
  7. Configure the firewall to connect to the User-ID agent.
    The firewall can connect to only one Windows-based User-ID agent that is using the User-ID credential service add-on to detect corporate credential submissions. See Configure Credential Detection with the Windows-based User-ID Agent for more details on how to use this service for credential phishing prevention.
    Complete the following steps on each firewall you want to connect to the User-ID agent to receive user mappings:
    1. Select
      User Identification
      User-ID Agents
      and click
    2. Enter a
      for the User-ID agent.
    3. Enter the IP address of the Windows
      on which the User-ID Agent is installed.
    4. Enter the
      number (1-65535) on which the agent will listen for user mapping requests. This value must match the value configured on the User-ID agent. By default, the port is set to 5007 on the firewall and on newer versions of the User-ID agent. However, some older User-ID agent versions use port 2010 as the default.
    5. Make sure that the configuration is
      , then click
    6. Commit
      the changes.
    7. Verify that the
      Connected status
      displays as connected (a green light).
  8. Verify that the User-ID agent is successfully mapping IP addresses to usernames and that the firewalls can connect to the agent.
    1. Launch the User-ID agent and select
      User Identification
    2. Verify that the agent status shows
      Agent is running
      . If the Agent is not running, click
    3. To verify that the User-ID agent can connect to monitored servers, make sure the Status for each Server is
    4. To verify that the firewalls can connect to the User-ID agent, make sure the Status for each of the Connected Devices is
    5. To verify that the User-ID agent is mapping IP addresses to usernames, select
      and make sure that the mapping table is populated. You can also
      for specific users, or
      user mappings from the list.

Recommended For You