Chat now with support
Chat with Support

Active Roles 8.1.3 - Administration Guide

Introduction Getting started with Active Roles Configuring rule-based administrative views Configuring role-based administration Rule-based autoprovisioning and deprovisioning
Provisioning Policy Objects Deprovisioning Policy Objects How Policy Objects work Policy Object management tasks Policy configuration tasks
Property Generation and Validation User Logon Name Generation Group Membership AutoProvisioning Exchange Mailbox AutoProvisioning AutoProvisioning in SaaS products OneDrive Provisioning Home Folder AutoProvisioning Script Execution Microsoft 365 and Azure Tenant Selection E-mail Alias Generation User Account Deprovisioning Office 365 Licenses Retention Group Membership Removal Exchange Mailbox Deprovisioning Home Folder Deprovisioning User Account Relocation User Account Permanent Deletion Group Object Deprovisioning Group Object Relocation Group Object Permanent Deletion Notification Distribution Report Distribution
Deployment considerations Checking for policy compliance Deprovisioning users or groups Restoring deprovisioned users or groups Container Deletion Prevention policy Picture management rules Policy extensions
Using rule-based and role-based tools for granular administration Workflows
Key workflow features and definitions About workflow processes Workflow processing overview Workflow activities overview Configuring a workflow
Creating a workflow definition for a workflow Configuring workflow start conditions Configuring workflow parameters Adding activities to a workflow Configuring an Approval activity Configuring a Notification activity Configuring a Script activity Configuring an If-Else activity Configuring a Stop/Break activity Configuring an Add Report Section activity Configuring a Search activity Configuring CRUD activities Configuring a Save Object Properties activity Configuring a Modify Requested Changes activity Enabling or disabling an activity Enabling or disabling a workflow Using the initialization script
Approval workflow Email-based approval Automation workflow Activity extensions
Temporal Group Memberships Group Family Dynamic groups Active Roles Reporting Management History Entitlement profile Recycle Bin AD LDS data management One Identity Starling Join and configuration through Active Roles Managing One Identity Starling Connect Configuring linked mailboxes with Exchange Resource Forest Management Configuring remote mailboxes for on-premises users Migrating Active Roles configuration with the Configuration Transfer Wizard Managing Skype for Business Server with Active Roles
About Skype for Business Server User Management Active Directory topologies supported by Skype for Business Server User Management User Management policy for Skype for Business Server User Management Master Account Management policy for Skype for Business Server User Management Access Templates for Skype for Business Server Configuring the Skype for Business Server User Management feature Managing Skype for Business Server users
Exchanging provisioning information with Active Roles SPML Provider Monitoring Active Roles with Management Pack for SCOM Configuring Active Roles for AWS Managed Microsoft AD Azure AD, Microsoft 365, and Exchange Online Management
Configuring Active Roles to manage Hybrid AD objects Unified provisioning policy for Azure M365 Tenant Selection, Microsoft 365 License Selection, Microsoft 365 Roles Selection, and OneDrive provisioning Changes to Active Roles policies for cloud-only Azure objects
Managing the configuration of Active Roles
Connecting to the Administration Service Managed domains Using unmanaged domains Evaluating product usage Creating and using virtual attributes Examining client sessions Monitoring performance Customizing the Console Using Configuration Center Changing the Active Roles Admin account Enabling or disabling diagnostic logs Active Roles Log Viewer
SQL Server replication Using regular expressions Administrative Template Configuring federated authentication Communication ports Active Roles and supported Azure environments Integrating Active Roles with other products and services Active Roles Language Pack Active Roles Diagnostic Tools Active Roles Add-on Manager

Using the Configuration Collection Wizard and the Configuration Deployment Wizard

To transfer an Active Roles configuration, you can collect configuration objects from one Active Roles environment, then deploy them to another environment with the following steps:

  1. Create a configuration package file with the Configuration Collection Wizard.

  2. Deploy the package with the Configuration Deployment Wizard.

To create a configuration package with the Configuration Collection Wizard

  1. Start the wizard by running the Configuration Collection Wizard application from the Start menu or the Apps page.

  2. On the Collect Active Roles Configuration Data page, do the following:

    1. Click Connect and using the Connect to Administration Service dialog that opens, select the Administration Service to which you want the wizard to connect.

    2. Under Select configuration objects to package, select the objects you want to include in the configuration package, and specify whether you want to collect the child objects of the selected objects.

    3. When finished, click Create Package.

  3. On the Specify a location for the configuration package page, do the following:

    1. Click Browse to specify a location and name for the configuration package file.

    2. (Optional) Enter a Package description.

    3. To collect Access Templates associated with the selected objects, leave the Do not collect associated Access Templates check box clear. Otherwise, select this check box.

    4. To cause the wizard to collect Policy Objects associated with the selected objects, leave the Do not collect associated Policy Objects check box clear. Otherwise, select this check box.

  4. On the Verify the information you specified page, click Start.

To deploy a configuration package with the Configuration Deployment wizard

  1. Start the wizard by running the Configuration Deployment Wizard application from the Start menu or the Apps page.

  2. On the Deploy Active Roles Configuration Data page, do the following:

    1. Click Browse to select the configuration package file.

    2. (Optional) Select the Ignore errors check box for the wizard to ignore any errors during the configuration deployment.

    3. Click Deploy Package.

  3. On the Connect to Administration Service page, select the Administration Service to which you want the wizard to connect, and then click Next.

  4. On the Add Domain Name Mapping page, if names of the managed domains differ in the test and production environments, add domain name mapping entries, and then click Next.

  5. On the Verify the information you specified page, click Start.

Using the ARSconfig command-line tool

As an alternative to using the graphical user interface tools, you can use the ARSconfig command-line tool. The ARSconfig tool is the arsconfig.wsf Windows Script File (WSF) that defines the command line parameters and the required object references.

Using the ARSconfig tool requires two files to be pre-configured, before running the script. These are a file that lists the configuration objects that the package must include, and, if necessary, a file containing domain mapping entries.

To run the ARSconfig command-line tool

  1. Open the Windows Command Prompt.

  2. From the command prompt, run the arsconfig.wsf script, specifying the required type of task and parameters. The script syntax is described in ARSconfig syntax.

ARSconfig syntax

The ARSconfig Windows Script File has the following syntax.

Cscript arsconfig.wsf [/?] /task:<'collect' | 'deploy' | 'rollback'> [/selection:"<filename.xml>"] [/package:"<filename.xml>"] [/map:"<filename.csv>"] [/verbose] [/log:"<filename>"] [/deletelog] [/server:<servername>] [/login:<username>] [/password:<userpassword>] [/danglingLinks:<'Stop' | 'Skip' | 'Deploy'>] [/ignoreLinks:<'0' | '1' | '2' | '3'>] [/ignoreErrors] [/upgrade]

ARSconfig parameters

The ARSconfig Windows Script File (WSF) has the following parameters.

Table 86: Parameters

Parameter

Description

task

This is a required parameter which defines the type of task you want to perform by using this script.

Specify one of these parameter values:

  • 'collect' - Collects configuration data from the source Active Roles environment, and creates a configuration package file.

  • 'deploy' - Populates the target Active Roles instance with objects from a configuration package created earlier by Configuration Transfer Wizard.

  • 'rollback' - Reverts the configuration of the target Active Roles instance to the state it was in before deployment of the configuration package.

selection

The path and name of the XML file containing a list of the source configuration objects to be included in the configuration package.

This parameter is required when you use this script to create a configuration package. The XML file you specify in this parameter must be manually created before you run the script.

package

The full path to the configuration package XML file.

Add this parameter is you want to specify a custom name and location for the configuration package file. If you do not specify this parameter, the script assumes that the installation path, and the default package file name are used.

map

The name of the domain mapping file.

Add this parameter if you want the test domain names to be replaced with the production domain names, during configuration package deployment.

You can add this parameter only when you use this script to deploy a configuration package. The CSV file you specify in this parameter must be manually created before you run the script.

verbose

Enables log trace output.

If this parameter is not specified, then no information is displayed in the Command Prompt while the script is running.

log

Specifies the name of the trace output file. You can also specify a target location for the log file.

Add this parameter to create a log file with diagnostic information.

deletelog

Deletes the trace output file upon successful completion.

Add this parameter if you want the log file deleted if a task was completed with no errors.

server

The fully qualified domain name of the computer running the Administration Service to connect to.

If this parameter is not specified, the script attempts a connection to any available Administration Service.

login

The user logon name of the account with which you want to connect, in the form Domain\UserName, or in the form of a user principal name.

password

Password for the user logon name you specify in the login parameter.

danglingLinks

This parameter takes effect if the task parameter value is set to 'deploy', and specifies whether to deploy Access Template or Policy Object links, if any found in the package, that refer to objects which may fail to be resolved in the destination environment (dangling links). The acceptable parameter values are:

  • 'Stop' - The deployment process is not started if any dangling links are detected (default setting)

  • 'Skip' - The dangling links are not deployed in the destination environment

  • 'Deploy' - Deployment of the dangling links is attempted based on the data found in the package

ignoreLinks

Specifies whether to collect Access Template links and Policy Object links. This parameter can take any of the following values:

  • '0' - Collect all links (default setting).

  • '1' - Do not collect Policy Object links.

  • '2' - Do not collect Access Template links.

  • '3' - Do not collect Policy Object and Access Template links.

ignoreErrors

If this parameter is specified, the solution ignores any errors that can be encountered during the configuration deployment.

upgrade

If supplied together with /task:'deploy', preserves the existing links, policy parameters and scheduled task parameters. Without this parameter, the deployment of a configuration package replaces the existing links with the links found in the configuration package, and resets the policy and schedule task parameters to the default values.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating