How to: Restore a BIG-IP Next instance from a backup file on BIG-IP Next Central Manager

Overview

Use this procedure to restore a BIG-IP Next instance’s configuration from a backup file saved on BIG-IP Next Central Manager. You typically restore a backup file after:

  • Upgrading a BIG-IP Next instance.

  • Performing a factory reset on a BIG-IP Next instance.

Prerequisite

  • To manage BIG-IP Next instances, you must have Administrator or Instance Manager user credentials. Users with Application Manager and Auditor credentials have read-only access to all application service information. For more information about user roles, see How to: Assign standard roles to users.

  • You must have a backup file for the BIG-IP Next instance you want to restore and the instance must be in a healthy state. You can only restore a backup to the BIG-IP Next instance that you used to create the backup.

  • Authenticate with the BIG-IP Next Central Manager API. For details refer to How to: Authenticate with the BIG-IP Next Central Manager API

Procedure

To restore BIG-IP Next instance using Central Manager GUI:

  1. Log in to BIG-IP Next Central Manager, click the Workspace icon next to the F5 logo, and click Infrastructure.

  2. On the left, click Back Up & Restore.
    The Backup Files page opens.

  3. Select the checkbox next to the backup you want to use to restore the BIG-IP Next instance’s configuration.

  4. On the right of the screen, click Restore.
    The Restore Backup confirmation box displays.

  5. To restore the configuration from this backup file enter the Encryption Password and click Yes, Restore button.

Results

BIG-IP Next Central Manager restores the BIG-IP Next instance’s configuration with its backup file.

To restore BIG-IP Next instance using Central Manager API:

  1. Get Instance details by sending a GET request to /spaces/default/instances endpoint. Identify the ID of the instance that you want to upgrade.

    GET https://{{CM_IP}}/api/v1/spaces/default/instances?filter=address eq '{{bigip_next_mgmt_ip}}'

  2. Restore a backup file by sending the POST request to the /device/v1/inventory/{{remote-Big-IP-Next-ID}}/restore endpoint.

    POST http://{{CM}}/api/device/v1/inventory/{{remote-Big-IP-Next-ID}}/restore

    For the request payload, use the following example, modifying the values as required.

    {
    "file_name": "{{backup_file_name}}",
    "encryption_password": "09090909"
}

    where backup_file_name is in backup.tar.gz format. For example: c4a89e78-62c8-40e2-b68e-2ac29484cbac.2024-05-30.03-26-00.backup.tar.gz

  3. Verify the instance restore status by sending the GET request to the /device/v1/restore-tasks/{restore_task_id} endpoint.

    GET https://{{CM}}/api/device/v1/restore-tasks/{{restore_task_id}}

Results

BIG-IP Next Central Manager restores the BIG-IP Next instance’s configuration with its backup file.