arwfserver: Server Management Tool

CA AuthMinder Administration Guide › Tools for System Administrators › arwfserver: Server Management Tool

arwfserver: Server Management Tool

The arwfserver tool is an interactive utility that you can use to manage AuthMinder Server configurations and troubleshoot connection errors. For example, Administration Console uses the Server Management protocol for managing AuthMinder Server instance, and the default port number of this protocol is 9743. If this port is already in use by some other application, then you can use arwfserver tool to set the protocol on a different port.

In addition to server configuration management, the arwfserver tool also enables you to configure AuthMinder settings that are either used rarely (authentication and authorization for Web Service APIs) or are needed only in certain deployment scenarios (enable or disable plug-ins).

Running the Tool in Interactive Mode

The tool provides the -i option to run it in the interactive mode. In this mode, all server configurations are performed in a manner that is similar to how it is done in service mode, except that the listeners are not started.

When run in this mode, the arwfserver tool starts its own console prompt (wf>) and generates the startup logs in <install_location>/logs/arcotwebfortstartupcmd.log and the transaction logs in <install_location>/logs/arcotwebfortcmd.log.

To run the arwfserver tool:

Navigate to the location where the tool is available:
- On Windows
```
<install_location>\Arcot Systems\bin\
```
- On UNIX-based Platforms
```
<install_location>/arcot/bin/
```
Run the following command:
- On Windows
```
arwfserver -i
```
- On UNIX-based Platforms
```
./webfortserver -i
```
The tool starts in interactive mode.
Specify the options that are listed in the following table to perform the required task:

Option	Description

Display Message Operations
ddn	Enables you to download display names to a file. You must enter the context name of the application whose display names you want to download, and the path where the file must be downloaded. Syntax: ddn <application_context> <file_location> Example: ddn Admin ARCOT_HOME>/logs
dmsg	Enables you to download the display messages to a file. You must enter the application context and path where the file must be downloaded. Syntax: dmsg <application_context> <file_location> Example: dmsg Admin ARCOT_HOME>/logs
udn	Enables you to upload the file containing the customized display names to the database. Syntax: udn <file_path>
umsg	Enables you to upload the file containing the customized display messages to the database. Syntax: umsg <file_path>
Plug-In Configurations
getmodconf	Fetches the configuration for the current modules. For example, credential modules and plug-ins. Syntax: getmodconf
upluginstatus	Updates the status of the plug-in. Following are the supported states: 0: Indicates that the plug-in is DISABLED. 1: Indicates that the plug-in is ACTIVE. 2: Indicates that the plug-in is NOT_LOADED. Syntax: upluginstatus
Protocol Operations
getprotoconf	Fetches the configurations for all protocols. Syntax: getprotoconf
setsvrmgmtport	Allows you to change the port number of the Server Management protocol. If you have enabled AuthMinder Server for SSL, then this tool also provides you an option to change the transport mode from SSL to TCP. Syntax: setsvrmgmtconf <Server Management port> TCP Example: setsvrmgmtconf 9743 TCP
Server Management Operations
version	Generates a file called arcotwebfort-ver-<dd>-<mmm>-<yy>.txt, which lists the version of all AuthMinder library files. This file is available in the following directory: Windows: <install_location>\Arcot Systems\logs UNIX-Based Platforms: <install_location>/arcot/logs Syntax: version
Utility Operations
??	Searches the commands based on the pattern you provide. Syntax: ?? <search text> Example: ?? conf All the options that set or get configurations are displayed. For example: getmodconf getprotoconf
?	Lists the commands supported by arwfserver. If you provide the command name along with this option, then the tool provides help on command usage. Syntax: ? Lists all the supported commands ? <command_option> Provides help on the command usage. Example: ? setsvrmgmtport Explains the usage of set server management port command.
help	Provides the help on the command usage. Syntax: help <command_option> Provides help on the command usage. Example: help setsvrmgmtport Explains the usage of set server management port command.
log2c	Allows you to write the logs to the Console. Enter Y to write the logs to the Console or N to write the logs to the file. Syntax: log2c <option> Example: log2c n
q	Closes the interactive mode.