---
title: upgrade.jar
description: Upgrade AM using a configuration file.
component: pingam
version: 8
page_id: pingam:am-reference:man-upgrade-jar
canonical_url: https://docs.pingidentity.com/pingam/8/am-reference/man-upgrade-jar.html
keywords: ["Administration", "Upgrade", "Configuration"]
page_aliases: ["reference:man-upgrade-jar.adoc"]
section_ids:
  man-upgrade-jar-desc: Description
  man-upgrade-jar-options: Options
  man-upgrade-jar-upgrade: Upgrade configuration file
  upgrade_properties: Upgrade properties
  man-upgrade-jar-examples: Examples
---

# upgrade.jar

Upgrade AM using a configuration file.

```
upgrade.jar { options }
```

## Description

This executable jar file, `openam-upgrade-tool-14.1.3.30.jar`, lets you perform a silent upgrade on a deployed AM server by applying settings from a configuration file or using arguments. This capability allows you to include the `upgrade.jar` from a command line or in an upgrade script.

## Options

The following options are supported.

* `-f | --file configuration-file`

  Upgrade a deployed AM web application archive using the specified configuration file. Upgrade configuration files are described in the sections below. Also, you can specify the system properties on the command line, instead of using the configuration file.

* `--acceptLicense`

  Auto-accept the software license agreement and suppress the display of the licence acceptance page to the user. If the configuration file contains the `ACCEPT_LICENSES` property, it will have precedence over the command-line option.

* `-? | --help`

  Display the usage message.

## Upgrade configuration file

Base your configuration on the `sampleupgrade` file delivered with AM, and using the hints in this section, or the comments included in the file.

### Upgrade properties

* SERVER\_URL

  URL to the web container where AM runs, such as `https://am.example.com:8443`.

* DEPLOYMENT\_URI

  URI where AM is deployed on the web container, such as `/am`.

* ACCEPT\_LICENSES

  Optional boolean property that can be set to always auto-accept the software license agreement and suppress displaying the license acceptance page to the user. A value of `true` auto-accepts the license; any other value will be assumed to equal `false`, resulting in the presentation of the license. Default value is `false`. This property takes precedence over the `--acceptLicense` option, which can also be passed in to the application with the `openam-upgrade-tool-14.1.3.30.jar` file.

## Examples

The following example shows a configuration file and the commands to upgrade a server using the `upgrade.jar`. The configuration file is saved as `/tmp/upgrade.txt`.

```properties
SERVER_URL=https://am.example.com:8443
DEPLOYMENT_URI=/am
ACCEPT_LICENSES=true
```

```bash
$JAVA_HOME/bin/java -jar ~/am/tools/openam-upgrade-tool-14.1.3.30.jar -f /tmp/upgrade.txt
```

The following example shows how to specify system properties with the `upgrade.jar`.

```properties
SERVER_URL=https://am.example.com:8443
DEPLOYMENT_URI=/am
ACCEPT_LICENSES=true
```

```bash
$JAVA_HOME/bin/java -jar ~/am/tools/openam-upgrade-tool-14.1.3.30.jar \
 -DSERVER_URL=https://am.example.com:8443 -DDEPLOYMENT_URI=/am
```

The following example shows the use of the `--acceptLicense` option with the `upgrade.jar`.

```properties
SERVER_URL=https://am.example.com:8443
DEPLOYMENT_URI=/am
```

```bash
$JAVA_HOME/bin/java -jar ~/am/tools/openam-upgrade-tool-14.1.3.30.jar \
 -DSERVER_URL=https://am.example.com:8443 -DDEPLOYMENT_URI=/am \
 --acceptLicense
```