Configuration 4.4

From SEPsesam
Jump to: navigation, search
Other languages:
Deutsch • ‎English
User Manual

GUI Configuration Options

You can access the configuration options from the menu bar -> Configuration. Configuration provides different settings and parameters that define SEP sesam look and feel as well as its behavior. The following functions are available by selecting the Configuration option in the menu bar.

Configuration overview.png


Under Defaults, you can define the access to SEP sesam online help, define some extra settings, set retention periods for logs and restore tasks, change UI mode, customise the GUI font and tables, check the settings and set the date format. Note that the last tab differs depending on SEP sesam version, however most of the options basically remain the same.


  • By default, the option Use Web help in the GUI is set. The online help is set to the user manual on the SEP sesam Wiki, thus providing the latest updated version of help topics online. Unless your GUI client has internet connection problems, it is recommended to use the latest Web help.
  • For a GUI client without an internet connection, copy the user manual to local storage and set a link to the local help file by using the option Use local help in the GUI.
    • Use the search button to select the local HTML site.
    • Use the test it button to check the access to help files.
Defaults help.jpg


Defaults extras.jpg

The following settings can be activated in Extras:

  • Switch off the scrolling for warning "30 Days remaining for update authorisation"
    You can switch off the scrolling for notification about the pending expiration of updates. If there is no update permission, the notification never appears. After installing update, this option is reset.
  • Provide selection of "broken backups" in the Restore Wizard
    If this option is checked, you are allowed to perform a restore from incomplete, broken, or interrupted backups. By default, this selection is not provided.
  • Number of tracelog lines to display
    The default value for tracelog lines is 60. Click the arrows to increase or decrease the number of lines.
  • RSS Notification polling interval
    The default polling interval for RSS Notification is 720 minutes. Click the arrows to increase or decrease the polling interval.
  • User specific default interfaces for drive group
    You can set a user specific interface for each disk drive group (Default Interface). This setting overrides the default interface specified via the drive group.

Default user defined.png

  • Compress LIS files
    By default, the LIS files are compressed after 14 days. You can change the number of days after which the LIS files are compressed or deactivate the check box to prevent compression of LIS files.
  • Globally activate Changed Block Tracking (CBT)
    By default, the CBT is enabled to provide change tracking thus saving disk space with optimized block level incremental and differential backups of VMDKs. Note that disabling CBT globally will affect your backup performance and use more disk space. For more details, see Changed Block Tracking (CBT).
  • UI Mode (available for v. ≥ 4.4.3 Grolar)
    You can select between different UI modes: Basic, Advanced or Expert. For example, basic mode makes GUI simpler for less advanced users.
Defaults extras Grolar.jpg

In the Expert mode some additional options are available. By double-clicking Backups or Restores by state you can review trace log information, displayed in the new Trace Log tab.

Retention Periods
You can set up the retention period in days for SEP sesam logs, readability check logs, calendar sheet entries and restore tasks. The retention period is the time period for which the SEP sesam retaines specified data. Once the retention period expires, the data is removed from the database and is no longer available. Click the arrows to increase or decrease the predefined retention time per file.

  • Sesam Logs: The default value for preserving the SEP sesam log files is 7 days.
  • Readability Check Logs: The default value for preserving the readability check log files is 2190 days.
  • Calendar sheet entries: The default retention time for old calendar sheet entries is 35 days.
  • Restore tasks: The default retention time for old restore tasks is 7 days.
Defaults retention periods.jpg

Fonts and tables
You can customize your SEP sesam GUI appearance by changing:

  • Font Style: The predefined GUI font is plain. Check the Bold Font option to change the font-weight property of the entire GUI.
  • Table Striping: You can change the appearance of GUI tables by selecting one of the zebra striping tables from the drop-down list.
  • Table Row Spacing: Click the arrows to adjust the spacing between table rows in the entire GUI.
  • Font used in tables (available for v. ≥ 4.4.3 Grolar): You can change the default font (proportional) to non-proportional (monospaced).
Defaults fonts Grolar.jpg


The Settings tab displays an overview of all internal GUI settings.

Defaults settings.jpg

Display Format | Data displays | Default Date Format

The name of the last tab differs depending on SEP sesam version, however all options remain the same.

SEP sesam version 4.4.3

Under the last tab Default Date Format, you can change default setting for the date format.

SEP sesam version 4.4.3 Tigon

Under the last tab Data displays (previously Default Date Format), you can change the default setting for the date format as well as default setting for data size units. The data size can be specified either with decimal (KB, MB, GB, TB) or binary prefix (KiB, MiB, GiB, TiB). For details, see Changing data size units.

Defaults data size.jpg

Media types

Listing of all media types defined in SEP sesam. Entries in black font are the media types currently used. They were set up in the database at the installation of sesam and – contrary to the user defined media types (green font) – cannot be erased nor changed.

Media types.png

Media type  
Sesam internal identification of the media type
Drive type  
Sesam internal drive types
Storage capacity of allowed combination media / drive


You can create and define your own commands to be used for various tasks within SEP sesam environment.

Configuration commands.jpg

When configuring a new command, you have to define the following:

  • Name: Enter a name for the new event.
  • Client: Select a client, on which the command will be executed.
  • User: Enter the username of a user with sufficient access to execute the command on the client.
  • Command: Enter the complete command (and parameters if required), e.g., eventlog.ps1.
Information sign.png Note

When defining your own commands, some security considerations apply and are explained in Access restriction of command events.

Remote Server (Master GUI only)

This option is used for the server administration of the Master GUI. It is possible to both configure or remove SEP sesam Servers or add new servers to the backup tree.

Information sign.png Note
The menu option is only available in the SEP sesam version Master Sesam.
Remoteserver en.jpg

Server Name  
Name of additional SEP sesam Server in the network
Server is in the network (green = ON, red = broken, gray = OFF)
GUI Build  
GUI version
Type (obsolete as of version 4.4.3 Tigon)  
Connection type between GUI and kernel
Operating System  
OS of the SEP sesam Server

The Master GUI allows the administrator control of all SEP sesam servers and clients.

Newremoteserver 4.0 en.jpg

When entering a new server into the SEP sesam backup scheduler, there are additional parameters which must be set. The values are preset with default settings.

Server name 
Name of the SEP sesam
Switch ON or OFF
DB Name (obsolete as of version 4.4.3 Tigon)
Name of the SEP sesam internal database
DB Port (obsolete as of version 4.4.3 Tigon)
Port number for the database connection
RMI Port 
Port number for client-server connection
Optional comment by the user

User Permissions

User permissions 4.4.jpg

As of version 4.4.3 Tigon, the User Permissions item is only visible if policy-based authentication is activated (default). For details, see Configuring Policy-Based Authentication.

In User Permissions you can configure the user authorization. Options are 'Admin' (the only user role with full control over the SEP sesam), 'Operator' (monitors the SEP sesam Server backup status) and 'Restore' (only allowed to start restores). The assignment of permissions is user- and client specific. If a non-authorized user or non-authorized client tries to create a GUI connection, it is rejected.

New users permission 4.4.jpg

Note 1: If the name resolution for the selected client is not complete (IP name and reverse lookup of the IP address), the connection is also rejected!

Note 2: Alternatively the SEP sesam program sm_setup can be utilized to assign user permissions:

  • Adding a user permission:
sm_setup allow_gui -u *|<user> -c *|<client> -m admin|operator|restore
  • Removing a user permission:
sm_setup disallow_gui -u *|<user> [-c *|<client>] [-m *|admin|operator|restore]
  • View permissions of users or clients:
sm_setup get_policy [-m user|client]

Permission Management

Introduced in v. 4.4.3, SEP sesam provides different authentication methods that are mutually exclusive. For details, see About Authentication and Authorization.

Depending on which authentication mode is active, one of the following options is shown:

  • Policy-based authentication is enabled by default. You can switch to database-based authentication by using the Activate Authentication button in the Permission Management window. If you choose not to activate the database-based authentication, policy-based authentication stays enabled. Policy-based authentication is configured in User Permissions (see previous menu option). For details, see Configuring Policy-Based Authentication.
  • When you turn on database-based authentication by using the Activate Authentication button, upon the restart of a GUI and SEP sesam client, you can use any of the 3 available tabs: Users, Groups and Activation. You can create users, modify their settings, such as adding a user to the group or removing it from the group, and delete users. You can also deactivate the database-based authentication.
  • Authentication users.jpg

E-Mail Settings

The e-mail settings allow to configure the e-mail accounts that can be used for sending emails from the SEP sesam interface or from the command line. The default email account is sesam.

Configuration e-mail.png

By clicking New the following window is opened:

Email account 4.4.png

  • Account: Name of account (mandatory)
  • Customer: Name of customer
  • Sender: E-mail address
  • SMTP Server: Name or IP-address of the outgoing mail server
  • SMTP user: User name for SMTP server
  • Password: Password for the mail server. Password is mandatory if SMTP Server requires authentication
  • SMTP port:
  • Recipient: Address of recipient
  • CC: Address for copy of the email
  • BCC: Address for copy of the email
  • SSL: Optionally, select to connect securely via SSL or TLS

If no SMTP user name is specified, it is assumed that no authorization is required at the SMTP Server.


User interfaces are configurable programs, intended for system administrators that can use them to create their own commands. They can be used to perform additional actions, such as exporting a database, restarting a database, and sending emails. The following interfaces are available: pre (sbc_pre), post (sbc_post), alarm (sm_alarm), disaster (sm_disaster) notify (sm_notify). The pre/post-interface might affect backup execution; when creating a script, have in mind that any pre/post script should not take a long time to complete as it can delay the backup.

Interfaces pre.jpg

User interfaces can be programmed using any text editor. To use an interface, you have to activate it first and create your own commands. From the Interfaces menu, select the interface you want to activate; if you are configuring a pre/post interface, you have to select a client too since these two interfaces are created for each client individually and are only executed on the selected client. The interface script window opens, allowing you to configure the desired action. Once done, click Save to activate the interface. The interface is saved to the <SESAM_ROOT>/bin/sesam directory. For details, see Using Pre and Post Scripts.

Alternatively, you can activate the user interfaces by using the templates that are available in the SEP sesam directory <SESAM_ROOT>/skel/templates. To activate an interface, you have to copy its corresponding template file to the directory <SESAM_ROOT>/bin/sesam. The templates are only active and executed on the client.

If the email configuration is set, SEP sesam interfaces send messages by email. The default email account is sesam. For details, see How to configure Mail Notification.

SEP sesam allows the use of Pre-, Post-, Alarm-, Notify-, and Disaster interfaces to be combined into scripts. A detailed description of these interfaces with all parameters and settings can be found in the Administration Manual.

Interfaces pre edit.jpg

PRE interface

Before a backup begins, an administrator can specify special actions to be executed before and during the backup activity. For example, the system can generate messages to quickly notify the administrator of either backup job success or failure. Pre-interface can be used to create commands that will stop or start the selected programs; for example, it may be used to stop the database before it is backed up.

POST interface

Once the backup is finished, some special actions may be required (e.g., notifications/messages, program end/start, restart databases etc.). These actions can be programmed with the help of the post-interface.

Alarm interface

The SEP sesam system needs no administration after complete set-up of all clients and backup tasks during normal operation (except for the restore). If any functional errors occur, e.g., failure of a certain backup, this event is automatically passed on to the alarm interface. This interface is programmable to filter desired messages and their conveyance to the authorized personnel.

Information sign.png Note
Do not use commands which require input from the user, such as OK buttons. Commands that require user interaction may cause interruption of backups during the night.
Notify interface

Similarly, there is a procedure for successful backups and restores which uses the sm_notify. This can be programmed as needed.

Disaster interface

The term disaster refers to a catastrophic failure or complete destruction of the SEP sesam Server and its data. The SEP sesam disaster interface must be properly configured to help carry out the disaster recovery process. To prepare for a possible breakdown of the SEP sesam Server, a self-backup of the SEP sesam installation must be performed. For details on how to prepare, see SEP sesam Server Disaster Recovery.

The disaster interface sends an email describing the recovery procedure in the event of disaster and an attachment containing the SEP sesam bootstrap database with all essential data for the disaster recovery. The sm_disaster file is located in:

  • Linux: <SESAM_BIN>/skel/templates/sm_disaster
  • Windows: <SESAM_BIN>/skel/templates/sm_disaster.ps1

As an alternative to using Interfaces in GUI, the disaster interface file can also be copied to SESAM_BIN>/bin/sesam/sm_disaster and modified according to the needs of each environment. For details, see SEP sesam Server Disaster Recovery.

User view

Available for v. ≤ 4.4.3. Based on the user permissions, certain SEP sesam GUI elements (Components, Tasks and Scheduling) are disabled when the user view is changed from Admin to Operator.
There are two types of user views: Admin and Operator. Only the Admin has full control over the SEP sesam, while Operator is only allowed to monitor SEP sesam events and logs on GUI client.

For more details, see FAQ:SEP sesam GUI.

Configuration user view.jpg