Use > Configuration Manager > Appendixes > Utilities > Export Configuration Set

Export Configuration Set

The Export Configuration Set utility enables you to export a configuration set to a configuration dump file. Configuration dump files can later be imported to the same instance of Configuration Manager but with a different name, or a different instance of Configuration Manager. This is useful, for example, when you have a staging/test environment and would like to migrate the configuration set to a production environment.

Note This functionality is also available within the Configuration Manager UI. Use this utility only in situations where for some reason the UI is locked, for example, when you started Configuration Manager with an invalid configuration and the server cannot start.

This utility does not require the Configuration Manager server to be up.

To export a configuration set:

Run the following command:

<Configuration_Manager_installation_directory>\bin\export-cs.bat <database properties> <configuration set ID><dump file name>

where <database properties> can be specified by pointing to the location of the database.properties file or by specifying each database property.

To locate the configuration set ID, run the Export Configuration Set utility using the --history or --drafts options to list all historic and draft configuration sets. Historic configuration sets include all configuration sets that were ever activated, including the current configuration set.

Following are the command line <options>:

Option Description
--connection-url

Database connection URL

Note Use this only if -p is not used. Use it with --dialect, --driver, --username and --password.

--dialect

Database dialect.

Supported dialects: H2Dialct, SQLServerDialect, Oracle9iDialect, Oracle10gDialect

Note Use this only if -p is not used. Use it with --connection-url, --driver, --username and --password.

--driver

Database driver class name. For example: org.h2.Driver, net.sourceforge.jtds.jdbc.Driver, oracle.jdbc.OracleDriver.

Note Use this only if -p is not used. Use it with --connection-url, --dialect, --username and --password.

--drafts Display the configuration set drafts - all non-activated configuration sets

-f <filename>

--file <filename>

Dump file name

Note This option is required

-h

--help

Usage message
--history Display the configuration set history - all activated configuration sets

-i <id>

--Id <id>

ID of the configuration set to export

-p <file>

--database-properties <file>

Location of the database.properties file.

Note This option is required unless you use --connection-url, --driver, --username and --password to specify the database properties.

--password

Database password

Note Use this only if -p is not used. Use it with --connection-url, --dialect, --driver and --username.

--username

Database username

Note Use this only if -p is not used. Use it with --connection-url, --dialect, --driver and -password

--verbose Verbose mode
  • An example of how to list historic configuration sets is:

    cd <CM installation home>\bin\
    export-cs.bat -p ..\conf\database.properties --history
    
  • To export a configuration set:

    <cm-install>\bin\export-cs.bat -p <database.properties location> -i <configuration set id> -f <dump filename>
    

    For example, to export a configuration set with an id 1 to the dump.zip:

    cd <CM installation home>\bin\
    export-cs.bat -p ..\conf\database.properties -i 1 -f dump.zip