To search for directory objects, use the Search page that allows you to select the container to search and specify criteria for the objects you want to find. The Web Interface runs searches both in the selected containers and their subcontainers.
The Web Interface opens the Search page when you do any of the following:
-
Type in the Search field located in the upper right corner of the Web Interface window, then press Enter or click the magnifying glass icon in the Search field. In this case, the Web Interface will search all managed AD or Azure AD domains for objects whose naming properties match what you specified, and the Search page will list the search results accordingly. The naming properties include name, first name, last name, display name, and login name.
-
Click Search on the Navigation bar. This will open the Search page, allowing you to configure and start a search.
To configure and start a search
-
On the Toolbar of the Web Interface, click Search in, then select the container that you want to search. You can select more than one container.
-
Specify the criteria for the objects that you want to find:
-
To search by naming properties, enter them in the Search field on the Toolbar. The Web Interface will then search for objects whose naming properties match your criteria. The naming properties include name, first name, last name, display name, and logon name.
-
To search by other properties, expand the Toolbar by clicking the button on the right side of the Toolbar, click Add criteria, choose the properties by which you want to search, and click Add. Then, configure the criteria as appropriate. The Web Interface will search for objects that match the criteria you configured.
-
To start the search, press Enter.
The search results then appear on the Search page.
TIP: You can customize the list by adding or removing list columns and sorting the list by column data. To add or remove list columns, click Menu on the left side of the Toolbar, then click Choose columns. To sort the list by column data, click the column headings.
Example: Searching by object type
This example procedure shows how to use the Search option to list all groups that exist in the AD domains managed by Active Roles.
To list all groups in all AD environments managed by Active Roles
-
On the Navigation bar of the Web Interface, click Search.
-
Expand the Toolbar by clicking the button on the right side of the Toolbar, click Add criteria, select Object type is User/InetOrgPerson/Computer/Group/Organizational Unit, then click Add.
-
On the Toolbar, click Group in the list next to The object type is, then press Enter.
If a container, such as an OU in an AD, holds many objects, you can narrow down the displayed list of objects by filtering them.
To filter the objects held in a container
-
In the Active Roles Web Interface, navigate to the container whose contents you want to filter.
To navigate to a container:
-
Search the container object, then click its name in the list of search results on the Search page.
-
Alternatively, browse the container objects with the Browse pane and the Object list.
NOTE: The scope of filtering is always set to the current container, and does not include any subcontainers of that container. Filtering is essentially a search for objects stored in a given container only. If you want to search the current container and all of its subcontainers, click Search under this container in the Command pane, and configure a search instead.
-
Specify how you want to filter the objects of the container.
-
To filter objects by naming properties, specify your criteria in the Filter field on the Toolbar, then press Enter. Alternatively, click the button next to the Filter field. The list of objects will include only the objects whose naming properties match what you typed. The naming properties include name, first name, last name, display name, and login name.
-
To filter objects by other properties, expand the Toolbar by clicking the button on the right side of the Toolbar, click Add criteria, choose the properties by which you want to filter, and click Add. Then, configure the criteria as you need. The list of objects will include only the objects that match the criteria you configured.
-
To apply the filter, press Enter or click the button next to the Filter field on the Toolbar.
When the Active Roles Web Interface applies the configured filter, it lists a subset of all objects held in that container.
TIP: To view all objects again, remove the filter.
-
If you did not specify any criteria, clear the Filter field on the Toolbar, and press Enter.
-
If you specified any criteria, expand the Toolbar, click Clear all, and press Enter.
Example: Filtering by object type
This example procedure shows how to configure a filter that lists only user accounts in a specific OU, removing all other objects from the list.
To filter to user accounts in a specific OU
-
In the Active Roles Web Interface, navigate to the OU.
-
To expand the Toolbar, click the button on the right side of the Toolbar. Then, click Add criteria, select Object type is User/InetOrgPerson/Computer/Group/Organizational Unit, and click Add.
-
On the Toolbar, confirm that the field next to The object type is reads User, then either click the button next to the Filter field, or press Enter.
Part of the Active Roles Management Tools, the Management Shell provides Windows PowerShell-based command-line tools (cmdlets), allowing you to run and automate administrative tasks in Active Roles.
These Management Shell cmdlets are shipped in two modules.
ActiveRolesManagementShell
The ActiveRolesManagementShell module provides cmdlets for the following administration operations:
-
Managing users, groups, computers and other Active Directory (AD) objects via Active Roles.
-
Managing digital certificates.
-
Administering certain Active Roles objects.
The names of the cmdlets provided by this module start with the QAD or QARS prefixes, such as New-QADUser, Add-QADCertificate, or New-QARSAccessTemplateLink.
ActiveRolesConfiguration
The ActiveRolesConfiguration module (also known as the "Configuration Shell") provides cmdlets for configuring Active Roles Administration Service instances and Web Interface sites. The names of the cmdlets provided by this module start with the AR prefix, such as New-ARDatabase, New-ARService, or New-ARWebSite.
NOTE: Consider the following when planning to use the ActiveRolesConfiguration module:
-
This module is available on 64-bit operating systems only.
-
You can only install this module on computers where the Administration Service or Web Interface modules are also installed. Otherwise, the module will not provide all cmdlets.
For more information, see Active Roles Configuration Shell.
Getting started
You can start using the Management Shell component from the Windows Start menu or the Apps page, depending on the version of the operating system.
To start the Active Roles Management Shell
-
Log in to the computer where the Administration Service or the Management Shell is installed.
-
To start the Active Roles Management Shell, in the Windows Start menu or the Apps page, click Active Roles 8.0.1 LTS Management Shell.
-
To view the reference manual providing detailed information about the available cmdlets, in the Management Shell command-line interface, enter QuickRef, then press Enter.
-
To load the available modules and access their cmdlets, enter the Import-Module command, then press Enter.
Configuring and administering Active Roles
This section summarizes the major configuration, deployment, and maintenance features of Active Roles.
