Backing up Common Services

Last Updated : Aug 29, 2022 |

About this task

Use this procedure to generate a backup file for Common Services. This backup does not contain product application data.

The following content is included in this Common Services backup:

  • Local users for the system

  • Product configurations

  • Infrastructure configurations

  • System certificates

You can run ccm backup on Cluster Control Manager to manually create a backup. You are automatically prompted to perform a backup during a major infrastructure or service change using the ccm upgrade or ccm install commands.

Avaya recommends taking a backup after any configuration changes to the system or deployed products.

Note:

Avaya Analytics™ database also uses this archive destination for remote backups. Changing the remote server here overwrites it for Avaya Analytics™ remote database backup destination.

Procedure

  1. Log in to Cluster Control Manager.
  2. To manually start a backup, run one of the following commands:

    • ccm backup: Stores the backup file in either the local or remote directory, depending on the archive destination you configured.

      The local directory location is /var/avaya/artifactCache/ccmClusterBackup. The remote location is <base directory path>/ccmClusterBackup.

    • ccm backup --local: Stores the backup file in the local directory at /var/avaya/artifactCache/ccmClusterBackup. This command overrides the configured archive destination.

    • ccm backup --remote-server "<FQDN/IP> [-p <port>] -u <username> -d <directory path>": Stores the backup file in the remote directory you specify. This command overrides the configured archive destination.

      Include the double quotes as shown above for the --remote-server option. If you omit these quotes, the command will fail.

      You need to include -p <port> if you are using a port other than the default port 22.

  3. When you are prompted to proceed with the backup, enter y.

    For local backups, confirm that the oldest backup file may be deleted.

    There are two backup archives located /var/avaya/artifactCache/ccmClusterBackup. The oldest one will be deleted
Do you wish to proceed?
Response [y, n] => y
  4. If you used the --remote-server option in step 2, enter the remote server password when prompted.
  5. If you did not configure a backup password, enter one when prompted.

    This password is used to encrypt the generated backup file. You will need this password to perform restore operations.

    The password must be at least 8 characters long and contain at least the following:

    • One upper case character

    • One lower case character

    • One number

    • One special character

  6. Wait for the backup to complete.

    You will be notified of the location of the .tgz backup file.

  7. If the backup file is in the local /var/avaya/artifactCache/ccmClusterBackup directory, copy it to a secure location and transfer it off of Cluster Control Manager.

    You are prompted when more than two backups are in the local directory.

    For scheduled backups, only the two most recent backup files are kept in the local directory.

  8. Optional To free up space for future use, remove the backup file.