Active Roles Management Shell has been extended with a new module, ActiveRolesConfiguration, that provides command-line tools (cmdlets) for configuring Active Roles Administration Service instances and Web Interface sites. This module is available on 64-bit (x64) systems only. It requires the Active Roles Administration Service or Web Interface to be installed; otherwise, the module does not provide all cmdlets. The following table lists and briefly describes the cmdlets provided by this module.
Table 1: Configuration Shell Cmdlets
|
Get-ARComponentStatus |
Returns installation and configuration status of Active Roles components. |
|
New-ARDatabase |
Creates a new Active Roles database. |
|
Import-ARDatabase |
Transfers Active Roles configuration data or management history data from one database to another. |
|
Backup-AREncryptionKey |
Creates a file that stores a copy of the current encryption key used in the configuration database of the local Administration Service instance. |
|
Restore-AREncryptionKey |
Restores the encryption key from a backup file to the configuration database of the local Administration Service instance. |
|
Reset-AREncryptionKey |
Creates a new encryption key for the configuration database of the local Administration Service instance. |
|
New-ARService |
Creates the instance of the Active Roles Administration Service on the local computer. |
|
Get-ARService |
Retrieves the Active Roles Administration Service instance from the local computer. |
|
Set-ARService |
Modifies the Active Roles Administration Service instance on the local computer. |
|
Start-ARService |
Starts the stopped Active Roles Administration Service on the local computer. |
|
Stop-ARService |
Stops the Active Roles Administration Service running on the local computer. |
|
Restart-ARService |
Stops and then starts the Active Roles Administration Service on the local computer. |
|
Remove-ARService |
Deletes the Active Roles Administration Service from the local computer. |
|
Test-ARServiceDatabaseSettings |
Verifies whether the given Active Roles database settings would cause Management History issues due to separate Configuration and Management History databases. |
|
Get-ARServiceStatus |
Retrieves the Active Roles Administration Service status information from the local computer. |
|
Get-ARVersion |
Retrieves the version number of the local Active Roles installation. |
|
New-ARWebSite |
Creates a new Active Roles Web Interface site. |
|
Get-ARWebSite |
Retrieves Active Roles Web Interface sites from the Web server. |
|
Set-ARWebSite |
Modifies the specified Active Roles Web Interface site on the Web server. |
|
Remove-ARWebSite |
Deletes the specified Active Roles Web Interface site from the Web server. |
|
Get-ARWebSiteConfig |
Retrieves Web Interface site configuration objects from the Active Roles Administration Service. |
|
Export-ARWebSiteConfig |
Exports a Web Interface site configuration to a file. |
How to start
- Log on to the computer on which the Administration Service or Web Interface is installed.
- Open Active Roles Management Shell on that computer.
To open Management Shell, click Active Roles 7.5.2 Management Shell on the Apps page or Start menu depending upon the version of your Windows operating system.
- Enter the QuickRef command at the Management Shell command prompt to view the Reference Manual that provides detailed information about all commands available in Active Roles Management Shell.
Active Roles Log Viewer
The Log Viewer tool enables you to browse and analyze diagnostic log files created by the Active Roles Administration Service as well as event log files created by saving the Active Roles event log in Event Viewer on the computer running the Administration Service. Log Viewer can help you drill down through the sequence or hierarchy of requests processed by the Administration Service, identify error conditions that the Administration Service encountered during request processing, and find Knowledge Articles that apply to a given error condition.
With Log Viewer, you can open an Active Roles diagnostic log file (ds.log) or saved event log file (.evtx), and view a list of:
- Errors encountered by the Administration Service and recorded in the log file
- Requests processed by the Administration Service and traced in the log file
- All trace records found in the diagnostic log file
- All events found in the event log file
When you select an error in the list, you can choose a command to look for solution in Knowledge Base. The command performs a search in One Identity Software Knowledge Base to list the Knowledge Articles that can provide helpful information on how to troubleshoot the error you selected.
Log Viewer also enables you to:
- Search the list for a particular text string, such as an error message
- Filter the list by various conditions, to narrow the set of list items to those you are interested in
- View detailed information about each list item, such as error details, request details or stack trace
How to start
To start Log Viewer, click Start Log Viewer in the Configuration Center main window.
Once you have started Log Viewer, open your Active Roles diagnostic log file or saved event log file: Click Open on the Log Viewer toolbar, and supply the path and name of the log file.
By default, Log Viewer displays a list of errors encountered by the Administration Service and recorded in the log file. You can use Log Viewer to look for information on how to troubleshoot a given error: Right-click the error in the list and then click Look for solution in Knowledge Base. Log Viewer performs a search in One Identity Software Knowledge Base to list the Knowledge Articles that apply to the error you selected.
Other tasks you can perform:
- To view a list of requests processed by the Administration Service and traced in the log file, click Requests in the View area on the Log Viewer toolbar.
- To view all trace records found in the diagnostic log file or all events found in the event log file, click Raw log records in the View area on the Log Viewer toolbar.
- To search the list for a particular text string, such as an error message, type the text string in the Search box on the Log Viewer toolbar and press Enter.
- To narrow the set of list items to those you are interested in, click Filter on the Log Viewer toolbar and specify the desired filter conditions.
- To view detailed information about an error, request, trace record or event, right-click the corresponding list item, and click Details.
- To view all trace records that apply to a given request, right-click the corresponding item in the Requests list and click Stack trace. This task is unavailable in case of an event log file.
- To view the request that caused a given error, right-click the error in the Errors list and click Related request. This task is unavailable in case of an event log file.
- To view all trace records that apply to the request that caused a given error, right-click the error in the Errors list and click Stack trace for related request. This task is unavailable in case of an event log file.
By default, Active Roles does not limit the number of managed objects. However, as Active Roles’ license fee is based on the managed object count, you may need to verify if the object count is under a certain threshold. You can perform this task by specifying a threshold value for the number of managed objects. The scheduled task that counts managed objects then raises an alert each time it detects that the current number of managed objects exceeds the threshold value. The alert makes the Product Usage Statistics section red on the root page in the Active Roles console, and can send a notification over e-mail.
How to start
- Log on as Active Roles Admin, open the Active Roles console, and select the root node in the console tree.
- In the details pane, expand the Product Usage Statistics area, and then click Change next to the Threshold value field.
For further details, see the “Voluntary thresholds for the managed object count” section in the Active Roles Administration Guide.
The Active Roles console allows you to set a text label that helps you identify your Active Roles installation in the Managed Object Statistics report—a report that lists the managed object counts. You can use the installation label to distinguish, for example, between production and non-production or pilot installations. The label text is displayed in the title of the Managed Object Statistics report.
How to start
- Log on as Active Roles Admin, open the Active Roles console, and select the root node in the console tree.
- In the details pane, expand the Product Usage Statistics area, and then click Change next to the Installation label field.
