Configure Service Graph Connector for Active Directory
Configure your Lightweight Directory Access Protocol (LDAP) connections and verify them, set up scheduled imports, and optionally add multiple instances with the Guided Setup.
Before you begin
To use this Service Graph Connector, you need a subscription to a Subscription Unit that is based in the IT Operations Management (ITOM) Visibility application or in the ITOM Discovery application. As defined in the section titled "Managed IT Resource Types" in ServiceNow Subscription Unit Overview for your subscription, for managed IT resources that are created or modified in the CMDB by this Service Graph Connector, but that aren’t yet managed by ITOM Visibility or ITOM Discovery, these resources will increase Subscription Unit consumption from that application. Review your current Subscription Unit consumption within ITOM Visibility or ITOM Discovery to ensure available capacity.
- The Integration Commons for CMDB store app, which is automatically installed.
- The CMDB CI class models store app, which is automatically installed. See CMDB CI Class Models app.
- The ITOM Discovery License plugin (com.snc.itom.discovery.license). You must activate this plugin.
- ITOM Licensing plugin (com.snc.itom.license). For more information, see Request Discovery.
- The Datastream Action plugin (com.glide.hub.action_type.datastream), which is automatically installed.
- Observability Commons for CMDB (sn_observability), which is only required for event ingestion. This app must be installed prior to installing the connector for Event Management to work. For more information, see Observability Commons for CMDB on the ServiceNow Store.
After you have followed the instructions provided to you to download and activate the Service Graph Connector for Active Directory application, refer to Download an application from the ServiceNow Store for the first time and Install a Security Operations integration. There are a few steps you need to complete before you configure this integration.
Role required: admin
Procedure
- Navigate to All > Service Graph Connectors > Active Directory > Setup.
- On the Welcome to Guided Setup Home page, select Continue.
-
On the Experience page, select Best Experience followed by Continue.
The Service Graph Connector for Active Directory (AD) page is displayed with the following tasks:
- Configure LDAP Server
- Add Multiple Instances
- Set up scheduled import jobs
-
Select Configure LDAP Server to expand it.
The following steps are displayed in the left navigation panel:
- Configure Inactive threshold
- Update LDAP OU definition
- Configure LDAP Server Details
- Test LDAP Server Connection
A single LDAP server is supplied along with the application. This server includes a computer organizational (OU) unit that retrieves a computer's object information from the computers OU.
- Optional:
Select Configure Inactive threshold to open the record.
The System Property sn_sec_sgc_ad.inactive_threshold form is displayed.
- Select the here link in the message at the top of the form to edit the record.
- Optional:
Alternatively, you can select the Globe icon in the upper right of the screen and select Service Graph Connector for Active Directory from the list to change the application
scope so you can edit the form.
As you progress through the Guided Setup, follow any instructions you see at the top of the pages in for modifying the application scope so you can open, edit, and save the record.
-
Enter a threshold in the Value field.
The default value is 90 days. Before you modify this value, refer to the information about the threshold setting at the top of the page. With this setting, assets that match the day threshold value are excluded from import.
- Right-click in the gray header titled System Property sn_sec_sgc_ad.inactive_threshold of the record and select Save.
-
Select Mark as complete followed by Continue.
The LDAP OU Definition Access record is displayed.
-
Update LDAP OU Definition Access.
- Follow the steps listed at the top of the page and on the LDAP OU Definition record to verify or switch the application scope to 'Global' with the application picker.
- Select the LDAP OU Definition record on the table to open it.
- On the record, if not selected, select the Application Access tab.
- If displayed, select the link to edit the record followed by the check boxes for the permission settings you want.
- Right-click in the gray header of the Table LDAP OU Definition record and select Save.
-
Select Mark as complete followed by Continue.
The Configure LDAP Server Details page is displayed.
-
Provide the details for LDAP server connection.
-
Verify values or fill in the fields.
Field Value Name Read-only: Unique name for the LDAP server for example SGC-AD-computer. Application Read-only: Service Graph Connector for Active Directory (AD). Active Check box selected. Login distinguished name Login name for the AD server. Login password Password for the AD server. Starting search directory Directory you want to search for example DC=Ops. (Optional) MID Server Dedicated MID Server for the connection, if available. Note:A MID Server is required for on-premise connections if the instance is not publicly accessible.LDAP Server URLs Add the URL for the server for example ladp://host-name:389/. - Right-click in the gray header titled LDAP Server and select Save.
-
Select Mark as complete followed by Continue.
The Test LDAP Server Connection page is displayed.
-
Verify values or fill in the fields.
-
Test the LDAP Server Connection.
-
Scroll to the Related links section on the form and select the Test Connection link
If the connection is successful, a Connected Successfully message is displayed. If your connection test fails, a message is displayed with information about why the connection failed. Review the Message field for how to proceed.
- If you edit the record to fix the connection, right-click in the gray header titled LDAP Server and select Save.
-
Select Mark as complete followed by Continue.
Add Multiple Instances is displayed in the top header the tasks.
Adding Multiple instances is optional. If you don’t want to add multiple instances, you can proceed to step 14 and the Set scheduled import jobs task.
-
Scroll to the Related links section on the form and select the Test Connection link
- Optional:
Add multiple instances.
To add multiple instances, you must update data source access. You must edit the permissions on the Datasource [sys_data_source] table to create a data source for the new connection in the Service Graph Connector for Active Directory.
-
Select Add Multiple Instances from the top header drop down list.
The following tasks are displayed:
- Update Data Source Access
- Update Scheduled Data Import Access
- Add Another LDAP Server
- List of configured LDAP servers
-
Select Update Data Source Access.
- Follow the steps listed at the top of the page to switch the application scope with the application picker to open, edit, and save the record.
- Select the Data Import record from the list to open it.
- With the Application Access tab selected, follow the instructions to edit the record and modify the check boxes.
- Right-click in the gray header titled Table Data Source and select Save.
-
Select Mark as complete followed by Continue.
The Update scheduled data import access page is displayed.
-
Update scheduled data import access.
- Select the Scheduled Data Import record from the list to open it.
- Optional: With the Application Access tab selected, follow the instructions to edit the record and modify the check boxes.
- Right-click in the gray header titled Table Scheduled Data Import and select Save.
- Select Mark as complete followed by Continue.
The Add Another LDAP Server page is displayed. There are two steps for this task:- LDAP server configuration
- Basic LDAP server information
-
Provide LDAP server configuration information.
-
Fill out the fields.
Field Value Type of LDAP server Active Directory Server name Unique name of the LDAP server. Server URL URL for example ldap://host-name:389/. Start search directory Directory you want to search for example DC=SecOps. -
Select Submit.
After you submit these edits, complete the second configuration step.
-
Fill in the fields for the basic LDAP server information.
Field Value Application Read-only Service Graph Connector for Active Directory. Active Check box selected. Login distinguished name Login name for the AD server. Login password Password for the AD server. Starting search directory Directory you want to search for example DC=SecOps. MID Server Dedicated MID Server for the connection. Note:A MID Server is not required for the LDAP server. - Right-click in the gray header titled LDAP Server and select Save.
-
Select Mark as complete followed by Continue.
The List of configured LADP server page is displayed.
- Select your new record from the list to open it and test the connection.
- Optional: Edit information on the form.
-
When you are satisfied with the information, scroll to the Related links and select the Test Connection link.
If the connection is successful, a message is displayed. If your connection test fails, review the Message and Suggestion fields for how to proceed.
- After a successful connection, right-click in the gray header titled LDAP Server and select Save.
- Select Mark as complete followed by Continue.
-
Fill out the fields.
-
To set up scheduled jobs, select Set up scheduled import jobs from the drop down list in the top header.
You must activate a scheduled job from the configuration page.
- On the Configure the scheduled jobs page, select a record from the Scheduled Data Imports list to open it.
-
Select the Active check box and fill in the fields.
Field Value Name Unique name for the LDAP server, SGC-AD-computer. Application Read-only Service Graph Connector for Active Directory (AD). Run How often you want the job to run. If you want to run a test import prior to scheduling it, you might prefer to set this to Once. Run as Run the scheduled job with the credentials of another specified user. Time When you want the job to run. Active Select the check box. Conditional Specific conditions under which this job is run. Use connection Leave this deactivated for the first run. Specifies another connection and credentials for this job. Concurrent import Leave activated. Splits data into multiple imports sets. See the message for more information. Partition Method Leave as Custom size. Partition size 15,000. Import set size for early scheduling. Execute pre-import script Leave activated. Specifies a script to run before the import is performed. Execute post-import script Leave activated. Specifies a script to run after the import is performed. - Optional:
Select Execute now to run the job.
If you do not choose to run the job on-demand, the next job runs according to the schedule you set.
- Right-click in the gray Scheduled Data Imports header and select Save.
- Select Mark as complete followed by Continue.
- On the Home page for Guided Setup, select Complete to finish the configuration.