ccm backup and ccm backup schedule command options

Last Updated : Jan 08, 2026 |

You can run the ccm backup command on its own or with various options.

The following table lists the ccm backup command options.

Command option

Description

ccm backup

Use this command to perform a backup. If you run this command on its own, the backup file is stored in either the local or remote directory, depending on the configured archive destination.

ccm backup setpassword

Run this command to reconfigure the backup file password.

ccm backup --local

Use this command to store the backup file in the local directory at /var/avaya/artifactCache/ccmClusterBackup.

ccm backup --remote-server

Use this command to store the backup file on your remote server. You must also specify the details of your remote server. For example, run this command as follows:

ccm backup --remote-server "<FQDN/IP> [-p <port>] -u <username> -d <directory path>"
Note:

ccm backup --remote-server replaces the ccm backup --sftp-destination command.

ccm backup --local --password or ccm backup --remote-server --password

Use the --password option if you want to override the configured backup file password. This command prompts you for a new backup password.

ccm backup schedule

This command displays the backup schedule.

ccm backup schedule --history

This command displays the backup schedule history.

ccm backup schedule --sync

Run this command to synchronize the backup schedule configuration to the cluster.

ccm backup schedule -t <time>

Run this command to reconfigure the time when the scheduled backup will run.

Enter the time in the hh:mm 24-hour time format. For example, replace <time> with 19:00 if you want the backup to run at 7pm.

ccm backup schedule -d

Run this command to set the backup recurrence to daily.

ccm backup schedule -d [-r <recurrence> -t <time> -e <True|False>]

When setting the backup recurrence, you can optionally include the -r, -t, and -e parameters to reconfigure other scheduled backup settings.

    • -r is the Backup Recurrence Multiple setting. Enter a number, which defines how often the backup will run.

      For example, if you enter 3, the backup will occur every three days.

    • For more information about -t <time>, see the ccm backup schedule -t <time> command description above.

    • -e indicates whether the scheduled backup is enabled. Enter True or False.

ccm backup schedule -w <day_of_week>

Run this command to set the backup recurrence to weekly. You must also specify the day of the week.

For example, you can run ccm backup schedule -w monday if you want the backup to run on Mondays.

ccm backup schedule -w <day_of_week> [-r <recurrence> -t <time> -e <True|False>]

When setting the backup recurrence, you can optionally include the -r, -t, and -e parameters to reconfigure other scheduled backup settings.

  • -r is the Backup Recurrence Multiple setting. Enter a number, which defines how often the backup will run.

    For example, if you enter 3, the backup will occur every three weeks.

  • For more information about -t <time>, see the ccm backup schedule -t <time> command description above.

  • -e indicates whether the scheduled backup is enabled. Enter True or False.

ccm backup schedule -m <date>

Run this command to set the backup recurrence to monthly. Specify the date when you want the backup to run.

For example, replace <date> with 5 if you want the backup to run on the 5th of the month. If you enter 31 and the month does not have 31 days, the backup will run on the last day of the month.

ccm backup schedule -m <date> [-r <recurrence> -t <time> -e <True|False>]

When setting the backup recurrence, you can optionally include the -r, -t, and -e parameters to reconfigure other scheduled backup settings.

  • -r is the Backup Recurrence Multiple setting. Enter a number, which defines how often the backup will run.

    For example, if you enter 3, the backup will occur every three months.

  • For more information about -t <time>, see the ccm backup schedule -t <time> command description above.

  • -e indicates whether the scheduled backup is enabled. Enter True or False.