Active Roles 7.3.1 - Synchronization Service Administrator Guide

Synchronization Service Overview Deploying Synchronization Service Getting started Connections to external data systems
External data systems supported out of the box
Working with Active Directory Working with an AD LDS (ADAM) instance Working with Skype for Business Server Working with Exchange Server Working with Active Roles Working with One Identity Manager Working with a delimited text file Working with Microsoft SQL Server Sample queries to modify SQL Server data Working with an OLE DB-compliant relational database Working with SharePoint Working with Microsoft Office 365 Working with Microsoft Azure Active Directory
Using connectors installed remotely Creating a connection Renaming a connection Deleting a connection Modifying synchronization scope for a connection Using connection handlers Specifying password synchronization settings for a connection
Synchronizing identity data Mapping objects Automated password synchronization Synchronization history Scenarios of use Appendix A: Developing PowerShell scripts for attribute synchronization rules Appendix B: Using a PowerShell script to transform passwords

Management Shell

Management Shell

Management Shell is implemented as a Windows PowerShell module, providing an extension to the Windows PowerShell environment. The commands provided by Management Shell conform to the Windows PowerShell standards, and are fully compatible with the default command-line tools that come with Windows PowerShell.

You can open Management Shell by using either of the following procedures. Each procedure loads the Management Shell module into Windows PowerShell. If you do not load the Management Shell module before you run a command (cmdlet) provided by that module, you will receive an error.

To open Management Shell

  • At the Windows PowerShell command prompt, run the following command:

    Import-Module [-Name]

    In the Name parameter specify the name of a file in the module and the file path. By default, the following path to the SyncServiceManagementShell module is used: C:\Program Files\One Identity\Active Roles\7.3\SyncService\SyncServiceShell\SyncServiceManagementShell.psd1.

Alternatively, complete the steps related to your version of Windows:

Table 5:  To open Synchronization Service

Windows 7

Windows Server 2008 R2

Windows 8 or 8.1

Windows Server 2012 or 2012 R2

  1. Click Start.
  2. Point to All Programs | One Identity Active Roles 7.3.
  3. Click Active Roles 7.3 Synchronization Service Management Shell.
  • On the Apps screen, click the Active Roles 7.3 Synchronization Service Management Shell tile.

Upon the shell start, the console may display a message stating that a certain file published by One Identity is not trusted on your system. This security message indicates that the certificate the file is digitally signed with is not trusted on your computer, so the console requires you to enable trust for the certificate issuer before the file can be run. Press either R (Run once) or A (Always run). To prevent this message from appearing in the future, it is advisable to choose the second option (A).

Cmdlet naming conventions

Cmdlet naming conventions

All cmdlets are presented in verb-noun pairs. The verb-noun pair is separated by a hyphen (-) without spaces, and the cmdlet nouns are always singular. The verb refers to the action that the cmdlet performs. The noun identifies the entity on which the action is performed. For example, in the Get-QCObject cmdlet name, the verb is Get and the noun is QCObject. All the Management Shell cmdlets have the nouns prefixed with QC, to distinguish the Management Shell cmdlets from those provided by PowerShell itself or by other PowerShell modules.

Getting help

Getting help

This section provides instructions on how to get help information for the cmdlets added by Management Shell to the Windows PowerShell environment.


Table 6:  To view help

To view this

Run this command

A list of all the Synchronization Service Management Shell cmdlets available to the shell.


Information about the parameters and other components of a Synchronization Service Management Shell cmdlet.

Run one of the following:

  • Get-QCCommand <CmdletName>
  • Get-Command <CmdletName>

NOTE:You can use wildcard character expansion. For example, to view information about the cmdlets with the names ending in Workflow, run this command: Get-Command *Workflow.

Basic help information for a Synchronization Service Management Shell cmdlet.

Get-Help <CmdletName>

Detailed help information for a Synchronization Service Management Shell cmdlet, including the descriptions of available parameters and usage examples.

Get-Help <CmdletName> -full

Basic information about how to use the help system in Windows PowerShell, including Help for the Synchronization Service Management Shell.



Connections to external data systems

Related Documents