Restoring Avaya Common Services in an offline air gap environment

Last Updated : Feb 17, 2026 |
Prolog information
Metadata
Keywords:
In an air gap network environment, use this procedure to recover from a full cluster outage when one or more of the virtual machines in the solution are lost. This procedure restores Cluster Control Manager, infrastructure, and services. It does not restore service application data.
Note:
This restore process is supported if the cluster or service version in the backup file is Common Services 1.3.0.x or later.
Before you begin
  • Perform a backup and locate your backup file.
  • Ensure that you have the password for the backup file.
  • Assess the node cluster state to determine which option to use for the restoration. For more information about the options, see Assessing cluster state.
  1. Log in to Cluster Control Manager.
  2. Copy the backup file to Cluster Control Manager using a file transfer utility, such as WinSCP.
    ADDITIONAL INFORMATION:
    You can use the /tmp or /var/avaya/artifactCache/ccmClusterBackup directory.
  3. Change the directory to the location where you transferred the backup onto Cluster Control Manager.
  4. Create a temporary directory by running the mkdir ./temp command.
  5. Run tar -C ./temp/ -zxf <backup file name> ccm/config/*.gpg to extract the Cluster Control Manager encrypted backup file.
  6. Run gpg --yes --batch ./temp/ccm/config/*.gpg to extract the Cluster Control Manager backup .tar file from the encrypted backup file.
  7. When prompted, enter the password that you used to encrypt the backup file.
    ADDITIONAL INFORMATION:
    The following is displayed after you enter the password: 
    gpg: CAST5 encrypted data
    
gpg: encrypted with 1 passphrase
    
gpg: WARNING: message was not integrity protected
  8. Take note of the name of the .tgz file in the ./temp/ccm/config/ directory for the next step.
    ADDITIONAL INFORMATION:
    You can run ls ./temp/ccm/config/ to find the file.
  9. Extract the cluster-config and solution services file, which contains the software artifact information that was deployed in the cluster.
    ADDITIONAL INFORMATION:
    Run the following commands:
    • tar -C ./temp/ -zxf ./temp/ccm/config/<replace_with_the_tgz_file_from_the_previous_step> backup/clusters/*/releases/initial-service.yaml
    • tar -C ./temp/ -zxf ./temp/ccm/config/<replace_with_the_tgz_file_from_the_previous_step> backup/clusters/*/meta/cluster-config.yaml
    For example, where <replace_with_the_tgz_file_from_the_previous_step> is 10.10.10.140-1.1.100011050115-202011172342-ccmbackup.tgz, run the following:
    • tar -C ./temp/ -zxf ./temp/ccm/config/10.10.10.140-1.1.100011050115-202011172342-ccmbackup.tgz backup/clusters/*/releases/initial-service.yaml
    • tar -C ./temp/ -zxf ./temp/ccm/config/10.10.10.140-1.1.100011050115-202011172342-ccmbackup.tgz backup/clusters/*/meta/cluster-config.yaml
  10. Run the following commands to recreate the solution deployment file (solution-backup.yaml):
    ADDITIONAL INFORMATION:
    • cat ./temp/backup/clusters/*/meta/cluster-config.yaml > ./solution-backup.yaml
    • cat ./temp/backup/clusters/*/releases/initial-service.yaml >> ./solution-backup.yaml
    • chmod 644 $PWD/solution-backup.yaml
  11. Run ls $PWD/solution-backup.yaml to obtain the absolute path to the solution deployment file.
  12. Based on the fully qualified path displayed, transfer the solution-backup.yaml file to the client computer where the ccm-ctl-agn container is running.
  13. Run rm -rf ./temp to delete the temporary directory that contained the extracted backup content on Cluster Control Manager.
  14. On the client computer where the ccm-ctl-agn container is running, use the solution-backup.yaml file to download the Avaya solution software artifacts and then upload them to Cluster Control Manager.
    1. Run agn download solution-backup.yaml to download the solution software artifacts.
    2. Configure and start the local chart museum and Docker registry on Cluster Control Manager.
    3. Copy the software artifacts onto Cluster Control Manager.
    4. Upload the software artifacts to the Cluster Control Manager local chart museum and Docker registry.
      ADDITIONAL INFORMATION:
      You can proceed with the remaining steps in this procedure after all solution software artifacts are uploaded to the Cluster Control Manager chart museum and Docker registry.
  15. On Cluster Control Manager, run the screen command to run the restore process in the background.
    ADDITIONAL INFORMATION:
    When running the restore process in the background, if you need to detach from the SSH session, see Detaching from the restore SSH session.
  16. Run one of the following commands to start the restore process:
    ADDITIONAL INFORMATION:
    Note:
    If your backup file is not accessible on a remote server, copy the backup file to Cluster Control Manager using a file transfer utility such as WinSCP.
    You can use the /tmp or /var/avaya/artifactCache/ccmClusterBackup directory.
    • ccm restore all --remote-server "<FQDN/IP> [-p <port>] -u <username>" <path to backup file>: Restores from the remote directory path 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.
    • ccm restore all --local <path to backup file>: Restores from the local <path to backup file> directory. This command overrides the configured archive destination.
    • ccm restore all <path to backup file>
    ADDITIONAL INFORMATION:
    In these command options, replace <path to backup file> with the full path to the backup file. For example, /var/avaya/artifactCache/ccmClusterBackup/<backup-file>.tgz or home/<customer>/<backup-file>.tgz.
    Use the same archive destination (local or remote) that you used for the backup.
  17. If you did not configure the password for the backup file, enter it when prompted.
  18. To confirm the restore, type y.
  19. When prompted for your Avaya SSO and vCenter credentials, enter the credentials for the Cluster Control Manager local Docker registry. Note that this prompt may differ, depending on whether you are restoring on existing virtual machines or restoring on new virtual machines.
    ADDITIONAL INFORMATION:
    If you receive an Error logging into docker registry message while trying to log in, contact Avaya support personnel for assistance.
  20. Wait for the cluster to fully initialize.
Next steps
  • The restore process disables file integrity validation. If you enabled file integrity validation previously, you can re-enable it by running the clusterFileIntegrity enable command.
  • If you imported third-party certificates, the system will not recognize them after the restore. Therefore, you must repeat the import process for the restored cluster to use new third-party certificates.