Chat now with support
Chat with Support

Active Roles 7.2 - Configuration Transfer Wizard Administrator Guide

Using the Collection wizard and Deployment wizard

Using the solution > Using the Collection wizard and Deployment wizard

To transfer Active Roles configuration, you can collect configuration objects from one Active Roles environment and then deploy them to another environment in the following way:

  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 Start 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. Under Package description, enter the package description (optionally).
    3. To cause the wizard to collect Access Templates associated with selected objects, leave the Do not collect associated Access Templates check box cleared. Otherwise, select this check box.
    4. To cause the wizard to collect Policy Objects associated with selected objects, leave the Do not collect associated Policy Objects check box cleared. 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 Start page.
  2. On the Deploy Active Roles Configuration Data page, do the following:
    1. Click Browse to select the configuration package file.
    2. Optionally, 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

Using the solution > 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

  • From a command prompt, run the arsconfig.wsf script, specifying the required type of task and parameters. The script syntax is described in the section that follows.

Syntax

Using the solution > Using the ARSconfig command-line tool > 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]

Parameters

Using the solution > Using the ARSconfig command-line tool > Parameters
Table 1: 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