RMS SP2 Administration Toolkit – Download
It’s amazing sometimes when you attempt to download a tool from Microsoft and its no longer available for download and a lot of the documentation still available has links that do not work for the download.
The following is a list of tools and their commands that are included in the toolkit. This is mostly copied from the rteadme.htm that is part of every tool
AD SCP Register
Use this tool to register or unregister a service connection point in Active Directory.
- Open Command Prompt, by clicking Start, Run. In the Run dialog box, type cmd, and then click OK.
- At a command prompt type the following command: ADSCPRegister.exe <Operation/> <URLtoRegister>
Using the following information to select the appropriate options for your installation:
- <Operation> specify either unregisterscp or unregisterscp
Example: ADSCPRegister.exe unregisterscp https://adrms.contoso.com/_wmcs/Certification
- registerscp – this operation registers the service connection point specified in URLtoRegister in Active Directory.
- unregisterscp – this operation unregisters the service connection point specified in URLtoRegister in Active Directory.
For <URLtoRegister>, type the URL that you want to use as the service connection point, for example, https://adrms.contoso.com/_wmcs/Certification.
3. Verify that the tool has run correctly by viewing these two objects in Active Directory:
- objectClass=container with CN=RightsManagementServices
- objectClass=serviceConnectionPoint with CN=SCP and the serviceBindingInformation attribute set to the URL specified for the URLtoRegister you provided in step 2.
Usage Notes: The service connection point (SCP) for RMS identifies the connection URL for the service to the RMS-enabled clients that are in your organization. Clients will not be able to discover RMS to request use licenses, publishing licenses, or RMS account certificates without a valid SCP. Incorrectly using this tool could result in users being unable to use Rights Management Services.
Get RMS SCP
Use this tool to validate the current service connection point registered in Active Directory
To run GetRMSP
- Open a command prompt by clicking Start and then Run, In the Run dialog box, type cmd, and then click OK. or Windows Command Prompt(Admin). Depending on OS
- Navigate to the location where the tool is saved (C:\Program Files (x86)\RMS SP2 Administration Toolkit\GetRMScp). At a command prompt type the following command: GetRMSCP
Example: GetRMSCP
IRM Check
For enterprises that are using RMS with Office System 2010/2013/2016. Use this tool to create an html-based report of the client configuration, Office version, registry keys, and other settings that impact the RMS system. If the RMS-enabled application used on the client computer is a 32-bit application, make sure to use the 32-bit version of IRMCheck in the RMS Toolkit. Similarly, if you are running a 64-bit RMS-enabled application on the client computer, make sure to use the 64-bit version of IRMCheck from the RMS Toolkit
To run IRMCheck
- On the affected computer, launch IRMCheck.
- Open File Explorer and GoTo C:\Program Files (x86)\RMS SP2 Administration Toolkit\IRMCheck
- A report will be created that will give you diagnostic information specific to your Windows® Rights Management Services environment.
Example Report:
RMS Cert Analyzer
Use this tool to check the certificate chain on a given rights account certificate, view rights data and certificate information.
How to use the RMSCertAnalyzer
Using the RMSCertAnalyzer tool includes the following two tasks:
- Specify the configuration information
- Run the RMSCertAnalyzer
To specify the configuration information
- In the location where you saved the RMSCertAnalyzer tool, use an XML editing tool (or a text editor such as Notepad) to open the RMSCertAnalyzer.exe.config file that was included with the tool.
- Copy the contents of web.config of the licensing IIS virtual root to CertAnalyzer.exe.config.
To run the RMSCertAnalyzer
- On the RMS server, navigate to the location where you saved the RMSCertAnalyzer tool (C:\Program Files (x86)\RMS SP2 Administration Toolkit\RMSCertAnalyzer).
- Start the tool by double-clicking the RMSCertAnalyzer.exe application. The RMS License Analyzer window appears.
- From file menu, open the certificate file you want to analyze. Once the license is selected, you can analyze it in the following manner. The opened file is displayed in RMS License label.
- The License Information is displayed from the License chain in edit box.
- From the Tools menu, you can select Verify License Chain to validate license signature, trust chain and display trusted domains in the view window.
- From Tools menu, you can select View Rights Data for any license. If the selected license is a publishing license, the tool will decrypt the encrypted rights data and display it in the window. If the license is any other RMS license, the tool displays rights data if the license has any.
- From the Tools menu, you can select License Information to view license data such as issued time, validity time, issuer, issued principal and trust chain from the license.
Usage notes
- License files analyzed using this tool must use UNICODE text formatting. If the license file is saved using the ASCII text format the file cannot be analyzed.
- Using this tool will not make any changes to the licenses and certificates.
- This tool can only be used on front-end RMS servers.
RMS Config Editor
Use this tool to easily view and edit data in the RMS configuration database.
To run RMS Config Editor
- Open the folder where you saved the RMS Administration Toolkit, open the folder for RMS Config Editor, and then double-click RMSConfigEditor.exe to start the tool. The RMS Config Editor window opens.
- In Server, type the name of the computer that hosts the RMS configuration database. If the tool is being run on that computer, select localhost.
- Click the Go button to connect to the specified server.
- In Database, select the RMS database you want to view from the drop-down list.
- Click the Go button to connect to the specified database. A list of database tables appears in the left pane of the window.
- Select a database to view by clicking the table name in the left pane. The contents of the table are displayed in the right pane.
- If you want to modify a field value, in the right pane, click the field and type a new value.
- To save the change to the database, click the Persist button.
Note: You must save your changes using the Persist button before you select another table. If you do not, your modifications are lost.
- When you are done using the tool, click the Exit button.
Usage notes
- This tool can be used on either local or remote computers.
- The names of the computers and the databases that the toll connects to are retained in the drop-down lists until you exit the tool.
- If you have a previous version of this tool installed, you must remove it before installing this version.
- Although designed with the configuration database in mind, this tool can be used to view or edit other RMS databases, such as Logging and Directory Services cache.
- The intended use of this tool is for viewing and editing data that is not exposed by the RMS Server Administration interface. As such, it is limited as to the type of data that it can edit.
- This tool cannot be used to view extremely large databases.
RMS Event Viewer
Use this tool to map RMS log entries to events, enabling the logs to be viewed using the Event Viewer.
To run RMS Event Viewer
- Open the folder where you saved the RMS Administration Toolkit, open the folder for RMS Event Viewer (C:\Program Files (x86)\RMS SP2 Administration Toolkit\RMSEventViewer), and then double-click the RMSEV.exe application to start the tool. The RMS Log Viewer window opens.
- In Machine, type the name of the server on which you want to view logging databases by using Event Viewer.
- In Logging Database, type the name of the SQL server that contains the source logging databases.
- Click the Step 1: Connect to server button. This creates a connection between the servers and retrieves a list of databases from the SQL server.
- Click the arrow next to the third drop-down box to see the list of available databases.
- Select the database you want to view from the list and then click the Step 2: Connect to database button. A list of events is displayed in the RMS Event Log area.
- Click an event in the RMS Event Log area to highlight it. The logging record related to the event is displayed in the RMS Logging Database area in the left pane.
- To view the details associated with a log record, double-click the record. The details are displayed in the RMS Logging Database area in the right pane.
Usage notes
- This tool can be used on either local or remote computers.
- The names of the computers and the databases that the tool connects to are retained in the drop-down lists until you exit the tool.
- If you have a previous version of this tool installed, you must remove it before installing this version.
- Gathering events from remote computers may take a substantial amount of time.
RMS Log Analyzer
Use this tool to analyze the log file of your RMS server to track server errors, query for specific users, and other logged events.
How to run RMS Log Analyzer
To run the RMS Log Analyzer, you perform three procedures:
- Create the DRMS_Log_Admin database
- Specify the configuration list
- Run the RMS Log Analyzer
To create the DRMS Log Admin database
- Save the RMS Log Analyzer tool on the computer running SQL Server where you wish to host the DRMS_Log_Admin database. (C:\Program Files (x86)\RMS SP2 Administration Toolkit\RMSLogAnalyzer)
- Run the SQL Script file GenerateRMSAdmin.sql to create the database that the tool will write data to.
To specify the configuration list
- In the location where you saved the RMS Log Analyzer tool, use an XML editing tool (or a text editor such as Notepad) to open the DBConfig.xml file that was included with the tool.
- Add entries into the file for each of the servers running SQL Server that you want to gather RMS log data from by using the following syntax: <Server HostName=”SQL_Server_name” DatabaseName=”DRMS_Logging_hostname_subdomain_secondleveldomain_topleveldomain_port”> </Server>
- Once all of the servers that you want to gather data from have been added to the list, save the file and exit your editing application.
To run the RMS Log Analyzer
- On the server where you created the DRMS_Log_Admin database, navigate to the location where you saved the RMS Log Analyzer tool.
- Open a command prompt by clicking Start, and then Run. In the Run dialog box, type cmd, and then click OK.
- At a command prompt, navigate to the location where the tool is saved and type RMSLogAnalyzer.exe.
- To stop RMS Log Analyzer, press CTRL+C in the RMS Log Analyzer command prompt window.
While the tool is running, you will see the following progress indicators in the command window.
During the first run of the tool, it will process up to 20,000 log entries from each database you listed in the configuration file. If your databases contain more than 20,000 log entries, repeat this step until all of the logs are processed. Subsequent runs of the tool will process 5,000 log entries.
If a processing error is encountered while processing a log entry, the logID and the exception are displayed in the command window. The database will reflect the error by creating an entry for the logID and the related data will contain the text “RMS Admin processing error.” This error will not stop the processing of subsequent log entries; the tool will continue to the next entry automatically.
If you want to automate the process of starting RMS Log Analyzer, you can configure it as a scheduled task so that Log Analyzer is started every time that the system is started.
To run RMS Log Analyzer as a scheduled task
- On the server where you created the DRMS_Log_Admin database, click Start, click Control Panel, and then click Scheduled Tasks.
- Double-click Add Scheduled Task, and then click Next.
- Click Browse.
- Navigate to the location where you saved the RMS Log Analyzer tool.
- Type RMS LogAnalyzer for the task name, click When my computer starts, and then click Next.
- Enter credentials of a user on the network who has at least read access to the RMS Logging database, click Next, and then click Finish.
Usage notes
- In previous versions of RMS Log Analyzer, RMS Log Analyzer had to be installed on the SQL Server. In RMS Log Analyzer Service Pack 2, a command-line option was added to pull data from remote SQL servers. To use the new command-line option, type RMSLogAnalyzer.exe /ALTDB <SQL_Server_Name> at the command prompt.
- Using this tool will not make any changes to the source RMS logging databases.
- One DRMS_Log_Admin database can be used to store any number of RMS databases so long as the full logging database names are unique.
- The Windows RMS Newsgroup is a great place to ask questions of other RMS users and find general information about other user’s experiences with RMS. You can subscribe to the RMS newsgroup from the Microsoft newsgroup server (http://go.microsoft.com/fwlink/?LinkId=74714).
RMS Queue Recovery
Use this tool to recover logged events from the MSMQ dead letter queue.
To run RMS Queue Recovery
- Open a command prompt by clicking Start and then Run. In the Run box, type cmd, and then click OK.
- Navigate to the location where the tool is saved. At a command prompt, type the following command, replacing the parameters with the appropriate values for your installation: LogRecoveryCmd <operation> <queue name>
The tool can perform the following operations:
When specifying the <queue name> parameter, you must use the direct format, for example, .\Private$\Drms_Queue.
Following are two examples of how to use this tool on a server with a local logging database. These examples assume that the queue name is .\private$\drms_logging .
- To resend all messages from the dead letter queue back to the logging queue, type:LogRecoveryCmd.exe resend .\private$\drms_logging
Usage notes
- This tool must be run on the RMS server.
RMS Service Locator
Use this tool to provide a report of all the URLs that RMS uses.
To run RMS Service Locator
- Open a command prompt by clicking Start and then Run. In the Run dialog box, type cmd, and then click OK.
- Navigate to the location where the tool is saved (C:\Program Files (x86)\RMS SP2 Administration Toolkit\RMSServiceLocator). At a command prompt, type the following command: RMSServiceLocator
The tool will run and will display the services available for the server to enroll with.
Usage notes
- This tool must be run on the RMS server.
Download RMS SP2 Administration Toolkit – https://1drv.ms/u/s!AqPEeJPr6wHFlPAiLhfZOIS_kZ4qJw