Restore Config: restore deleted CUCM objects

What it is for

The Restore Config page shows objects that were deleted in the CUCM or via EasyUC and for which a CUCM backup exists. You see the complete backed-up configuration and create the object in the CUCM again via AXL, exactly as it was backed up. The object receives a new UUID in the process.

The page has an Overview tab and one tab per category: Phones, Phone numbers, Translation patterns, Route patterns, End users, Application users, SIP trunks, Gateways and Gateway ports. The categories for which you have a role are visible. A category that the server does not back up yet and for which there is no data is omitted.

Distinction: Restore Phones (Phones menu) works with the device registry of EasyUC and restores phones that were deleted via EasyUC. Users deleted in cucm (Users menu) manages deleted end users with plan, cleanup and deletion log. Restore Config additionally covers objects that were deleted directly in the CUCM, and further object types. For end users, Restore Config opens the same restore dialog as Users deleted in cucm.

Prerequisites

• License module cucm and an active CUCM connection.
• The CUCM backup of the connection was enabled before the object was deleted, and the object type was selected. Without a backup, objects deleted directly in the CUCM cannot be restored. See the chapter Config Backup.
• Menu item visible with one of these roles: ROLE_APP_LIST_DELETE_DEVICE, ROLE_APP_RESTORE_DEVICE, ROLE_APP_RESTORE_DELETED_USER, ROLE_APP_RESTORE_TRANS_PATTERN, ROLE_APP_CREATE_TRANS_PATTERN, ROLE_APP_RESTORE_ROUTE_PATTERN, ROLE_APP_CREATE_ROUTE_PATTERN, ROLE_APP_RESTORE_ENDUSER.
• View phones and phone numbers: ROLE_APP_LIST_DELETE_DEVICE. Restore: ROLE_APP_RESTORE_DEVICE or ROLE_APP_RESTORE_DELETED_USER.
• View and restore translation patterns: ROLE_APP_RESTORE_TRANS_PATTERN or ROLE_APP_CREATE_TRANS_PATTERN. Route patterns: ROLE_APP_RESTORE_ROUTE_PATTERN or ROLE_APP_CREATE_ROUTE_PATTERN.
• End users: ROLE_APP_RESTORE_ENDUSER or ROLE_APP_RESTORE_DELETED_USER. ROLE_APP_CREATE_ENDUSER is not sufficient. For users with a location restriction the same location rule applies as under Users deleted in cucm.
• SIP trunks, gateways, gateway ports and application users: administrators and template creators only (ROLE_APP_ADMIN, ROLE_APP_TEMPLATE).
• All objects that the deleted object refers to must exist in the CUCM, for example device pool, partition, calling search space or route list. For a gateway port, the gateway with the matching unit and subunit must exist.
• The deletion lies within the retention period. The default is 90 days after deletion.

Step by step: find a deleted object and view the backup

1. Open EasyUC Cisco → Restore Config. For each category the Overview tab shows Deleted (open), Held, Restored (30 days), Storage, Last deletion and Kept until.
2. Click the category or select the tab, for example Phones. The sub-tab Deleted objects is active.
3. Read the Baseline data: number of open, held and restored objects, last deletion and retention. The change feed detects deletions after about 90 seconds, otherwise the next reconciliation does.
4. Search for the object. The search field covers different details in each category; for phones these are name, description, number or model.
5. If required, tick include restored. In the End users tab you can additionally filter by All, Deleted in CUCM or Deleted in EasyUC.
6. In the row, click Details. The Backup dialog opens with the Overview tab. It shows the status, object type, Deleted on, Backup from and the most important settings.
7. Open the Complete configuration tab to see all backed-up fields. With Export (JSON) you save the backup as a file.
8. Open the Changes tab to see the history of the object up to its deletion.
9. Note the hint in the dialog about what is not restored. For phones these are certificates (LSC), the primary extension and the UC service profile of the user, and memberships in line groups.

Step by step: restore a phone, phone number or pattern

1. In Restore Config, open the tab Phones, Phone numbers, Translation patterns or Route patterns.
2. In the row of the object, click Restore.
3. Read the prompt Restore “<name>”?. A phone is created with lines, buttons, services and user associations. Lines that still exist in the CUCM remain unchanged. A single phone number is not associated with any device.
4. Confirm the prompt.
5. Read the message above the list: ““<name>” was restored.” or with the addition “with <count> note(s)”. If there are notes, open the Details and read the Notes section.
6. For several objects, select the rows or use the selection in the table header (Select all restorable entries on this page). Click Restore selection (<count>) and confirm. The objects are created one after another. An error on one object does not hold up the others. Stop halts the run.
7. Then check the object in the CUCM or on the corresponding EasyUC page, for phones including registration.

Step by step: restore a SIP trunk, gateway, port or application user

1. Open the tab SIP trunks, Gateways, Gateway ports or Application users.
2. In the row, click Restore …. The Restore dialog opens.
3. SIP trunk: leave Add back to route groups active and check the list. The memberships at the time of deletion are preselected. Route groups with the badge recently removed are offered but not preselected.
4. Gateway: an MGCP/SCCP gateway is created with units, subunits and all deleted ports in one operation. If one part fails, everything remains unchanged. Digital ports (PRI/BRI/T1) are backed up but not restored.
5. Gateway port: check the row with gateway, unit, subunit and port. The gateway must exist in the CUCM.
6. Application user: enter a New password. Passwords are never backed up. If the user exists in the CUCM again, activate Merge into the existing application user if it exists again. Controlled devices, CTI profiles and groups are then added and the password remains unchanged.
7. Click Check only. This check changes nothing in the CUCM and shows what would happen, for example Planned steps and Ports that would be created.
8. If the check ends without errors, click Restore.
9. Read the result in the dialog. In the event of a conflict the dialog offers a suitable button: Merge into the existing one or Create anyway (allow same destination).
10. After a gateway restore, trigger Apply Config in the CUCM if the message “configuration not applied” appears.

Step by step: restore an end user

1. In Restore Config, open the End users tab.
2. If required, select Deleted in CUCM or Deleted in EasyUC. The Status column shows open, returned, running, partial, failed or restored.
3. In the row, click Restore …. The restore dialog of Users deleted in cucm opens. A plan first shows what is re-associated and what is created again.
4. If the user exists in the CUCM again, devices, profiles and associations from the backup are re-associated. If the user is missing, it is created. LDAP users return only through the LDAP sync.
5. Password and PIN are not backed up. Assign new values if required. If you enter nothing, the restore does not set any.
6. Run the restore and read the notes.
7. For cleanup and the deletion log, use the link Manage deleted users (cleanup, deletion log) to open the page Users → Users deleted in cucm.

Fields and options

Check the result and troubleshoot

• Success: the row changes to Restored with time and user. The details show New UUID. Under Config Backup an entry of the kind Restored appears in Recent changes.
• ““<name>” already exists in CUCM.”: the name is in use again. Check the existing object in the CUCM.
• ““<name>” cannot be restored: <count> referenced objects are missing in CUCM. Please create them first.”: the section Missing in CUCM: lists the objects. If one of them is itself backed up, it shows restorable from backup.
• ““<name>” has not been detected as deleted or was already restored.”: reload the list. For a held deletion, an administrator must first run Accept.
• “CUCM rejected creating “<name>”.”: read Last error in the details and fix the cause in the CUCM.
• “You are not allowed to restore this object type.”: you lack the restore role for this type.
• “The destination of “<name>” (address and port) is already used by another SIP trunk.”: change the destination or security profile of the other trunk, or allow the duplicate destination in the dialog.
• ““<name>” is an LDAP user and is missing in CUCM.”: check the user in the directory and wait for the LDAP sync. Afterwards it is merged into the returned user.
• ““<name>”: unit … / subunit … is not (or no longer) configured on gateway …”: configure the module in the CUCM first, then the port.
• Application users that EasyUC itself uses (AXL access, ControlMe, call tracking, Calling Features) and default users of the CUCM are not restored from the backup. Set them up again in the function responsible.
• “The CUCM backup is disabled for this CUCM connection.”: without a backup there are no new entries. An administrator enables it on the CUCM connection.
• “Restore users of your locations in “Deleted users”.”: with a location restriction, use the page Users deleted in cucm for end users.
• Take notes after the restore seriously, for example “End user … no longer exists in CUCM – not associated.” or “Pattern … now points to … – not changed.” The restore never changes patterns that pointed to a trunk or a gateway.