PingAccess cluster upgrade parameters

The command-line parameters are the same regardless of the platform and are defined as follows:

Parameter definitions

Parameter Value description

Parameter	Value description
-r \| --disable-config-replication	Disables configuration replication on the admin node. You can find more information about using this parameter in an upgrade in Zero Downtime Upgrade.
-p <admin_port>	Optional port to be used by the temporary PingAccess instance run during the upgrade. The default is `9001`.
-i <directory>	An optional directory containing additional library `.jar` files, such as plugins, and Java Database Connectivity (JDBC) drivers to copy into the target installation. Beginning in PingAccess 6.0, you can find `.jar` files in the <PA HOME>/deploy` folder. During an upgrade from versions earlier than 6.0, third-party `.jar` files are migrated from the `lib` folder to the `deploy` folder if no directory is specified. During an upgrade from version 6.0 or later, the contents of the `deploy` folder are migrated to the new `<PA HOME>/deploy` folder if no directory is specified.
<sourcePingAccessRootDir>	The <PA_HOME> for the source PingAccess version.
-l <newPingAccessLicense>	An optional path to the PingAccess license file to use for the target version. If not specified, the existing license is reused.
-j <jvm_memory_options_file>	An optional path to a file with Java Virtual Machine (JVM) memory options to use for the new PingAccess instance during the upgrade.
-s \| --silent	Run the upgrade with no user input required. To use this option, specify the source version’s credentials using environment variables.

-r | --disable-config-replication

Disables configuration replication on the admin node.

You can find more information about using this parameter in an upgrade in Zero Downtime Upgrade.

-p <admin_port>

Optional port to be used by the temporary PingAccess instance run during the upgrade.

The default is 9001.

-i <directory>

An optional directory containing additional library .jar files, such as plugins, and Java Database Connectivity (JDBC) drivers to copy into the target installation.

Beginning in PingAccess 6.0, you can find .jar files in the <PA HOME>/deploy` folder.

During an upgrade from versions earlier than 6.0, third-party .jar files are migrated from the lib folder to the deploy folder if no directory is specified.
During an upgrade from version 6.0 or later, the contents of the deploy folder are migrated to the new <PA HOME>/deploy folder if no directory is specified.

<sourcePingAccessRootDir>

The <PA_HOME> for the source PingAccess version.

-l <newPingAccessLicense>

An optional path to the PingAccess license file to use for the target version.

If not specified, the existing license is reused.

-j <jvm_memory_options_file>

An optional path to a file with Java Virtual Machine (JVM) memory options to use for the new PingAccess instance during the upgrade.

-s | --silent

Run the upgrade with no user input required.

To use this option, specify the source version’s credentials using environment variables.

Environment variables

You can specify the username and password for the source version using these environment variables:

PA_SOURCE_API_USERNAME: The username for the source version’s Admin API. Set this value to Administrator.
PA_SOURCE_API_PASSWORD: The basic authorization password for the administrator in the source version’s Admin API.

Java virtual machine (JVM) memory options

The following options can be included in the JVM memory options file:

-Xms<amount>: Minimum heap size.
-Xmx<amount>: Maximum heap size.
-XX:NewSize=<amount>: Minimum size for the Young Gen space.
-XX:MaxNewSize=<amount>: Maximum size for the Young Gen space.
-XX:+UseParallelGC: Specifies that the parallel garbage collector should be used.

Memory amounts use m or g to specify the unit.

You can copy the existing <PA_HOME>/conf/jvm-memory.options file to create a JVM memory options file for the upgrade.

Example

#Sample JVM Memory options file
-Xms512m
-Xmx1g
-XX:NewSize=256m
-XX:MaxNewSize=512m
-XX:+UseParallelGC