---
title: Amster usage examples
description: In this section, you can find examples of tasks you can do with Amster.
component: pingam
version: 8.1
page_id: pingam:amster:usage-examples
canonical_url: https://docs.pingidentity.com/pingam/8.1/amster/usage-examples.html
page_aliases: ["user-guide:amster-usage-examples.adoc"]
section_ids:
  clone-example: Clone an PingAM instance
  amster-samples: Amster sample scripts
---

# Amster usage examples

In this section, you can find examples of tasks you can do with Amster.

|   |                                                                                                                                           |
| - | ----------------------------------------------------------------------------------------------------------------------------------------- |
|   | Find Amster examples in Docker and Kubernetes deployments in the [ForgeOps](https://docs.pingidentity.com/forgeops/2025.1) documentation. |

## Clone an PingAM instance

This example shows the high-level steps required to clone an AM instance, from exporting the configuration of the original instance, to installing the new instance and importing the configuration into it.

Follow these steps to clone an AM instance using Amster:

1. Create a transport key in the original AM instance, if one does not exist already. Learn more in [Create transport keys to export configuration data](transport-keys.html).

2. Keep the transport key safe by exporting it to another keystore. The key is required to import the configuration into the new AM instance. Learn more in [Duplicate and install a transport key](transport-keys.html#duplicate-key).

3. Connect to the original AM instance using the `amster` command. Learn more in [Connect to AM](connect-am.html).

4. Export all the configuration of the original AM instance using the `export-config` command. Learn more in [Export configuration data](export-config.html).

5. Take note of the value of the Password Encryption Key field on the original AM, for example, `O6QWwHPO4os+zEz3Nqn/2daAYWyiFE32`.

   To locate it, log in to the original AM instance, and navigate to Deployment > Servers > *server name* > Security > Encryption.

6. In the new server, deploy the AM `.war` file in a web container, but don't configure it.

7. Install the new AM instance using the `install-openam` command, specifying the original AM password encryption key with the `--pwdEncKey` option. For example:

   ```
   am> install-openam \
    --serverUrl \https://am.example.com:8443/am \
    --adminPwd password \
    --pwdEncKey O6QWwHPO4os+zEz3Nqn/2daAYWyiFE32 \
    --acceptLicense
   ```

   Learn more in [Passive install using Amster](../installation/passive-install-amster.html).

8. Import the transport key of the original AM instance into the keystore of the new AM instance. Learn more in [Duplicate and install a transport key](transport-keys.html#duplicate-key).

9. Connect to the new AM instance using the `amster` command. Learn more in [Connect to AM](connect-am.html).

10. Import the configuration of the original AM instance using the `import-config` command. Learn more in [Import configuration data](import-config.html).

## Amster sample scripts

This section covers sample scripts and files found in the `/path/to/amster/samples` directory:

* `transport-key.sh`

  Shell script to manage transport keys. You can use it as a template for your own scripts to create, delete, and export the key to another keystore.

  Invoke the script's help for a list of possible actions:

  ```
  $ ./transport-key.sh help
  ```

  Find more information about the transport key in [Create transport keys to export configuration data](transport-keys.html).

* `realm.amster`

  Amster script containing an example of different operations that can be done at realm level, such as creating a data store, displaying its configuration, modifying it, and deleting it.

  Find more information about writing scripts for Amster in [Scripts](scripts.html).

* `import-example.amster`

  Amster script containing an example of the `import-config` command.

  Find more information about writing scripts for Amster in [Scripts](scripts.html).

* `export-example.amster`

  Amster script containing an example of the `export-config` command.