Prev |  | Next

## Server Administration

This topic describes tasks and tools related to managing the AMS server itself.

## Starting and Stopping the Server

The bin directory contains the script file to start the Artifact Management Server. Run the following commands from the AMS command prompt, Windows command prompt, or Linux or macOS terminal window (depending on which platform AMS is installed), using the login credentials as configured in the `AMS.conf` file.

Command | Action
--- | ---
ams-server | starts AMS
ams-admin shutdown | stops AMS ### Note This command is expected to be implemented in a future release. Alternatively, pressing Ctrl+C will suffice, which also notifies users currently logged into the web client that the server is shutting down.

## Passing JVM Arguments After AMS Server is Started

AMS supports passing standard JVM arguments upon AMS server startup. The following example sets the AMS server's starting and maximum heap sizes to 1GB and 2GB, respectively, where each JVM argument requires a separate `-J`:

    ams-server -J -Xms1g -J -Xmx2g

Other standard JVM arguments, including those preceded with `-X` or `-verbose` are also supported. Describing JVM arguments is beyond the scope of this Guide.

## AMS Command Reference

Enter AMS commands from the AMS command prompt, Windows command prompt, or Linux or macOS terminal window (depending on which platform AMS is installed). The following describes the AMS commands, their arguments, and options.

ams-server [--help] [--version] [--conf <filename>] [--nobackup] [--cipher [<cleartext>]]

ams-server --help

  Lists available commands and their descriptions.

ams-server

  Starts the AMS server (with no arguments). Note: the Help displays ams-server --run, which also starts the server, but is redundant to the preferred ams-server (with no arguments) command.

ams-server --version

  Displays the current AMS version and exits.

ams-server --conf <filename>

  Use the specified HOCON configuration file. Configuration files can be absolute or relative to the current working directory.

ams-server --nobackup

  After an upgrade to a new AMS upgrade, if AMS server determines during startup that its database schema needs to be updated, it normally makes a copy of the database file before performing the upgrade. Use this option to prevent a backup from being made.

ams-server --cipher [<cleartext>]

  Enciphers clear text. The resulting ciphertext can be used in password fields in the AMS configuration file.

ams-admin shutdown

  Stops AMS. This command is expected to be implemented in a future release. Alternatively, pressing Ctrl+C will suffice, which also notifies users currently logged into the web client that the server is shutting down.

Prev | Up | Next
| Home |