Previous Topic: Configure SPML Client Computer to Support SSL Security

Next Topic: CMDRA Examples

CMDRA Commands

CMDRA Command Options

This table shows you the command options that you can use in the CMDRA.

Command

Full Command

Explanation

-c

--check

Check the request is a valid SPML request. This will not send the request to the SPML Server.

If you are using the SPML Templating feature, the records will be expanded and the resulting SPML request will be checked.

-e

--explodedOutputFile

Specify a file to contain the exploded request XML output, overwriting any file by that name.

-f

--propertyFile

Specify a file that contains default command settings. You would create a property file that contains frequently used values to avoid having to specify them manually every time.

For example:

mappingFile=C:\SPMLdata\Mapping1.csv
templateFile=C:\SPMLdata\ImportUsers.xml
dataFile=C:\SPMLdata\Users.csv
serverURL=https://spmlserver.yourcompany.com:8443/iamspml/spml/adminserver

You would not typically include the data file in the property file because it is highly variable.

The CMDRA looks for the property file login.properties. If your property file is named login.properties you do not need to specify -f.

When you specify information in the property file, you should use the full command but remove the two dashes (--).

-h

--help

Display the command line help page that gives you a summary of these commands.

-i

--inputFileNames

Specifies a file to read data/request file names from instead of putting file names on the command line

-m

--mappingFile

Use this to match your Velocity template variables with your data file variables.

Typically this is generated using the Save Mapping button in the SPML Manager. You can include multiple mappings that are separated by commas if you include multiple –t options.

Note: This must always be used in conjunction with the Data File and the Template File.

-o

--outputFile

Specify where you want the response from the SPML Service stored. By default, this is written to stdout.

This output can be redirected to a file, for example:

RA.bat yourparameters > SPMLresponse.text

This can contain information other than the raw XML response.

-p

--password

Specify the Provisioning Server password for the user. Therefore, this must be used in conjunction with the user (-u).

You do not need to specify the user or password if you are just checking a request.

-q

--quiet

Specify that you want minimum detail in the output.

-R

--explodePerRowOutputFileNames

Specify file that will list the names of files that contain the exploded request XML output, overwriting any file of the same name. One file is created per template per datafile record.

-s

--serverUrl

Specify the SPML server URL that you want to send the request to.

-S

--csvRuntimeStatistics

Name of .CSV file to write time to complete each request

-t

--templateFile

Specify the SPML Template file. Typically you would create the template file using the SPML Manager. If the -R option is included, the -t option can include a comma separated list of filenames.

Note: This must always be used in conjunction with the Data File and the Mapping File.

-u

--user

Specify the Provisioning Server user. This must be used in conjunction with password (-p).

You do not need to specify the user or password if you are just checking the request.

You must include the domain of the user, for example:

YOURDOMAIN\\user

-V

--verbose

Include detailed information in the output.

-v

 

--version

The version and build number of the CMDRA. This must be lowercase.