Configuration commands

Use configuration commands to manage both management and integration configuration for the Management server.

Table 1. Configuration commands
Command name Action Syntax
[V5.0.8 or later]config dbextract (from IBM® API Connect Version 5.0.8.5) [V5.0.8 or later]Export the contents of the Management server configuration database in JSON format, in a .tar file. [V5.0.8 or later]config dbextract sftp <sftp_host_name> user <username> file [<path>/]<filename>
config load apiconfig The config load apiconfig command loads a management configuration file from an FTP or SFTP server. After the configuration file is loaded on the Management server, the Management server automatically reboots.
Do not use reserved words in the user name, host name, or file name. Reserved words include: ftp, sftp, ibm, port, user, and file.
Note: When you use SFTP, you must specify a user name. Anonymous logins are not allowed with SFTP.

[V5.0.6 or later]You can also load a configuration backup file that has been created by the automatic configuration backup process, by using the local file option. To see the names of the available configuration backup files, use the config autobackup list command.

[V5.0.8 or later]From API Connect Version 5.0.8.3 onwards, you can also specify an isolation mode by using the isolate option. This option loads the management configuration file in isolation, in other words without any references to DataPower® Gateway servers, Developer Portal servers, or any third-party systems for analytics offload. Isolation mode is especially useful when you are testing an upgrade process. For more information, see Testing the upgrade process and path.

 FTP syntax:

config load apiconfig ftp <host> [port <number>] [user <username>] file [<path>/]<filename>

SFTP syntax:

config load apiconfig sftp <host> [port <number>] user <username> file [<path>/]<filename>

Configuration backup file syntax:

[V5.0.6 or later]config load apiconfig local file <filename>

[V5.0.8 or later]Isolation mode syntax:
config load apiconfig 
  [ restore | isolate ]
Where
  • restore means that the API management configuration file is loaded as is. (Note that restore mode is selected by default if no option is given.)
  • isolate means that the API management configuration file is loaded without references to DataPower Gateway servers, Developer Portal servers, or any third-party systems for analytics offload.
For example, to load a management configuration file in isolation mode from an SFTP server, use the following syntax:
config load apiconfig isolate sftp <host> [port <number>] 
  user <username> file [<path>/]<filename>
config reset Resets the connection rules for the Cloud Manager, Developer Portal, and API Manager. Port is reset to 443 and the SSL Profile resets to Default SSL Profile. config reset services
config save The config save apiconfig command saves a management configuration file to an FTP or SFTP server.
Note: Do not use reserved words in the user name, host name, or file name. Reserved words include: ftp, sftp, ibm, port, user, and file.
 FTP syntax:

When you save the configuration file to an FTP server, the Management server uses anonymous if you omit the user name.

config save apiconfig ftp <host> [port <number>] [user <username>] file [<path>/]<filename>

Example: Saves the current system configuration as old_sys_config.cfg to the FTP server that is running on host tern. The FTP user's login name is Joe.

config save apiconfig ftp tern user joe file old_sys_config.cfg

SFTP syntax:

When you save the configuration file to an SFTP server, you must specify a user name. Anonymous logins are not allowed with SFTP.

config save apiconfig sftp <host> [port <number>] user <username> file [<path>/]<filename>
[V5.0.6 or later]config autobackup [V5.0.6 or later] Enable or disable the automatic configuration backup process.

This process runs once a day at midnight UTC, and keeps configuration backup files on the local disk up to the maximum allowed space. The default maximum allowed space is 524288000 bytes but you can change this by using the config autobackup set maxsize command.

 [V5.0.6 or later]config autobackup enable|disable
[V5.0.6 or later]config autobackup status [V5.0.6 or later]Show the status of the automatic configuration backup process, and the maximum number of bytes that the configuration backup files are allowed to use on disk. [V5.0.6 or later]config autobackup status
Example output:
Enabled: true
Running: false
Max storage (bytes): 524288000
[V5.0.6 or later]config autobackup list [V5.0.6 or later]List the configuration backup files that have been created by the automatic configuration backup process. [V5.0.6 or later]config autobackup list
[V5.0.6 or later]config autobackup export local file [V5.0.6 or later]Export a configuration backup file that has been created by the automatic configuration backup process. You can export the file to an FTP or SFTP server.

To see the names of the available configuration backup files, use the config autobackup list command

 [V5.0.6 or later]FTP syntax:

config autobackup export local file <filename> ftp <host> [port <number>] [user <username>]

SFTP syntax:

config autobackup export local file <filename> sftp <host> [port <number>] user <username>
[V5.0.6 or later]config autobackup set maxsize [V5.0.6 or later]Set the maximum number of bytes on disk that can be used by backup files created by the automatic configuration backup process. The default maximum value is 524288000 bytes. [V5.0.6 or later]config autobackup set maxsize <value_in_bytes>
config autodiskadd Control the automation of disk addition to the data partition of the management server. When set to disable, the data disk that is added to the vm does not become a part of the data partition. When set to enable, and the server is rebooted, the data disk is added to the data partition, and increases the data disk size. config autodiskadd <enable/disable/status>