Chat now with support
Chat mit Support

Active Roles 8.2.1 - Synchronization Service Administration Guide

Synchronization Service overview Deploying Synchronization Service Deploying Synchronization Service for use with AWS Managed Microsoft AD Getting started Connections to external data systems
External data systems supported with built-in connectors
Working with Active Directory Working with an AD LDS (ADAM) instance Working with Skype for Business Server Working with Oracle Database Working with Oracle Database user accounts Working with Exchange Server Working with Active Roles Working with One Identity Manager Working with a delimited text file Working with Microsoft SQL Server Working with Micro Focus NetIQ Directory Working with Salesforce Working with ServiceNow Working with Oracle Unified Directory Working with an LDAP directory service Working with an OpenLDAP directory service Working with IBM DB2 Working with IBM AS/400 Working with IBM RACF Working with MySQL database Working with an OLE DB-compliant relational database Working with SharePoint Working with Microsoft 365 Working with Microsoft Azure Active Directory Configuring data synchronization with the SCIM Connector Configuring data synchronization with the Generic SCIM Connector
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 Developing PowerShell scripts for attribute synchronization rules Using PowerShell script to transform passwords

Synchronization Service Management Shell

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

You can open Synchronization Service Management Shell either from the list of installed applications, or directly from Windows PowerShell.

To launch Synchronization Service Management Shell

  1. In the operating system, open the Start menu.

  2. In the Start menu, search for Active Roles Synchronization Service Management Shell 8.2.1, then click it.

    Alternatively, use the Search bar of the system tray to find Synchronization Service Management Shell, then click it for launch.

To load Synchronization Service Management Shell in Windows PowerShell

  1. Start Windows PowerShell.

  2. To load the Synchronization Service Management Shell module, run the following command:

    Import-Module -Name "<full-path-to-synchronization-service-module-file>"

    For example, if you installed Synchronization Service to the default installation location, the full command is as follows:

    Import-Module -Name "C:\Program Files\One Identity\Active Roles\8.2.1\SyncService\SyncServiceShell\SyncServiceManagementShell.psd1"

NOTE: When loading Synchronization Service, your system may indicate that the certificate of some digitally-signed files published by One Identity are untrusted, and that you must enable trust for the certificate issuer to run Synchronization Service. If this happens, press either R (Run once) or A (Always run). One Identity recommends selecting A to prevent this message appearing again.

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 byPowerShell itself or by other PowerShell modules.

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 1: To view help

To view this

Run this command

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

Get-QCCommand

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.

Get-Help

Connections to external data systems

  • External data systems supported out of the box

  • 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

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen