back box user-guide

81
User’s Manual Version 3.0.2 Revision 1.0 March 2013

Upload: dsd124

Post on 16-Aug-2015

21 views

Category:

Documents


1 download

TRANSCRIPT

Page 1: Back box user-guide

User’s Manual Version 3.0.2

Revision 1.0 March 2013

Page 2: Back box user-guide

2

BackBox User’s Manual

Copyright © 2013 Safeway. All rights reserved.

No part of this publication may be reproduced, transmitted, transcribed, stored in a

retrieval system, or translated into any language, in any form or by any means,

electronic, mechanical, photocopying, recording, or otherwise, without prior written

permission from Safeway.

All copyright, confidential information, patents, design rights and all other intellectual

property rights of whatsoever nature contained herein are and shall remain the sole

and exclusive property of Safeway Ltd. The information furnished herein is believed

to be accurate and reliable.

However, no responsibility is assumed by Safeway for its use, or for any

infringements of patents or other rights of third parties resulting from its use.

The Safeway name and Safeway logo are trademarks or registered trademarks of

Safeway Limited.

All other trademarks are the property of their respective owners.

Page 3: Back box user-guide

3

BackBox User’s Manual

Table of Contents

CHAPTER 1. INTRODUCTION ............................................................................... 11

FEATURES ................................................................................................................................ 11

ABOUT THE USER GUIDE ............................................................................................................. 11

WHO SHOULD USE IT ................................................................................................................. 12

TYPOGRAPHICAL CONVENTIONS ................................................................................................... 12

CHAPTER 2. INSTALLATION ................................................................................. 13

SYSTEM REQUIREMENTS ............................................................................................................. 13

PREREQUISITES.......................................................................................................................... 13

INSTALLING BACKBOX................................................................................................................. 14

CHAPTER 3. GETTING STARTED ........................................................................... 16

LOGGING IN.............................................................................................................................. 16

UNDERSTANDING THE MAIN SCREEN ............................................................................................. 16

UNDERSTANDING THE MAIN SCREEN TOOLBAR ............................................................................... 17

UNDERSTANDING THE DASHBOARD AND REPORTS TABS .................................................................... 19

The Dashboard tab ........................................................................................................... 19

The Reports tab ................................................................................................................ 21

CHAPTER 4. REPORTS ......................................................................................... 22

ADDING A NEW REPORT ............................................................................................................. 22

EDITING A REPORT ..................................................................................................................... 23

DELETING A REPORT ................................................................................................................... 23

TYPES OF REPORTS ................................................................................................................ 24

Device Details Report ....................................................................................................... 24

Page 4: Back box user-guide

4

BackBox User’s Manual

Device Health Report ........................................................................................................ 24

Device Status Report - by Group ....................................................................................... 25

Device Status Report - by Type ......................................................................................... 26

Device Status Report ........................................................................................................ 27

Inventory Report ............................................................................................................... 28

Users Report ..................................................................................................................... 29

CHAPTER 5. BACKUP JOBS .................................................................................. 30

THE BACKUP JOBS WINDOW ........................................................................................................ 30

Adding a Backup Job ........................................................................................................ 31

Deleting a Backup Job ...................................................................................................... 33

THE BACKUP QUEUE WINDOW ..................................................................................................... 33

BACKUP HISTORY WINDOW ......................................................................................................... 34

CHAPTER 6. DEVICES AND DEVICE GROUPS ......................................................... 35

DEVICES ................................................................................................................................... 35

Displaying the Details of an Individual Device .................................................................. 37

DEVICE DETAILS TAB ......................................................................................................................... 37

Device Backup History tab ................................................................................................ 40

Inventory .......................................................................................................................... 42

Adding a new Device ........................................................................................................ 42

Deleting a Device .............................................................................................................. 45

DEVICE GROUPS ........................................................................................................................ 45

Adding a new Device Group ............................................................................................. 46

Deleting a Device Group ................................................................................................... 47

CHAPTER 7. SCHEDULES ..................................................................................... 48

Page 5: Back box user-guide

5

BackBox User’s Manual

ADDING A NEW SCHEDULE........................................................................................................... 48

DELETING A SCHEDULE ............................................................................................................... 50

CHAPTER 8. NOTIFICATIONS ............................................................................... 51

ADDING A NOTIFICATION ............................................................................................................ 51

DELETING A NOTIFICATION .......................................................................................................... 53

CHAPTER 9. AUTHENTICATION ........................................................................... 54

AUTHENTICATION TEMPLATES ...................................................................................................... 54

Adding an Authentication Template ................................................................................ 55

Deleting an Authentication Template .............................................................................. 56

BACKBOX USERS ....................................................................................................................... 56

CHAPTER 10. DOCUMENTATION ......................................................................... 58

RECOVERY PROCEDURES ............................................................................................................. 58

BACKBOX DOCUMENTATION ....................................................................................................... 59

CUSTOM DOCUMENTATION ......................................................................................................... 59

Adding a Document .......................................................................................................... 60

Deleting a Document ........................................................................................................ 60

Downloading a Document ................................................................................................ 61

CHAPTER 11. SETTINGS ...................................................................................... 62

INTERFACES .............................................................................................................................. 63

ROUTING ................................................................................................................................. 64

Adding a Route ................................................................................................................. 64

Editing a Route ................................................................................................................. 64

Deleting a Route ............................................................................................................... 65

DNS ....................................................................................................................................... 65

Page 6: Back box user-guide

6

BackBox User’s Manual

TIME AND DATE ........................................................................................................................ 65

ALERTS .................................................................................................................................... 66

ADMINISTRATION ...................................................................................................................... 67

LICENSE ................................................................................................................................... 69

Uploading a new License .................................................................................................. 70

Deleting a License ............................................................................................................. 70

ACCESS .................................................................................................................................... 70

MAINTENANCE .......................................................................................................................... 70

SITES ....................................................................................................................................... 71

Adding a Site .................................................................................................................... 72

Editing a Site ..................................................................................................................... 72

Deleting a Site .................................................................................................................. 72

AGENTS ................................................................................................................................... 72

Adding an Agent ............................................................................................................... 73

Editing an Agent ............................................................................................................... 73

Deleting an Agent ............................................................................................................. 74

SYSTEM LOGS ........................................................................................................................... 74

Auditing ............................................................................................................................ 74

Messages .......................................................................................................................... 77

VSFTPD ............................................................................................................................. 77

INDEX ................................................................................................................. 78

List of Figures

FIGURE 1: INSTALLATION SCREEN ...................................................................................................... 14

Page 7: Back box user-guide

7

BackBox User’s Manual

FIGURE 2: CONFIGURE TCP/IP SCREEN .............................................................................................. 14

FIGURE 3: MANUAL TCP/IP CONFIGURATION SCREEN .......................................................................... 15

FIGURE 4: BACKBOX ACCESS SCREEN ................................................................................................. 15

FIGURE 5: LOGIN SCREEN ................................................................................................................ 16

FIGURE 6: MAIN SCREEN WITH DASHBOARD TAB DISPLAYED ................................................................... 17

FIGURE 7: TOOLBAR BUTTONS ON THE MAIN SCREEN ............................................................................ 18

FIGURE 8: DASHBOARD TAB ............................................................................................................. 20

FIGURE 9: MAIN SCREEN WITH REPORTS TAB DISPLAYED ........................................................................ 21

FIGURE 10: REPORTS TAB ................................................................................................................ 22

FIGURE 11: ADD REPORT DIALOG BOX ............................................................................................... 23

FIGURE 12: DEVICE DETAILS REPORT ................................................................................................. 24

FIGURE 13: DEVICE HEALTH REPORT .................................................................................................. 25

FIGURE 14: DEVICE STATUS BY GROUP REPORT ................................................................................... 26

FIGURE 15: DEVICE STATUS BY TYPE REPORT ....................................................................................... 27

FIGURE 16: DEVICE STATUS REPORT .................................................................................................. 28

FIGURE 17: INVENTORY REPORT ....................................................................................................... 28

FIGURE 18: USERS REPORT .............................................................................................................. 29

FIGURE 19: BACKUP JOBS SCREEN ..................................................................................................... 30

FIGURE 20: BACKUP JOBS WINDOW .................................................................................................. 30

FIGURE 21: NEW BACKUP JOB CONFIGURATION DIALOG BOX ................................................................. 32

FIGURE 22: BACKUP QUEUE WINDOW ............................................................................................... 33

FIGURE 23: BACKUP HISTORY WINDOW ............................................................................................. 34

FIGURE 24: DEVICES SCREEN ............................................................................................................ 35

FIGURE 25: DEVICE DETAILS SCREEN DISPLAYING THE DEVICE DETAILS TAB ................................................ 37

FIGURE 26: WINDOW WHERE TO CONFIGURE A BACKUP ........................................................................ 39

Page 8: Back box user-guide

8

BackBox User’s Manual

FIGURE 27: WINDOW WHERE TO RESTORE CONFIGURATION ................................................................... 40

FIGURE 28: DEVICE BACKUP HISTORY TAB .......................................................................................... 41

FIGURE 29: BACKUP TRAIL LOG WINDOW ........................................................................................... 41

FIGURE 30: INVENTORY TAB ............................................................................................................. 42

FIGURE 31: NEW DEVICE CONFIGURATION DIALOG BOX - STEP 1 OF 4 ..................................................... 43

FIGURE 32: NEW DEVICE CONFIGURATION DIALOG BOX - STEP 2 OF 4 DEVICE INFORMATION ...................... 44

FIGURE 33: NEW DEVICE CONFIGURATION DIALOG BOX - STEP 3 OF 4 DEVICE INFORMATION ...................... 44

FIGURE 34: NEW DEVICE CONFIGURATION DIALOG BOX - STEP 4 OF 4 DEVICE INFORMATION ...................... 45

FIGURE 35: DEVICE GROUPS SCREEN ................................................................................................. 46

FIGURE 36: ADD GROUP DIALOG BOX ................................................................................................ 47

FIGURE 37: SCHEDULES SCREEN ........................................................................................................ 48

FIGURE 38: NEW SCHEDULE CONFIGURATION DIALOG BOX .................................................................... 49

FIGURE 39: NOTIFICATION WINDOW ................................................................................................. 51

FIGURE 40: ADD NOTIFICATION DIALOG BOX ....................................................................................... 52

FIGURE 41: AUTHENTICATION SCREEN ............................................................................................... 54

FIGURE 42: AUTHENTICATION TEMPLATES WINDOW ............................................................................ 54

FIGURE 43: AUTHENTICATION TEMPLATE DETAIL DIALOG BOX ................................................................ 55

FIGURE 44: BACKBOX USERS WINDOW .............................................................................................. 56

FIGURE 45: DOCUMENTATION SCREEN ............................................................................................... 58

FIGURE 46: RECOVERY PROCEDURES WINDOW .................................................................................... 59

FIGURE 47: BACKBOX DOCUMENTATION WINDOW .............................................................................. 59

FIGURE 48: CUSTOM DOCUMENTATION WINDOW ............................................................................... 60

FIGURE 49: NEW CUSTOM DOCUMENTATION DIALOG BOX .................................................................... 60

FIGURE 50: SETTINGS SCREEN .......................................................................................................... 62

FIGURE 51: INTERFACES WINDOW ..................................................................................................... 64

Page 9: Back box user-guide

9

BackBox User’s Manual

FIGURE 52: ROUTING WINDOW ........................................................................................................ 64

FIGURE 53: EDIT ROUTE DIALOG BOX................................................................................................. 65

FIGURE 54: DNS WINDOW .............................................................................................................. 65

FIGURE 55: TIME AND DATE - STATIC VIEW ......................................................................................... 66

FIGURE 56: TIME AND DATE - NTP VIEW ........................................................................................... 66

FIGURE 57: ALERTS WINDOW ........................................................................................................... 66

FIGURE 58: SNMP - V1 FIGURE 59: SNMP - V2 ....................................................................... 67

FIGURE 60: SNMP - V3.................................................................................................................. 67

FIGURE 61: ADMINISTRATION WINDOW ............................................................................................. 68

FIGURE 62: LICENSE WINDOW .......................................................................................................... 69

FIGURE 63: ACCESS WINDOW .......................................................................................................... 70

FIGURE 64: MAINTENANCE WINDOW ................................................................................................ 71

FIGURE 65: SITES WINDOW ............................................................................................................. 71

FIGURE 66: AGENTS WINDOW .......................................................................................................... 72

FIGURE 67: AGENT DETAILS DIALOG BOX ............................................................................................ 73

FIGURE 68: AGENT OS USERS DIALOG BOX ......................................................................................... 73

FIGURE 69: SYSTEM LOGS WINDOW .................................................................................................. 74

FIGURE 70: AUDIT LOG WINDOW ..................................................................................................... 75

FIGURE 71: AUDIT DETAILS LOG WINDOW - SITES ................................................................................ 76

FIGURE 72: AUDIT DETAILS LOG WINDOW - DEVICES ............................................................................ 76

FIGURE 73: LOGS TRAIL WINDOW ..................................................................................................... 77

List of Tables

TABLE 1: TOOLBAR BUTTONS ........................................................................................................... 18

TABLE 2: DASHBOARD DISPLAYS ........................................................................................................ 20

Page 10: Back box user-guide

10

BackBox User’s Manual

TABLE 3: BACKUP JOBS WINDOW: FIELDS AND BUTTONS ........................................................................ 30

TABLE 4: NEW BACKUP JOB CONFIGURATION FIELDS ............................................................................ 32

TABLE 5: DEVICES FIELDS AND BUTTONS ............................................................................................. 36

TABLE 6: DEVICE DETAIL FIELDS ........................................................................................................ 37

TABLE 7: ADD GROUP FIELDS ........................................................................................................... 47

TABLE 8: NEW SCHEDULE FIELDS AND DESCRIPTIONS............................................................................. 49

TABLE 9: ADD NOTIFICATION FIELDS .................................................................................................. 52

TABLE 10: AUTHENTICATION TEMPLATE DETAILS FIELDS ........................................................................ 55

TABLE 11: BACKBOX USERS WINDOW FIELDS ...................................................................................... 57

TABLE 12: SETTINGS SCREEN BUTTONS ............................................................................................... 62

TABLE 13: ADMINISTRATION ............................................................................................................ 68

TABLE 14: AUDIT LOG FILTER CRITERIA ............................................................................................... 75

Page 11: Back box user-guide

11

Chapter 1. Introduction BackBox User’s Manual

CHAPTER 1. INTRODUCTION

The BackBox Solution enables security and network administrators to manage

complete backup schedules as well as configure alerts if backups are incomplete or fail

to run at all.

The intuitive dashboard displays all devices, networking and security applications in a single view while highlighting any device not recently backed up.

BackBox’s unique multi-check engine ensures backups have run successfully. It also

verifies that all saved configurations meet the criteria needed for successful restoration

if any backup fails to run or is not completed successfully.

FEATURES

Live dashboard with real-time backup status display

Detailed reporting

Automated and scheduled backups from a single location

Central application for all security and networking backup configurations

Web-based management

Alerts and notifications

Disaster recovery templates

Multi-vendor support

Generic device and new product updates

Built in Firewall

RADIUS authentication

ASCII configuration file comparison

ABOUT THE USER GUIDE

The User Guide is organized as follows:

Chapters 1-3 explain the basics of the system, including installation and getting

started.

Chapters 4-11 contain in depth explanations of BackBox’s tools and instructions on

how to navigate within the system.

Page 12: Back box user-guide

12

Chapter 1. Introduction BackBox User’s Manual

WHO SHOULD USE IT

BackBox is designed for use by people with advanced IT knowledge, such as:

System Administrators - to install, configure and schedule backups.

Backup Operators - to configure and schedule backups.

Monitor Users - to review backups and system statuses.

TYPOGRAPHICAL CONVENTIONS

In this User’s Manual the following Typographical Conventions are used:

Item Typographic Convention

Names of Screens and Sub screens:

Appear in bold

Names of Windows: Appear in bold

Names of Dialog boxes: Appear in bold

Names of Prompts: Appear in bold

Names of Reports: Appear in bold

Tabs: Appear in bold

Notes: Appear in Italics

Page 13: Back box user-guide

13

Chapter 2. Installation BackBox User’s Manual

CHAPTER 2. INSTALLATION

This chapter outlines the System Requirements and Prerequisites necessary to run

BackBox. It also provides instructions for installing the system.

SYSTEM REQUIREMENTS

The following are the minimum hardware requirements:

Intel CPU (dual core)

Disk space: 250GB (estimated for 6 months of backups)

Memory: 2GB

At least one network interface card (NIC)

CD-Rom drive (for physical hardware)

Supported HBA card: Emulex LP10000

PREREQUISITES

Static IP Address

DNS Server IP address (and DNS suffix).

IP address of SMTP server (and routing/SMTP access between the BackBox

server and the SMTP server).

Page 14: Back box user-guide

14

Chapter 2. Installation BackBox User’s Manual

INSTALLING BACKBOX

To install BackBox:

1. Insert the CD in the drive. The Installation screen appears.

Figure 1: Installation screen

2. Press Enter. The Configure TCP/IP screen appears.

Figure 2: Configure TCP/IP screen

Page 15: Back box user-guide

15

Chapter 2. Installation BackBox User’s Manual

3. Specify the TCP/ IP settings and click OK. If you specify Manual configuration the

following screen appears:

Figure 3: Manual TCP/IP Configuration screen

Note: If Dynamic configuration is selected then the BackBox Access screen appears.

See Figure 4.

4. In the Manual TCP/IP screen enter the IPv4 and /or the IPv6 address and prefix.

Enter the Gateway and Name Server. Click OK. The BackBox Access screen

appears.

Figure 4: BackBox Access screen

Page 16: Back box user-guide

16

Chapter 3. Getting Started BackBox User’s Manual

CHAPTER 3. GETTING STARTED

LOGGING IN

To Login to BackBox:

1. In your web browser, enter the IP address or host name in one of the following

formats:

https://<BackBox_IP_or_Hostname>

The Login screen is displayed:

Figure 5: Login screen

2. Enter your BackBox Username and Password and press Enter. The following

default values appear:

Username: admin Password: "password" (default supplied with system)

The Main screen is displayed.

UNDERSTANDING THE MAIN SCREEN

The Main screen defaults to the Dashboard tab.

Page 17: Back box user-guide

17

Chapter 3. Getting Started BackBox User’s Manual

Figure 6: Main screen with Dashboard tab displayed

Across the top of the screen are the time and date, the user name and the Logout and

Help buttons.

Note: The Logout button only highlights when the cursor hovers above it.

Below the time and date are the BackBox logo and the toolbar with all the buttons

needed to navigate the system.

Below the toolbar buttons are the Dashboard tab and the Reports tab, and several

displays.

UNDERSTANDING THE MAIN SCREEN TOOLBAR

The toolbar displays a row of buttons for navigating BackBox screens:

Page 18: Back box user-guide

18

Chapter 3. Getting Started BackBox User’s Manual

Figure 7: Toolbar buttons on the Main screen

Table 1: Toolbar buttons

Icon Description

The Dashboard has two tabs- Dashboard and Reports.

The Dashboard tab displays statuses of devices which have

been configured and backed up. It also displays current license information and the number of backups in progress and pending.

The Reports tab displays the list of reports BackBox has been

programmed to generate. Here you can add, edit and delete reports as needed.

Backup displays a screen with the following sub screens:

Backup Jobs, Backup Queue and Backup History.

Devices allows you to manage those devices needing to be

backed up. It also allows the creation and removal of devices as well as changing device properties.

Device Groups allows you to create logical groups of the

devices that need to be backed up. It allows the creation and removal of groups as well as changing the members in each group.

Schedules is where you manage the schedule of backups and

reports. You can create, modify and delete schedules as needed.

Page 19: Back box user-guide

19

Chapter 3. Getting Started BackBox User’s Manual

Icon Description

Notifications is where you set up external notification

requirement for SMTP and SYSLOG.

Authentication is where you to create groups out of the devices

which share authentication details, i.e. Username, Password, and Extra Password. It allows creation and removal of groups as well as changing the members in each group.

Documents displays the following screens:

Recovery Procedures, Backup Documentation and Custom Documentation.

Here is where all the documentation regarding data recovery and data restoration is kept.

Settings is where all the parameters are set for BackBox,

including interfaces, routing, DNS, time and date, alerts, administration, license, access, maintenance, sites, agents and system logs.

UNDERSTANDING THE DASHBOARD AND REPORTS TABS

The main screen has two tabs: Dashboard and Reports.

THE DASHBOARD TAB

The Dashboard tab displays system information, statistical information about the

devices, device groups and the success of the backup operations.

Page 20: Back box user-guide

20

Chapter 3. Getting Started BackBox User’s Manual

Figure 8: Dashboard tab

Table 2: Dashboard displays

Display Description

Device Status: Graphical representation of the

success of the device backup operations performed. The pie chart is split between Successful, Suspect and Failed.

Device Configuration Status: Shows the statuses

of the device configuration. Statuses are either OK, Incomplete or Unscheduled.

Device Status by Type: Displays the success of the

backups by device type, such as content, firewall or switches.

Page 21: Back box user-guide

21

Chapter 3. Getting Started BackBox User’s Manual

Display Description

Device Status by Group: Graph showing the

success of backups by user-defined logical device groups, such as Cisco or Checkpoint.

System Information: Displays information about the

current system, including the current BackBox version, how many running and pending jobs are in the backup queue, the license details (maximum number of simple and complex devices), license expiration date (if set on the license), and amount of free disk space on the backup partition of the server (/data).

THE REPORTS TAB

When the Reports tab is clicked, the following screen appears:

Figure 9: Main screen with Reports tab displayed

The Reports tab contains the different reports BackBox can generate. Along with the

many predefined reports in the system, you can create specific reports. You can also

edit and delete reports.

Page 22: Back box user-guide

22

Chapter 4. Reports BackBox User’s Manual

CHAPTER 4. REPORTS

BackBox comes with many predefined reports which provide information about your

devices and the statuses of the backups. You can use these predefined reports or create

proprietary reports to suit your organizational needs.

To access the Reports, on the Dashboard click the Reports tab.

Figure 10: Reports tab

You can filter the reports list by Name, Schedule or Notification by clicking the

button next to each heading.

ADDING A NEW REPORT

To add a new report:

1. On the Reports tab click the button. The following dialog box appears:

Page 23: Back box user-guide

23

Chapter 4. Reports BackBox User’s Manual

Figure 11: Add Report dialog box

2. Type a Name and a Description for the report.

3. Select the Report Type. See Types of Reports below for the descriptions of each

report type.

4. Select the Schedule, Notification and appropriate Site.

5. Click Save.

EDITING A REPORT

To edit a report:

1. In the list of reports select a report and click the button. The Add Report

dialog box appears.

2. Edit the appropriate fields.

3. Click Save.

DELETING A REPORT

To delete a report:

1. In the list of reports select the report to delete and click the button. A

prompt appears requesting confirmation.

2. Click Yes.

Page 24: Back box user-guide

24

Chapter 4. Reports BackBox User’s Manual

TYPES OF REPORTS

This section provides examples of each report type.

DEVICE DETAILS REPORT

The Device Details report provides details such as: Device name, IP address, Device

Type, i.e. firewall, switch, etc. The Health of the device is indicated by a green, red or

gray button. It also displays the Average Backup Size and the Site.

Figure 12: Device Details report

DEVICE HEALTH REPORT

The Device Health report shows whether a device configuration is Complete (green),

Incomplete (red), or Not Yet Scheduled (yellow).

The report lists devices and their health status, as well as displaying a graphic which

shows the overall ratio of complete vs. incomplete device configurations.

Page 25: Back box user-guide

25

Chapter 4. Reports BackBox User’s Manual

Figure 13: Device Health report

DEVICE STATUS REPORT - BY GROUP

The Device Status Report - by Group shows the backup status of device groups in

the system. The report shows the status of the Last Backup (green for Success, red for

Failure, yellow for Suspect), the date of the Last Successful Backup, the Site, and the

percentage of devices in the group which have been successfully backed up. The

report also displays a graph which shows the number of Successful group backups,

Failed group backups, and Suspect group backups.

Page 26: Back box user-guide

26

Chapter 4. Reports BackBox User’s Manual

Figure 14: Device Status by Group report

DEVICE STATUS REPORT - BY TYPE

The Device Status Report- by Type shows the backup status of device types in the

system. The report shows the Device Name, IP Address, Last Backup Date, Last

Backup Status (Success , Failure , or Suspect ), the date of the Last Successful

Backup, and Status, which is the overall percentage of Successful, Failed and Suspect

backups.

For each device type, the report also displays a graph which shows the number of

Successful backups, Failed backups, and Suspect backups.

Page 27: Back box user-guide

27

Chapter 4. Reports BackBox User’s Manual

Figure 15: Device Status by Type report

DEVICE STATUS REPORT

The Device Status report shows the backup status of devices in the system. The report

shows: the Device Name, IP Address, Last Backup Date, Last Backup Status (green

for Success, red for Failure, yellow for Suspect), the date of the Last Successful

Backup, Status of the last device backup, the date of the Last Successful Backup, and

Status, which is the overall percentage of Successful, Failed and Suspect backups.

The report also displays a graph that shows the number of successful group backups,

failed group backups, and suspect group backups.

Page 28: Back box user-guide

28

Chapter 4. Reports BackBox User’s Manual

Figure 16: Device Status report

INVENTORY REPORT

The Inventory report displays an inventory of each device in the system and includes

some or all of the following information, depending on the type of device:

Device name, IP Address, Type, Version, Model, CPU, Memory, CPU, Free Space,

Free Memory, Free Space/var, and Uptime .

Figure 17: Inventory report

Page 29: Back box user-guide

29

Chapter 4. Reports BackBox User’s Manual

USERS REPORT

The Users report displays information on the system users including: Username, Full

Name, e-mail Address, Role, Site to which they have been assigned, whether they are

able to Receive Notifications, and Type.

Figure 18: Users report

Page 30: Back box user-guide

30

Chapter 5. Backup Jobs BackBox User’s Manual

CHAPTER 5. BACKUP JOBS

Backup Jobs lists all the backup operations that have been defined in the system, the

current jobs in queue and a backup history of each device.

To open the Backup Jobs screen, on the toolbar click the button. The following

screen appears:

Figure 19: Backup Jobs screen

THE BACKUP JOBS WINDOW

To open the Backup Jobs window, on the Backup Jobs screen click the

button. The following window is displayed:

Figure 20: Backup Jobs window

Table 3: Backup Jobs window: fields and buttons

Field/Button Function

Name: The name assigned to the particular backup.

Schedule: Displays if a schedule of backups has been set for each device, and the frequency of the backups.

Page 31: Back box user-guide

31

Chapter 5. Backup Jobs BackBox User’s Manual

Field/Button Function

Next Execution: The date and time of the next scheduled backup, providing the job is enabled.

Site: The site to which the device is assigned.

Status: Indicates whether the backup is Enabled or

Disabled .

You can add a new device for backup. To add a new backup job, see below - Adding a Backup Job.

Delete any device from the backup list. Simply check

the box next to the desired job and click the button.

Manually run a backup at any time, even ahead of the scheduled time. Check the box next to the desired job

and click the button.

Terminate any backup already in progress. Check the

box next to the desired job and click the button.

ADDING A BACKUP JOB

BackBox allows you to add more and more backups to meet your needs.

To add another Backup Job:

1. On the Backup Jobs screen, click the button. The New Backup Job

Configuration dialog box appears.

Page 32: Back box user-guide

32

Chapter 5. Backup Jobs BackBox User’s Manual

Figure 21: New Backup Job Configuration dialog box

Table 4: New Backup Job Configuration fields

Field Description

Name: Name which identifies the new backup.

Description: Brief description of the backup – this field is optional, but recommended.

Scheduler: The person who is adding the new schedule. To add or edit a schedule, see Chapter 7: Schedules. You can edit an

existing Scheduler by clicking the button.

Notifications: The people to be notified in case of failure or after the completion of the backup. To add a notification, see Chapter 8: Notifications.

Site: The site to which the device is assigned.

Available devices: Highlight the desired device for backup. Click to move it to the Selected devices field.

Selected devices: List of the devices selected for backup. To remove a device

from this field, highlight and click .

Disable Job: You can disable a job in order to prevent it from running.

Select .

2. Complete the fields in the window and click Save.

Page 33: Back box user-guide

33

Chapter 5. Backup Jobs BackBox User’s Manual

DELETING A BACKUP JOB

To delete a Backup Job:

1. On the Backup Jobs window check the box next to the Backup Job to be deleted.

2. Click the button. The Delete Backup Job dialog box appears requesting

confirmation.

3. Click Yes.

THE BACKUP QUEUE WINDOW

The Backup Queue window contains all the backup jobs currently running or waiting

to run. Each entry listed contains the device name (one line for each device in the

queue), IP address, date started, duration (the time taken to run until now, if currently

running) and the run status, i.e. running or pending. A job can be removed from the

queue or stopped if currently running by clicking the button. To terminate all the

jobs in queue, double click the button.

Note: Due to the significance of terminating a backup job, you must double-click on the

Terminate All button as opposed to a single click for most other functions.

To open the Backup Queue window, click the button. The following

window appears:

Figure 22: Backup Queue window

Page 34: Back box user-guide

34

Chapter 5. Backup Jobs BackBox User’s Manual

BACKUP HISTORY WINDOW

The Backup History window is a log of all the backups. Each entry listed contains the

Device Name, its IP address, the Date and Time it was run and the Status of the run,

i.e. Success , Failure , or Suspect .

To display the Backup History window, on the Backup Jobs screen click the

button.

Figure 23: Backup History window

Page 35: Back box user-guide

35

Chapter 6. Devices and Device Groups BackBox User’s Manual

CHAPTER 6. DEVICES AND DEVICE GROUPS

Backups can be done on a single device or on a group of devices at the same time.

BackBox allows for the grouping of devices to make backups more manageable and

efficient.

DEVICES

The Devices screen lists all the devices that have been defined in the system together

with information about their last backups and status. The information includes: Name,

IP Address, Vendor, Type, Group, Site, Last Backup, Status, Reason for failure and

Health of the device.

From this screen you can add, delete or clone devices. You can run backups and

export and import files.

You can also view all the details about a specific device including its history

and inventory.

To display the Devices screen, on the toolbar click the button.

Figure 24: Devices screen

Page 36: Back box user-guide

36

Chapter 6. Devices and Device Groups BackBox User’s Manual

Table 5: Devices fields and buttons

Fields/Buttons Description

Name: The name given to the device.

IP Address: The IP address assigned to the device.

Vendor: Name of the vendor of the device

Type: The type of device it is, e.g. Load Balancer, Switch, IP Telephony, SSL VPN, or Router.

Site: The site to which the device is assigned.

Last Backup Date: Date of last backup.

Status: Displays whether the last backup was successful, a failure or incomplete.

Reason: Reason the backup failed or was not successfully completed.

Health: Health refers to whether the configuration is complete, incomplete or not yet scheduled.

Add a device for backup.

Delete a device.

You can make a clone of an existing device which will have all the same parameters for backing up.

Click to run the backup immediately.

An open remote management console. This will open up either a web interface management or a CLI management, depending on the type of device.

Export a device to a CSV file

Import a device list from a CSV file.

Filter button, for quick searching by Name, IP, Vendor or Type. When this button is clicked, the

field appears.

Page 37: Back box user-guide

37

Chapter 6. Devices and Device Groups BackBox User’s Manual

Fields/Buttons Description

Displays the number of devices per page: 10, 25, 50 or 100.

DISPLAYING THE DETAILS OF AN INDIVIDUAL DEVICE

To display the details of an individual device, hover your mouse over the name of the

device and click. The screen below containing the following three tabs is displayed:

Device Details, Device Backup History and Inventory.

Figure 25: Device Details screen displaying the Device Details tab

DEVICE DETAILS TAB

The Device Details tab contains information about the device.

Table 6: Device Detail fields

Field Description

Device Name: Name of the device.

Device IP: IP Address of the device.

Page 38: Back box user-guide

38

Chapter 6. Devices and Device Groups BackBox User’s Manual

Field Description

Vendor: Vendor’s name

Product: Product name

Version: Product version

Backup Type Backup type

Authentication: Type of authentication required: Use Custom, Use Templates or SSH Key.

Username: Username

Password: Password

Expert Password: Displayed if required by the administrator.

Port: Displayed if required.

Available Jobs: Available jobs to where the device can be assigned. To move the device, highlight the job and click . The job is now displayed in Selected Jobs.

Selected Jobs:

Where the device is assigned. To remove the device from

the assigned job, highlight the job and click . The job is now displayed in Available Jobs.

Backup Retention:

Indicate the number of days or backups. If the “use NAT IP” box is checked, another field appears next to it.

Notes: 1. If the Site is not Global, check the Backup Retention box and complete the fields. 2. If the Debug Mode box is checked, it will stay checked for one run only. Afterwards it will be automatically unchecked.

If needed, the user can configure the backup by clicking this button. The window shown in Figure 17 appears.

If needed, the user can restore the configuration. To restore the configuration, click this button. The window shown in Figure 18 appears.

Page 39: Back box user-guide

39

Chapter 6. Devices and Device Groups BackBox User’s Manual

Figure 26: Window where to configure a backup

Page 40: Back box user-guide

40

Chapter 6. Devices and Device Groups BackBox User’s Manual

Figure 27: Window where to restore configuration

DEVICE BACKUP HISTORY TAB

The Device Backup History tab lists all the backups performed on the device. The

details displayed include the Execution Date, the Backup Size, Status, and Failure

Reason.

Page 41: Back box user-guide

41

Chapter 6. Devices and Device Groups BackBox User’s Manual

Figure 28: Device Backup History tab

You can view a detailed log of each backup by clicking the button. The Backup

Trail Log window appears.

Figure 29: Backup Trail Log window

Page 42: Back box user-guide

42

Chapter 6. Devices and Device Groups BackBox User’s Manual

INVENTORY

The inventory tab displays relevant information about the device, including: Version,

Model, Memory, CPU, Free Space, Free Memory and Uptime. These fields are

automatically updated after a backup is completed.

Figure 30: Inventory tab

ADDING A NEW DEVICE

To add a new device:

1. On the Devices screen click the button. The New Device Configuration –

Step 1 of 4 Device information dialog box appears.

Page 43: Back box user-guide

43

Chapter 6. Devices and Device Groups BackBox User’s Manual

Figure 31: New Device Configuration dialog box - Step 1 of 4

2. Add the Device Name, the IP Address, the Agent and the Site and click Next. The

second of four dialog boxes appears.

Page 44: Back box user-guide

44

Chapter 6. Devices and Device Groups BackBox User’s Manual

Figure 32: New Device Configuration dialog box - Step 2 of 4 Device Information

3. Complete the Vendor, Product, Version and Backup Type fields, and click Next.

The third of four dialog boxes appears.

Figure 33: New Device Configuration dialog box - Step 3 of 4 Device Information

4. Complete the Authentication, Username, Password, Super Password and Port

fields, and click Next. The fourth of four dialog boxes appears.

Page 45: Back box user-guide

45

Chapter 6. Devices and Device Groups BackBox User’s Manual

Figure 34: New Device Configuration dialog box - Step 4 of 4 Device Information

5. On the Backup Retention field, check the box.

Note: Leave unchecked Global settings.

6. Indicate the number of days or backups, as required.

7. From the Available Jobs select the devices to be configured and click . They

now appear in Selected Jobs.

8. Click Finish.

DELETING A DEVICE

To delete a Device:

1. On the Devices window check the box next to the device to be deleted.

2. Click the button. The Delete Devices dialog box appears requesting

confirmation.

3. Click Yes.

DEVICE GROUPS

The Device Groups screen displays the list of devices grouped together for backup.

Groups can be created based on vendor or by the device function such as firewall, load

balancer, switch etc.

Page 46: Back box user-guide

46

Chapter 6. Devices and Device Groups BackBox User’s Manual

The screen also shows: the name of the group, the site, the number of devices in the

group, when the group was created and when last modified. You can add a new device

group or delete an existing group.

To display the Device Groups screen, on the toolbar click the button.

Figure 35: Device Groups screen

ADDING A NEW DEVICE GROUP

To add a new Device Group:

1. On the Device Groups screen click the button. The Add Group dialog box

appears.

Page 47: Back box user-guide

47

Chapter 6. Devices and Device Groups BackBox User’s Manual

Figure 36: Add Group dialog box

Table 7: Add Group fields

Field Description

Name: Name of new group.

Description Brief description of the new group. This field is optional but recommended.

Site: The site to which the device group is assigned.

Available devices: List of available devices that may be grouped. Desired devices must be moved to Selected devices. Highlight the

desired device for backup. Click to move them to the Selected devices field.

Selected devices: Devices selected for the new group. To remove devices

from here, click . The device now appears in Available devices.

2. Complete the fields and click Save.

DELETING A DEVICE GROUP

1. Select the Device Group you wish to delete by checking the box next to it.

2. Click the button. The Delete Groups prompt appears.

3. Click Yes.

Page 48: Back box user-guide

48

Chapter 7. Schedules BackBox User’s Manual

CHAPTER 7. SCHEDULES

BackBox allows you to set a schedule of when backups and reports are to run.

Schedules can be set for devices or device group. They can be set to run daily, weekly

or monthly, and at specified times. The Schedules screen lists all the schedules which

are defined in the system. You can add more schedules to the list as well as delete any

of them.

To open the Schedules screen, click the button on the toolbar.

Figure 37: Schedules screen

The screen displays: the name given to the particular schedule, the description, the

assigned site, the date the schedule was created, when it was last modified, and

whether it is in use or not .

ADDING A NEW SCHEDULE

You can add a new schedule to the list of schedules.

To add a new schedule:

1. On the Schedules screen, click the button. The New Schedule

Configuration dialog box appears.

Page 49: Back box user-guide

49

Chapter 7. Schedules BackBox User’s Manual

Figure 38: New Schedule Configuration dialog box

Table 8: New Schedule fields and descriptions

Field Description

Name: Name the new schedule for easy reference.

Description: Brief description of the schedule –optional, but recommended.

Site: The site to which the devices or device group is assigned.

The time frame of when the backup is to run.

Note: If you select daily, you must choose Every x Days. If you select Monthly, you must choose On Day of the month. If you select weekly, you must choose which day of the week.

Select the desired time to start the run.

2. Complete the required fields and click Save.

Page 50: Back box user-guide

50

Chapter 7. Schedules BackBox User’s Manual

DELETING A SCHEDULE

To delete one or more schedules:

1. Select the schedule(s) you wish to delete.

2. Click the button. A prompt appears requesting confirmation.

3. Click Yes.

Page 51: Back box user-guide

51

Chapter 8. Notifications BackBox User’s Manual

CHAPTER 8. NOTIFICATIONS

BackBox is designed to send notifications to designated people when a backup or

report is completed, failed to complete, or is suspected of failing to complete.

To open the Notifications window, on the toolbar click the button.

Figure 39: Notification window

The screen displays the Name of the notification, whether the notification is to be sent

via Email and/or Syslog, when it was Created, when it was last Modified and whether

it is In Use. You can add a new notification as well as delete an existing one.

ADDING A NOTIFICATION

To add a notification:

1. On the Notification screen, click the button. The Add Notification dialog

box appears.

Page 52: Back box user-guide

52

Chapter 8. Notifications BackBox User’s Manual

Figure 40: Add Notification dialog box

Table 9: Add Notification fields

Field Description

Name: Name the Notification

Site: The site to which the devices or device group is assigned.

Page 53: Back box user-guide

53

Chapter 8. Notifications BackBox User’s Manual

Field Description

Syslog Report on: Check the box if you wish the notification to be sent via Syslog, and under which circumstance; you can choose any or all of the options- Failure, Suspect, Success.

Email Report on: Check the box if you wish the notification to be sent via Email, and under which circumstance; you can choose any or all of the options- Failure, Suspect, Success.

Available Recipients:

List of all personnel authorized to receive notifications. Those who are to be notified must be moved to the Selected Recipients. Highlight the names who are to

receive notification and click . They appear in Selected Recipients.

Selected Recipients:

Displays names of people to receive notification of the backup. To remove a name from the list, highlight the

name and click .

2. Complete the required fields and click Save.

DELETING A NOTIFICATION

To delete a notification:

1. Select the notification(s) you wish to delete by checking the box next to it.

2. Click the button. The Delete Notification prompt appears.

3. Click Yes.

Page 54: Back box user-guide

54

Chapter 9. Authentication BackBox User’s Manual

CHAPTER 9. AUTHENTICATION

BackBox users receive permission to access the system by the administrator. Prior to

accessing the system users are required to authenticate themselves via their user names

and passwords. The administrator assigns the passwords, and in some circumstances

may require an extra password. The Authentication screen displays three sub screens: Authentication Templates,

BackBox Users and Operating System Users.

To open the Authentication screen, on the toolbar, click the button. The

following screen appears:

Figure 41: Authentication screen

AUTHENTICATION TEMPLATES

BackBox allows you to create templates for authenticating users required to access the

system, and specify what level of access they have. For example, some users have

complete access to the system while others are restricted to certain notifications or

devices. Some may be able to amend reports and notifications, while others are only

allowed receiving them.

To open the Authentication Templates window, on the Authentication screen, click

the button. The following window appears:

Figure 42: Authentication Templates window

Page 55: Back box user-guide

55

Chapter 9. Authentication BackBox User’s Manual

The window displays: the name of the template, when it was created, last modified,

and whether it is currently being used - , or no longer in use - . You can also

add and delete templates.

ADDING AN AUTHENTICATION TEMPLATE

To add an Authentication Template:

1. On the Authentication screen click the button. The Authentication

Template Details dialog box appears.

Figure 43: Authentication Template Detail dialog box

Table 10: Authentication Template Details fields

Field Description

Name: The name given to the template.

Username: Person being authorized to access the system.

Password: Required for authentication.

Extra Password: Administrator determines if an extra password is required.

Site: The site to which the device is assigned.

Available Devices

List of all the devices already configured in the system. The available devices must be moved to the Selected Devices.

Simply highlight the devices and click . They appear in Selected Devices.

Page 56: Back box user-guide

56

Chapter 9. Authentication BackBox User’s Manual

Field Description

Selected Devices: Displays all the devices the user may access. To remove a

device from the list, highlight the name and click .

2. Complete the required fields and then click Save.

DELETING AN AUTHENTICATION TEMPLATE

To delete an Authentication Template:

1. Select the template(s) you wish to delete.

2. Click the button. A prompt appears requesting confirmation.

3. Click Yes.

BACKBOX USERS

All authorized BackBox users must authenticate themselves in order to access the

system. Specific information about users must be captured in order for the system to

recognize them and their level of access.

The BackBox Users window is where the user’s pertinent identifying information is

entered, including email, password, the specific authorizations they have been granted,

and whether they are authorized to receive any notifications.

To open the BackBox Users window:

On the Authentication screen, click the button. The following

window appears:

Figure 44: BackBox Users window

Page 57: Back box user-guide

57

Chapter 9. Authentication BackBox User’s Manual

Across the top of the screen are fields where the administrator enters the user’s

information, including the assigned type and role.

Displayed below these fields is the list of users with BackBox access, along with their

Usernames, Emails, Sites, Roles, whether they Receive Notification, and Type. The

administrator can also Edit the information as well as Delete a user.

Table 11: BackBox Users window fields

Field Description

Type: User -defined types assigned by the administrator.

Name: Name of the user.

Username: Name to identify the user in the system.

Password: User’s password. Users create their own password.

Confirm Password: Confirm the password

Email Address: User’s email address

Site: The site to which the device is assigned.

Role: One of three possible roles for each user: Administrator, Backup Operator or Backup Monitor.

Page 58: Back box user-guide

58

Chapter 10. Documentation BackBox User’s Manual

CHAPTER 10. DOCUMENTATION

The Documentation screen provides documentation for the following:

Recovery Procedures for a wide variety of devices.

Backbox Documentation: a collection of documents that include User Guide,

Device Configuration procedures, Release Notes, as well as executable files and

Windows Backup Scripts.

The screen also enables you to add your own custom documentation to the system.

To open the Documentation screen, on the toolbar click the button.

Figure 45: Documentation screen

RECOVERY PROCEDURES

To open the Recovery Procedures window, on the Documentation screen click the

button.

Page 59: Back box user-guide

59

Chapter 10. Documentation BackBox User’s Manual

Figure 46: Recovery Procedures window

To view the recovery procedures for a device, simply select the appropriate Vendor,

Product, and Version, as well as the desired recovery option and click Submit.

BACKBOX DOCUMENTATION

To open the BackBox Documentation window, on the Documentation screen click

the button.

Figure 47: BackBox Documentation window

Click a Folder icon to view a list of documents. BackBox provides the following types

of documents:

User documentation: User Guide, Device Configuration instructions, etc.

Executable files: for example, Adobe Flash

Windows Backup Scripts

CUSTOM DOCUMENTATION

The Custom Documentation screen enables you to add your own custom

documentation to system.

Page 60: Back box user-guide

60

Chapter 10. Documentation BackBox User’s Manual

To open the Custom Documentation window, on the Documentation screen click

the button.

Figure 48: Custom Documentation window

ADDING A DOCUMENT

To add a document:

1. Click the button to display the following dialog box:

Figure 49: New Custom Documentation dialog box

2. In the Document Title field, type a name for the document.

3. Use the Browse button to locate a document, and then click the button.

After the document is uploaded, it appears in the list of documents in the Custom

Documentation window.

DELETING A DOCUMENT

To delete a document:

1. On the Custom Documentation window select the document to delete and click

the button. A prompt appears requesting confirmation.

2. Click Yes.

Page 61: Back box user-guide

61

Chapter 10. Documentation BackBox User’s Manual

DOWNLOADING A DOCUMENT

To download a document:

1. On the Custom Documentation window select the document to download and

click the button.

2. The Save As dialog box on your computer appears.

3. Select where you wish to save the document and click Save.

Page 62: Back box user-guide

62

Chapter 11. Settings BackBox User’s Manual

CHAPTER 11. SETTINGS

Settings is where all the system parameters for BackBox are set. The Settings screen

displays a list of options which enable you to access the various functions. Only the

administrator has access to Settings.

To open the Settings screen, on the toolbar click the button.

Figure 50: Settings screen

The following table provides an overview of the windows accessed by the buttons in

the Setting screen.

Table 12: Settings screen buttons

Button Description

Interfaces: Displays the interfaces which define the connections to the devices in the system and whether the link is up or down. They are used in routing entry definitions.

Routing: Displays the routing window which controls the routing tables of the BackBox servers themselves.

DNS: Displays the DNS window which specifies the location of the

Domain Name Servers. Click the button for the desired Base DN.

Page 63: Back box user-guide

63

Chapter 11. Settings BackBox User’s Manual

Button Description

Time and Date: Displays the window where the time and date are set. The time can be set as Static or NTP.

Alerts: Displays the window where alert protocols are created. There are three different protocols: SNMP, SMTP and Syslog.

Administration: Displays the window where the servers’ properties are defined. There are: General Settings, Radius Authentication 1 &2, and LDAP Authentication.

License: Displays the license screen. The fields are populated when the license is uploaded.

Access: Displays the window which controls the local firewall of the BackBox server. This determines which IP Address can access the web interfaces and the CLI interfaces.

Maintenance: Displays the window which manages regular maintenance issues such as reboots, shutdowns and upgrades.

Sites: Displays information about existing sites such as number of devices assigned and number of users. You can also add, delete and edit sites.

Agents: Displays a list of agents and their IP Addresses. It also shows which Operating Systems are assigned to the agent.

System Logs Displays a detailed log of each user’s activity while in the system.

INTERFACES

Interfaces displays basic network information. When the Status button is green it

indicates the link is up and when it is red, the link is down. You can also edit the

interface by clicking the button.

To open the Interfaces window, on the Settings screen click the button.

Page 64: Back box user-guide

64

Chapter 11. Settings BackBox User’s Manual

Figure 51: Interfaces window

ROUTING

To open the Routing window, on the Settings screen click the button.

Figure 52: Routing window

ADDING A ROUTE

To add a route:

In the Routing window complete the fields and click the button. The new

route appears in the routing list.

EDITING A ROUTE

To edit a route:

1. In the Routing window select the route to be edited and click the button. The

Edit Route dialog box appears.

Page 65: Back box user-guide

65

Chapter 11. Settings BackBox User’s Manual

Figure 53: Edit Route dialog box

2. Complete the fields and click Save.

DELETING A ROUTE

To delete a route:

1. Select the route you want to delete.

2. Click the button. The Delete Route prompt appears.

3. Click the button.

DNS

On the DNS window you can define Primary, Secondary and Tertiary settings as well

as a Domain Name.

To open the DNS window, on the Settings screen click the button.

Figure 54: DNS window

TIME AND DATE

To open the Time and Date window, on the Settings screen click the

button.

Page 66: Back box user-guide

66

Chapter 11. Settings BackBox User’s Manual

Figure 55: Time and Date - Static view

Note: The window defaults to the Static view, with the current date and time filled in.

To change to the NTP view:

1. Click the button. The NTP view is displayed.

Figure 56: Time and Date - NTP view

2. Complete the fields as required and click the button.

ALERTS

The Alerts window enables the administrator to create the following alert protocols:

SNMP, SMTP and Syslog.

To open the Alerts window:

1. On the Settings screen click the button.

Figure 57: Alerts window

Note: The SNMP view has three versions to choose from: v1, v2, or v3. Each version

has different fields to be completed, as shown in the following windows:

Page 67: Back box user-guide

67

Chapter 11. Settings BackBox User’s Manual

Figure 58: SNMP - v1 Figure 59: SNMP - v2

Figure 60: SNMP - v3

2. Complete the appropriate fields in the desired protocol and click Save.

ADMINISTRATION

The administrator uses the Administration screen to add and edit the general settings

as well as the authentication and communication protocols.

To open the Administration window, on the Settings screen click the

button.

Page 68: Back box user-guide

68

Chapter 11. Settings BackBox User’s Manual

Figure 61: Administration window

Table 13: Administration

Field Description

GENERAL SETTINGS: Contains the basic settings of the server’s properties.

Backup Retention: Can be set for either the number of days or the number of backups a backup is to remain on the server before being deleted.

Execution Time: Designated time to run the backup

Encrypt Backup Files: Files may be encrypted before being deleted.

IP Address: Select the IP Address from the list.

SSH Key: Show the SSH or generate a new key.

RADIUS AUTHENTICATION: 1 and 2

Use the fields under Radius to specify Radius Authentication settings.

Radius Server: IP Address of the Radius server for authenticating access.

Page 69: Back box user-guide

69

Chapter 11. Settings BackBox User’s Manual

Field Description

Radius Port: Port for the Radius server.

Secret Key: Radius server pre-shared key.

LDAP AUTHENTICATION Check the box if required.

Hostname: The LDAP IP Address.

Port: The port for the LDAP server (by default 389 TCP).

Enable LDAP over SSL: Check the box to enable LDAP over SSL.

Username: User with access to the server. For example... [email protected].

Password: User’s password.

Base DN: LDAP search base path.

Schedule Import Select the schedule settings or create a new schedule. To edit a schedule click

the button and a dialog box appears where to make the changes.

Test to ensure the authentication to access the remote directory server.

Allows importing a list of groups from the remote directory server.

LICENSE

The License window displays information about the current license. The fields are

populated when the license is uploaded.

To open the License window, on the Settings screen click the button.

Figure 62: License window

Page 70: Back box user-guide

70

Chapter 11. Settings BackBox User’s Manual

UPLOADING A NEW LICENSE

To upload a new license file:

1. On the License window click the button.

2. Select the appropriate license file and click the button.

DELETING A LICENSE

To delete a license:

1. On the License window click the button next to the license to be deleted. A

prompt appears requesting confirmation.

2. Click Yes.

ACCESS

The Access window allows the administrator to control the local firewall of the

BackBox server. This determines which IP Address/Network can access BackBox via

the SSH or the web interfaces or the CLI interfaces.

To open the Access window, on the Settings screen click the button.

Figure 63: Access window

MAINTENANCE

To open the Maintenance window, on the Settings screen click the

button.

Page 71: Back box user-guide

71

Chapter 11. Settings BackBox User’s Manual

Figure 64: Maintenance window

SITES

A Site is a logical partition which contains devices, device groups, templates or

backup instructions. It is a mechanism used by the Global Administrator to delegate

administration of all aspects of the BackBox application to local servers. These local

servers are managed by Site Administrators who control the configuration,

notifications and backup jobs. Creating sites is an efficient and effective way to help

organize and manage the devices and backups in larger and more complex

installations.

Sites help users know what devices they are authorized to access. Sites can be

assigned based on the combination of geographic location, device type and whatever

other criteria the Global Administrator deems necessary.

The Site window displays the number of devices assigned, the number of users, how

many backups are retained, and how many simple and complex devices there are. You

can also add, delete and edit sites as required.

To open the Sites window, on the Settings screen click the button.

Figure 65: Sites window

The window displays the site information, including: Site name, Number of Devices,

Users, Retention, Simple, Complex and Any.

Page 72: Back box user-guide

72

Chapter 11. Settings BackBox User’s Manual

ADDING A SITE

On the Sites window complete the fields and click . The new site will appear in

the list.

EDITING A SITE

1. On the Sites window, choose the site to be edited and click the button. The

parameters pertaining to that site now appear in the fields at the top of the window.

2. Enter the corrected values and click .

DELETING A SITE

1. On the Sites window, on the list of sites click the button on the site you wish to

delete. A prompt appears requesting confirmation.

2. Click Yes.

AGENTS

Agents are used to manage the backups when there are larger installations with

multiple servers.

To open the Agents window, on the Settings screen click the button.

Figure 66: Agents window

Page 73: Back box user-guide

73

Chapter 11. Settings BackBox User’s Manual

ADDING AN AGENT

1. On the Agents window click the button. The Add Agent window appears.

2. Fill in the Name and IP Address and click .

EDITING AN AGENT

You can edit the details of an agent, as well as the agent OS users.

To edit the details of an agent:

1. On the Agents window check the box next to the agent you wish to edit and click

the button. The following dialog box appears, defaulted to the Agent Details

tab:

Figure 67: Agent Details dialog box

2. Complete the changes and click .

To edit the Agent OS Users:

1. On the above dialog box, click the Agents OS Users tab. The following dialog box

appears:

Figure 68: Agent OS Users dialog box

2. Click the next to the OS user whose parameters you want to change and make

the intended changes.

Page 74: Back box user-guide

74

Chapter 11. Settings BackBox User’s Manual

3. To add a new user, in the fields at the top of the dialog box, type User name,

Password, and Site to which the user is assigned, and click .

DELETING AN AGENT

1. On the Agents window check the agent to be deleted.

2. Click the button. A prompt requesting confirmation to delete appears.

3. Click Yes.

SYSTEM LOGS

BackBox allows administrators to audit each user who accesses the system. The

program keeps a detailed log of each action performed in the system, as well the

object of the action.

The log details each time a user logs in, adds, updates or deletes. It also records the

objects of these actions such as devices, backup jobs, time and date, etc...

For example, if the Device Groups is changed, the log will show which user made the

change, what the change was, when it was done and whether the change was

successful.

To open the System Logs window, click the button.

Figure 69: System Logs window

AUDITING

The basic audit information is displayed in the Audit Log window.

To open the Audit Log window, on the System Logs window, on the row

click the button.

Page 75: Back box user-guide

75

Chapter 11. Settings BackBox User’s Manual

Figure 70: Audit Log window

Across the top of the window you can apply a filter to your audit by using any of the

following criteria: User, Action, Object and Parameter.

Table 14: Audit Log filter criteria

Criterion Description

User The user’s name.

Action You can filter for the following actions: Login, Add , Update, Delete

Object

Parameter User defined value

After the filter field is completed, click .

Page 76: Back box user-guide

76

Chapter 11. Settings BackBox User’s Manual

On some of the items displayed on the Audit Log, there is more detailed log

information available. To view the additional log details, click the magnifying glass

button at the end of the row. The Audit Details Log window appears.

Figure 71: Audit Details Log window - Sites

Note: Each object will display different details in the log. For example, Figure71

shows details from updating a Site from Settings. Figure 72 shows details from

updating Device Info from Devices.

Figure 72: Audit Details Log window - Devices

Page 77: Back box user-guide

77

Chapter 11. Settings BackBox User’s Manual

MESSAGES

Messages shows a log from the BackBox operating system (/var/log/messages)

To open the Messages, on the System Logs window, on the row click the

button.

Figure 73: Logs Trail window

You can also download the message logs to your computer by clicking the button

at the end of the Messages row on the System Logs screen.

VSFTPD

VSFTPD shows the BackBox VSFTPD log (/var/log/vsftpd.log).

To open the VSFTPD log, on the System Logs window, on the row, click the

button.

You can also download the VSFTPD log by clicking the button at the end of the

VSFTPD row on the System Logs screen.

Page 78: Back box user-guide

78

Index BackBox User’s Manual

INDEX

A

Access ............................................... 63, 70

Administration ................................. 63, 67

General Settings ................................ 68

Agents .............................................. 63, 72

Adding an Agent ................................ 73

Agent Details tab ............................... 73

Agent OS Users .................................. 73

Agent OS Users tab ............................ 73

Deleting an Agent .............................. 74

Editing an Agent ................................ 73

Alerts ................................................ 63, 66

Audit Log criteria .................................... 75

Auditing .................................................. 74

Audit Details Log window .................. 76

Messages ........................................... 77

VSFTPD ............................................... 77

Authentication ................................. 19, 54

BackBox Users ................................... 56

Authentication Templates ..................... 54

Adding an Authentication Template.. 55

Deleting an AuthenticationTemplate 56

B

BackBox Access screen........................... 15

BackBox Documentation ........................ 59

Backup ................................................... 18

Backup History ....................................... 34

Backup Jobs ............................................ 30

Adding a Backup Job .......................... 31

Backup Jobs window ......................... 30

Deleting a Backup Job ........................ 33

Disable a Backup Job ......................... 33

Manual backup .................................. 31

Next Execution................................... 31

Scheduler ........................................... 32

Terminating a backup ........................ 31

Backup Queue ........................................ 33

Terminating a job in queue ............... 33

Backup Retention ............................. 38, 68

Backup Trail Log ..................................... 41

Base DN .................................................. 69

Page 79: Back box user-guide

79

Index BackBox User’s Manual

C

Clones ..................................................... 36

D

Dashboard tab............................ 17, 18, 19

Displays .............................................. 20

Device Backup History ........................... 40

Device Configuration Status ................... 20

Device Groups .................................. 18, 35

Adding a new Device Group .............. 46

Deleting a Device Group .................... 47

Device Groups screen ........................ 45

Device Status .......................................... 20

Device Status by Group .......................... 21

Device Status by Type ............................ 20

Devices ....................................... 18, 35, 62

Adding a new Device ......................... 42

Deleting a Device ............................... 45

Device Details tab .............................. 37

Device IP ............................................ 37

Displaying the details ................... 36, 37

Exporting a Device ............................. 36

How to configure a device ................. 38

How to restore a device .................... 38

Importing a device ............................. 36

DNS .................................................. 62, 65

Documentation ...................................... 58

Adding a Document ........................... 60

Custom Documentation .................... 59

Deleting a Document ......................... 60

Downloading a Document ................. 60

Documents ............................................. 19

E

Email Report .......................................... 53

Enable LDAP over SSL ............................. 69

Encrypt Backup Files .............................. 68

Execution Time ...................................... 68

Expert Password .................................... 38

Export a Device ...................................... 36

Extra Password ....................................... 55

F

Features of the system .......................... 11

G

Gateway ................................................. 15

General Settings ..................................... 68

H

Help Button ............................................ 17

Hostname ............................................... 69

Page 80: Back box user-guide

80

Index BackBox User’s Manual

I

Importing a Device ................................. 36

Installation ............................................. 14

Interfaces ......................................... 62, 63

Inventory ................................................ 42

IP Address ........................................ 13, 68

IP v4 ................................................... 15

IP v6 ................................................... 15

L

LDAP Authentication .............................. 69

License ....................................... 21, 63, 69

Deleting a License .............................. 70

Uploading a new License ................... 70

Logging in ............................................... 16

Login screen ........................................... 16

Logout Button ........................................ 17

M

Main screen ........................................... 16

Dashboard tab ................................... 16

Toolbar............................................... 17

Main screen toolbar

Understanding the toolbar ................ 17

Maintenance .......................................... 63

N

Notifications ..................................... 18, 51

Adding a Notification ......................... 51

Deleting a Notification ....................... 53

P

Port ........................................................ 69

R

Radius Authentication 1 & 2 .................. 68

Radius Port ............................................. 68

Radius Server ......................................... 68

Recovery Procedures ............................. 58

Release Notes ........................................ 58

Reports ................................................... 22

Adding a new Report ......................... 22

Deleting a Report ............................... 23

Device Details .................................... 24

Device Health .................................... 24

Device Status ..................................... 27

Device Status -by Group .................... 25

Device Status by Type ........................ 26

Editing a Report ................................. 23

Inventory ........................................... 28

Types of Reports ................................ 24

Users .................................................. 29

Page 81: Back box user-guide

81

Index BackBox User’s Manual

Reports tab................................. 17, 18, 21

Role for a user ........................................ 57

Routing ............................................. 62, 64

Adding a Route .................................. 64

Deleting a Route ................................ 65

Editing a Route .................................. 64

S

Schedules ......................................... 18, 48

Adding a new Schedule ..................... 48

Deleting a Schedule ........................... 50

Secret Key .............................................. 69

Settings ............................................ 19, 62

Sites .................................................. 63, 71

Adding a Site ...................................... 72

Deleting a Site .................................... 72

Editing a Site ...................................... 72

SMTP ...................................................... 66

SNMP ..................................................... 66

SSH Key .................................................. 68

Syslog ..................................................... 66

Syslog Report ......................................... 52

System Information ............................... 21

System Logs ..................................... 63, 74

System Prerequisites ............................. 13

System Requirements ............................ 13

T

TCP/IP

Manual TCP/IP Configure screen ....... 15

Settings .............................................. 15

TCP/IP Configure screen ........................ 14

Terminating ............................................ 33

Time and Date .................................. 63, 65

NTP .................................................... 66

Toolbar ................................................... 17

Typographical Conventions.................... 12

V

VSFTPD ................................................... 77

W

Windows Backup Scripts ........................ 58