ctmdbbck

The ctmdbbck utility backs up an image of the Control-M/Server database to a binary file.

Do not use this utility if Control-M/Server was installed with an external Oracle or PostgreSQL database. You can back up these databases with the ctm_backup_bcp utility.

Differences Between the ctm_backup_bcp and ctmdbbck Utilities

The following table shows the differences between the ctmdbbck and ctmdbbck utilities.

ctm_backup_bcp Utility

ctmdbbck Utility

Exports data from the Control-M/Server database.

Backs up an image of the Control-M/Server database, which can be restored with the ctmdbrst utility.

Backs up to a default directory location.

Backs up to a directory location that you can define.

Backs up each database folder to a separate ASCII file.

Backs up the entire database to a binaryClosed A compiled program file that enables Control-M or other software to run, such as an executable file, shared library, and Control-M-supplied utility that is located in the Control-M installation directories..

The original and restored databases do not need to be the same size.

For all databases, except PostgreSQL, the restored database must be the same size as the original database.

Supports the following database server types:

  • PostgreSQL

    • BMC-supplied and dedicated

    • External

  • Oracle: External

  • MSSQL: External

Supports the following database server types:

  • PostgreSQL: BMC-supplied and dedicated

  • MSSQL: External

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 an image of the Control-M/Server database to a binary file.

Begin

  1. Log in to the account where Control-M/Server is installed.

  2. Do one of the following to run the utility in interactive or silent mode:

    • Interactive Mode: Run the following command:

      ctmdbbck

    • Run the following commands:

      • UNIX: ctmdbbck [ -p<Administrator_Password>] [ -f<Administrator_Password_File>] [ -d<Backup_Directory_or_File_Pathname>] [ -m<Backup_Mode_H/C>]

      • Windows: ctmdbbck [ -p<Administrator_Password>] [ -f<Administrator_Password>] [ -d<Backup_Directory_or_File_Pathname>]

Backing Up the Control-M/Server MSSQL Database

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

Before You Begin

  • Shut down Control-M/Server as described in shut_ctm.

  • Shut down the Configuration Agent, as described in shut_ca.

Begin

  1. Log in to the account where Control-M/Server is installed.

    • For Windows client installations, open a command prompt and navigate to the <Control-M/Server_Home>\ctm_server\directory.

  2. Do one of the following, based on your operating system: 

    • UNIX: Run the following command:

      ctmdbbck

    • Windows: Do the following:

      1. Navigate to the following directory:

        <Control-M/Server_Home>\ctm_server\directory

      2. Run the following command:

        ctmdbbck

  3. Follow the prompts to continue the backup.

    For MSSQL, you are prompted for the backup device (<backupDevice>). The device that is defined by this parameter must be one of the following:

    • A valid device defined in an existing MSSQL.

    • The pathname of a file to be created by the backup procedure for MSSQL.

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

Backing Up the Control-M/Server Dedicated PostgreSQL Database

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

Before You Begin

  • Shut down Control-M/Server as described in shut_ctm.

  • Shut down the Configuration Agent, shut_ca.

Begin

  1. Do one of the following:

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

    • Windows: Open a command prompt on the Control-M/Server host.

      For Windows client installations, open a command prompt and navigate to the <Control-M/Server_Home>\ctm_server\directory.

  2. Enter the following command:

    ctmdbbck

    For MSSQL, you are prompted for the backup device (<backupDevice>).

  3. Follow the prompts to continue the backup.

    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 on the Control-M/Server host.

  2. Enter the following command:

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

    With a PostgreSQL databse, silent mode is available only on UNIX.

ctmdbbck Utility Examples

  • The following command is run to backup the Control-M/Server database where Control-M/Server was installed with an existing MSSQL database server and the backup device is named scontrolm_data_bkp:

    ctmdbbck controlm_data_bkp

  • The following command is run to back up the Control-M/Server database where Control-M/Server was installed with a dedicated PostgreSQL database server:

    ctmdbbck

    You are prompted for the required parameters.