RMA Server administration commands

For more information about these commands, refer to the command help available in the command line interface (rmaCmdLine.bat --help or rmaCmdLine.sh --help).

All the RMA scripts are located in the <FEX_RMA_INSTALL_DIR>/bin directory. These scripts include the commands to administer the RMA Server.

Note: The command line must be installed together with the server on the same machine. The command line cannot be located on a different machine.

Introduction

The RMA command line is a client tool that enables you to act upon a running RMA Server. You use the command line to perform the following operations:

Important: In order to perform actions on the server, you must have the required privilege. There is one privilege for each of the actions. For information about privileges, refer to Configuring access control for FEX RMA.

Configuration file

The RMA command line configuration file client.properties is located in the <FEX_RMA_INSTALL_DIR>/conf directory. It contains parameters that enable the command line to locate the server, authenticate with it, and so on.

Parameter	Description
server.host	Name or IP address of the machine on which the server is running
server.api.port	Port on which the server is listening
client.timeout.connection	Number of milliseconds the client will wait when connecting before concluding that the server is not there
client.timeout.receive	Number of milliseconds the client will wait for a reply before considering that the server has taken too much time to perform an action
passport.truststore.path	Path to the trust store
passport.truststore.type	Type of trust store

Example of client.properties file

##############################

## RMA Client configuration ##

##############################

# Server host

server.host=localhost

# Webservice port number

server.api.port=9696

########################

# Client configuration #

########################

# timeout value in milliseconds for webservice connections to the server

client.timeout.connection=60000

# timeout value in milliseconds for webservice response from the server

client.timeout.receive=60000

############################

## Passport configuration ##

############################

passport.truststore.path=../fex-rma-server/conf/passport/passport_truststore.jks

passport.truststore.type=JKS

Command syntax

OS	Command
Windows	rmaCmdLine.bat --[action] --[parameter 1] --[parameter 2] --[parameter n]
UNIX	rmaCmdLine.sh --[action] --[parameter 1] --[parameter 2] --[parameter n]

Note: You can specify parameters by their full name or their abbreviated name (short name). When using an abbreviated parameter name, use one dash before the parameter (instead of two dashes).

Examples:

rmaCmdLine.sh --check --user myname --password mypassword --domain mydomain --file /full/path/name/to/file/dist.xml --key 30313233343536373839414243444546

rmaCmdLine.sh -c -u myname -p mypassword -d mydomain -f /full/path/name/to/file/dist.xml -k 3031323334353637

Command line actions

This table lists the RMA Server administration command line actions in their full and abbreviated forms.

Action	Command
Import ASP package	--importASP --user <user name> --password <password> --domain <domain> --file <ASP archive path> --key <ASP package digest> [--digestAlgorithm <digest algorithm>] or -s -u <user name> -p <password> -d <domain> -f <ASP archive path> -k <ASP package digest> [-a <digest algorithm>]
Import a distribution file	--import --user <user name> --password <password> --domain <domain> --file <distribution file path> --key <distribution file LAU> or -i -u <user name> -p <password> -d <domain> -f <distribution file path> -k <distribution file LAU>
Check a distribution file without importing it	--check --user <user name> --password <password> --domain <domain> --file <distribution file path> --key <distribution file LAU> or -c -u <user name> -p <password> -d <domain> -f <distribution file path> -k <distribution file LAU>
Display help	--help or -h

Parameter list

Parameter long name	Parameter short name	Value(s)
--digestAlgorithm	-a	Digest algorithm Default: SHA-256
--domain	-d	Domain name
--file	-f	ASP archive path or distribution file path. Specify the full path name to the distribution file. The distribution file to import must be accessible by the server.
--help	-h	Display the command line help
--key	-k	ASP package digest or distribution file key. The ASP package digest is provided in SHA-256 in Base64 format. The distribution file key should be either 128 bit (16 character) or 256 bit (32 character) long and in hexadecimal notation.
--password	-p	The password corresponding to the user
--user	-u	User name