---
title: Export configuration data
description: Amster can export configuration data from an AM instance. Export configuration data by using the export-config command.
component: pingam
version: 7.2
page_id: pingam:amster:export-config
canonical_url: https://docs.pingidentity.com/pingam/8.1/amster/export-config.html
llms_txt: https://docs.pingidentity.com/pingam/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
page_aliases: ["user-guide:amster-export-config.adoc"]
superseded_by: https://docs.pingidentity.com/pingam/8.1/amster/export-config.html
section_ids:
  export-data-examples: Examples
  export_entire_configuration: Export entire configuration
  export_selected_configuration: Export selected configuration
---

# Export configuration data

Amster can export configuration data from an AM instance. Export configuration data by using the `export-config` command.

The exported configuration data is written to a number of JSON-formatted files. The files are arranged in a hierarchy of global and realm configuration data.

To export encrypted password values in the configuration files you must generate and install a *transport key*. See [Create transport keys to export configuration data](transport-keys.html).

**Usage:**

```
am> export-config --path Path [options]
```

* `--path Path`

  The path into which exported configuration files are placed.

  Existing files will be overwritten if they exist. The path is created if it does not exist.

**Options:**

* `--realms "Realm" […​]`

  Space-separated list of realms from which to export. Specify the full path of each realm, and enclose the list in quotation marks. Use a single forward-slash (`/`) to represent the top-level root realm.

  Example: `export-config --realms "/ /subRealm1 /subRealm2"`

  Default: all

* `--realmEntities Entity […​]`

  Space-separated list of realm-based entities to export.

  Use a space character in single-quotes (`' '`) to specify that no realm-based entities should be exported.

  For a list of the available entities, refer to the [Entity reference](../entity-reference/preface.html).

  Default: all

* `--globalEntities Entity […​]`

  Space-separated list of global entities to export.

  Use a space character in single-quotes (`' '`) to specify that no global entities should be exported.

  For a list of the available entities, refer to the [Entity reference](../entity-reference/preface.html).

  Default: all

* `--failOnError [true|false]`

  If specified, the export process halts if an error occurs.

  Default: `false`

* `--listPasswords [true|false]`

  If specified, the export process creates a listing of entities that contain password data. The listing is stored in a file in the root of the specified export directory.

  Default: `false`

## Examples

Before trying the following examples, start the Amster command-line interface, and connect to the AM instance from which to export data.

For information on connecting to AM instances, refer to [Connect to AM](connect-am.html).

### Export entire configuration

This example exports all configuration data, and will fail immediately if an error occurs.

```
am> export-config --path /tmp/myExportedConfigFiles --failOnError true
Export completed successfully
```

### Export selected configuration

This example exports the configuration for the `DataStoreModule`, `Scripts`, and `OAuth2Provider` entities in a subrealm of the root realm named `mySubRealm`.

Configuration data for global entities is not exported.

```
am> export-config --path /tmp/myExportedConfigFiles --realms '/mySubRealm' \
  --realmEntities 'DataStoreModule Scripts OAuth2Provider' --globalEntities ' '
Export completed successfully
```
