Connect Active Directory to Umbrella VAs
The Cisco Active Directory (AD) Connector monitors one or more domain controllers in your environment.
- The AD Connector listens to user and computer logins through the security event logs, and then transmits IP-to-user and IP-to-computer mappings to your deployed Umbrella Virtual Appliances (VAs).
- The AD Connector synchronizes user-to-group, computer-to-group and group-to-group memberships with Umbrella, which enables you to create and enforce group-based settings and view user, computer, and group-based reports.
The AD Connector helps import your Active Directory (AD) users, groups and computers to provide these mappings. Other AD objects, including Organization Units (OUs), are not imported.
Note: Only one AD Connector is required for each Umbrella site. For redundancy, add an optional second connector. If you are adding multiple AD domains through domain controller integrations, one connector is required per AD domain per Umbrella site, with an optional second connector for redundancy if required.
This guide describes the steps to install the Cisco AD Connector for LDAP or LDAPS, and provision users and groups from your instance of Microsoft AD to Umbrella.
How to Configure the Setup of the AD Connector
The deployment of the AD Connector has various components. You can configure the Cisco AD Connector to provision users and groups from Microsoft AD using LDAP or LDAPS (domain controller or domain).
- (Optional) Configure authentication for the AD Connectors in your environment. For more information, see Configure Authentication for AD Connectors and VAs.
- Download the AD Connector ZIP file from Umbrella.
- Add a domain controller or domain in Umbrella for LDAP or LDAPS deployments.
- Install and configure the AD Connector on your server.
- Verify that the AD Connector begins to provision users and groups in Umbrella.
Table of Contents
- Prerequisites
- (Optional) Specify AD Groups of Interest
- Install the Connector
- Verify That the Connector Syncs with Umbrella
Prerequisites
- Full Admin user role. For more information, see Manage Accounts.
- For information about the requirements for deploying the AD Connector, see Prerequisites for AD Integration with VAs.
- (Optional) Configure Authentication for the AD Connectors and VAs.
- Prepare Your Active Directory Environment.
(Optional) Specify AD Groups of Interest
You can optionally specify AD groups of interest for the purpose of policy creation in Umbrella. This is to avoid synchronizing all your AD groups to Umbrella and is recommended for easier policy management.
Rename Selective Sync File After Upgrading to AD Connector v1.14.4
If you use selective sync and upgrade the Cisco AD Connectors to v1.14.4 or later, you must rename the current selective sync file C:\CiscoUmbrellaADGroups.dat to C:\CiscoADGroups.dat.
Note: The selective sync file—previously named CiscoUmbrellaADGroups.dat—is not recognized by the Cisco AD Connector v1.1.4.4 or later.
After you rename the selective sync file, Umbrella automatically reads the selective sync file (C:\CiscoADGroups.dat) and syncs the Users in the specific Groups from AD to Umbrella. You are not required to restart the AD Connector service.
Create AD Groups in a Selective Sync File
- Identify the AD groups of interest. Users and computers belonging to these groups will be synchronized to Umbrella.
For each sub-tree, only the parent group needs to be specified. All AD groups, users, and computers that are part of this parent group will automatically be included.
Note: If Selective Sync is enabled, AD Users and Computers that are not members of Groups specified in CiscoADGroups.dat or their sub-groups will not be synchronized to Umbrella and will be completely exempt from Umbrella Policies and Reporting. - Create a CiscoADGroups.dat file in the C:\ drive of each machine where the connector will be installed.
The connector only reads the C:\CiscoADGroups.dat file. If the file is incorrectly named or is not present in the C:\ drive, all groups will be imported to Umbrella. - List the AD groups that need to be synchronized in distinguished name (DN) format in this file.
Get-ADGroup -Identity <ADGroupName>
Supported OUs
Not Supported: OU=My OU,OU=Organizational Unit,DC=sample,DC=local
Supported: CN=My Group,OU=Organizational Unit,DC=sample,DC=localSample file entries:
- CN=Engineering,CN=Builtin,DC=ciscoumbrella,DC=com
- CN=Sales,CN=Builtin,DC=ciscoumbrella,DC=com
- CN=Marketing,CN=Builtin,DC=ciscoumbrella,DC=com
- Ensure that there are no blank lines anywhere in the file.
Note: If you are running multiple connectors, the C:\CiscoADGroups.dat file should be present on each system running the connector and should be identical on each system.
Total Number of Groups Selected for Synchronization
The total number of groups selected for synchronization—groups specified in the selective sync file and all their sub-groups—should not exceed 15,000. Also, these groups should not be nested within more than five OU levels. Selective synchronization fails in both cases. If either of these requirements cannot be met, the selective sync file should not be used so that a full AD tree synchronization can be done instead.
Install the Connector
The connector can be installed on a domain controller or a server that is a member of the domain. For more information, see Prerequisites for AD Integration with VAs. Also, verify that network connectivity requirements specified in Communication Flow and Troubleshooting are met.
- In the Umbrella dashboard, navigate to Deployments > Configuration > Sites and Active Directory and click Download.
- Click Download for Windows Service (Active Directory Connector).
Note: You must download the ZIP file to the local machine where you plan to run it or copy it locally from another machine. We do not recommend that you install the connector from a network drive or run the setup.msi directly from the compressed file.
-
As an administrator, extract the contents of the CiscoConnector ZIP file that you downloaded from Secure Access to a folder on the server, and then navigate to that folder.
Note: If you run the AD Connector installer files from the root directory of your server, you may encounter installation errors. -
Run setup.msi, and then in the Cisco Connector Setup wizard, click Next.
-
Choose the directory on the server to install the Cisco AD Connector.
-
Confirm that you permit your AD Users and Groups to sync to Secure Access from the Cisco AD Connector.
-
Add your Active Directory credentials. Enter the Username of the Cisco AD Connector user (Cisco_Connector or custom username) and the Password. For more information, see Prerequisites for AD Integration with VAs.
-
Follow the remaining prompts in the setup and when finished, click Close.
-
Return to the Umbrella dashboard. Verify that the Cisco AD Connector is in the same Umbrella site as the domain controller or domain that it needs to communicate with.
Verify That the Connector Syncs with Umbrella
- For more information, see View AD Components in Umbrella.
- Once the connector is installed, return to the Umbrella dashboard and navigate to Deployments > Configuration > Sites and Active Directory.
On the Sites and Active Directory page, Umbrella lists the hostname of the Connector server.
Umbrella automatically configures and connects the VAs to the domain controllers through the AD Connectors for each configured site. The status of all of your VAs, AD servers, and AD Connectors should change from Inactive to Active. If not, contact Umbrella Support. - Navigate to Deployments > Core Identities > Users and Groups.
- Click to expand the Active Directory section and click View AD Users and Groups.
Confirm that groups and users are added.
If your groups are listed means the domain controllers have automatically synchronized user and computer group memberships with Umbrella through the connector successfully. Any subsequent changes should also sync successfully. If you don’t see your groups, check the Sites and Active Directory page to see if the status of all components is Active (green). If not, contact [email protected].
Note: It can take up to four hours for large numbers of AD users, computers, and group objects to synchronize for the first time. During this time, the connector status icon may appear as red until the initial sync is complete. After the sync completes, it will be labeled as Active (green).
Prepare Your Active Directory Environment < Connect Active Directory to Umbrella > Multiple Active Directory and Umbrella Sites
Updated 8 days ago