ctmdbbck

The ctmdbbck utility backs up the Control‑M/Server database in the following cases:

  • Control-M/Server was installed by using a dedicated PostgreSQL database server. Do not use this utility if Control-M/Server was installed with an Oracle database (either existing or dedicated) or an existing PostgreSQL database.

  • To back up an existing Oracle database or an existing PostgreSQL database, use the ctm_backup_bcp utility, as described in ctm_backup_bcp.

  • Control-M/Server was installed by using an MSSQL database server.

For information about Archive mode, see Set Database Archive Mode referred to in the table in Accessing the Database Utilities Menu.

When using PostgreSQL, after specifying this utility you are prompted to enter the DBA password to access the Control-M/Server database.

Running the ctmdbbck Utility

This procedure describes how to run the ctmdbbck utility to back up the Control-M/Server database.

Begin

  1. Do one of the following:

    • UNIX: Log in to a Control-M/Server account

    • Windows: Open a command prompt window where Control-M/Server is installed.

  2. Enter the following the command prompt to use the interactive menu to back up the ControlM/Server database:

    ctmdbbck

  3. To run the ctmdbbck utility not in an interactive mode, run ctmdbbck and specify the following parameters:

    • UNIX

      ctmdbbck [ -p<administrator password>]

      [ -f<administrator password file>]

      [ -d<full path of backup directory/file>]

      [ -m<backup mode H/C>]

    • Windows

      ctmdbbck [ -p<administrator password>]

      [ -f<administrator password file>]

      [ -d<full path of backup directory/file>]

Backing up the Control-M/Server Database

This procedure describes how to back up the Control-M/Server database (not PostgreSQL)

Begin

  1. Shut-down Control-M/Server and Control-M/Server Configuration Agent before running this utility.

  2. Do one of the following:

    • UNIX: Log in to a Control-M/Server account

    • Windows: Open a command prompt window where Control-M/Server is installed.

      For Windows client installations, open a command prompt window and navigate to the <Server Home>\ctm_server\directory.

  3. Enter the following command:

    ctmdbbck

  4. Continue the backup by following the prompts.

    For MSSQL – You are prompted for the backup device (<backupDevice>).

    The device that is specified for this parameter must be either:

    • a valid device defined in an existing MSSQL

    • the full path name of a file to be created by the backup procedure for MSSQL

  5. If no backup devices exist, or you want to use a new backup device, choose 6 - Add Backup Device from the Database Maintenance menu.

Backing up the Control-M/Server Database (PostgreSQL)

This procedure describes how to back up the Control-M/Server database when using PostgreSQL.

Begin

  1. Shut-down Control-M/Server and Control-M/Server Configuration Agent before running this utility.

  2. Do one of the following:

    • UNIX: Log in to a Control-M/Server account

    • Windows: Open a command prompt window where Control-M/Server is installed.

      For Windows client installations, open a command prompt window and navigate to the <Server Home>\ctm_server\directory.

  3. Enter the following command:

    ctmdbbck

    For MSSQL – You are prompted for the backup device (<backupDevice>).

  4. Continue the backup by following the prompts.

    Prompts and messages similar to the following are displayed:

    Copy
    Please Enter Postgres Administrator Password:*******
    Detecting current archive mode ...
    Archive Mode=off
    Done.
    Enter full path destination file name:c:\bckup
    Performing Cold backup into c:\bckup ...
    backup succeeded. It is recommended to check backup file by restoring it to test
    environment.
    You can start Control-M/Server.
    The back up is complete.

Running the ctmdbbck in Silent Mode

This procedure describes how to run the ctmdbbck utility in silent mode.

Begin

  1. Do one of the following:

    • UNIX: Log in to a Control-M/Server account

    • Windows: Open a command prompt window where Control-M/Server is installed.

  2. Enter the following command:

    ctmdbbck -pmanager / -f<passwordFile> -d<backupDirectory> - m<H/C>

    When using PostgreSQL, silent mode is available only on UNIX.

ctmdbbck Utility Example

The following are examples of the ctmdbbck utility:

  • Specify the following command to backup the Control‑M/Server database where Control-M/Server was installed using an existing MSSQL database server and the backup device is controlm_data_bkp:

    ctmdbbck controlm_data_bkp

  • Specify the following command to back up the Control-M/Server database where Control-M/Server was installed by using a dedicated PostgreSQL database server:

    ctmdbbck

    You are prompted for the required parameters.