Source:Creating Exclude List: Difference between revisions
(Marked this version for translation) |
No edit summary |
||
(19 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
<noinclude><div class="noprint"><languages /> | |||
<noinclude> | <br /> | ||
<div class="noprint"> | |||
< | |||
<translate>===Overview=== <!--T:3--></translate> | |||
</div></noinclude><translate><!--T:11--> | |||
For each backup, you can back up only selected files, [[Special:MyLanguage/FAQ#incl-excl_files|files that match a specific pattern]], and exclude specific files, file types or directories from backups.</translate> | |||
<translate><!--T:11--> | |||
For each backup, you can back up only selected files, [[Special:MyLanguage/ | |||
<translate><!--T:12--> | <translate><!--T:12--> | ||
Some files are only temporary, while others are permanently in use. These files should either be excluded from | Some files are only temporary, while others are permanently in use. These files should either be excluded from normal backup or backed up in a special way. For example, you may not want to back up temporary (''.tmp'') files, read-only files, or files from specific directories (e.g., the ''download'' directory). SEP sesam provides a number of ways to set exclusions:</translate> | ||
*<translate> | *<translate> | ||
<!--T:69--> | <!--T:69--> | ||
[[ | [[#GUI|Setting up an ''Exclude list'']] in the GUI.</translate> | ||
*<translate><!--T:14--> | *<translate><!--T:14--> | ||
[[ | [[#custom|Creating a custom exclude list]] on the [[Special:MyLanguage/SBC_CLI#exclude_lists|SEP sesam Client (SBC CLI)]] to exclude a larger number of files.</translate> | ||
*<translate><!--T:15--> | *<translate><!--T:15--> | ||
[[ | [[#nosbc|Creating a special file ''nosbc'' in the directory]] itself to permanently mark the directory for exclusion.</translate> | ||
*<translate><!--T:16--> | *<translate><!--T:16--> | ||
[[ | [[#sm.ini|Using the SEP sesam configuration file ''sm.ini'']] to exclude files from all backups on the client. </translate> | ||
==={{anchor|GUI}}<translate><!--T:70--> | |||
Exclude list in the GUI=== | |||
<!--T:71--> | <!--T:71--> | ||
When creating a backup task, you specify the source for your backup and define any files or patterns you want to exclude from the backup. Note that if the number of files to be excluded from the backup exceeds the allowed length for the exclude list, you should set up the exclusion as described in the section [[ | When creating a backup task, you specify the source for your backup and define any files or patterns you want to exclude from the backup. Note that if the number of files to be excluded from the backup exceeds the allowed length for the exclude list, you should set up the exclusion as described in the section [[#custom|Create a custom exclude list on the client]]. Such a custom exclude list (e.g., -X C:/sesam/exclude_list.txt) takes precedence over an exclude list set in the GUI.</translate> | ||
<ol><li><translate><!--T:72--> | <ol><li><translate><!--T:72--> | ||
From ''Main Selection'' -> '''Tasks''' -> '''By Clients''', select your client and click '''New Backup Task'''. The ''New Backup Task'' window opens.</translate> | From ''Main Selection'' -> '''Tasks''' -> '''By Clients''', select your client and click '''New Backup Task'''. The ''New Backup Task'' window opens.</translate></li> | ||
<li><translate><!--T:73--> | <li><translate><!--T:73--> | ||
Specify the '''Source'''. If you want to back up individual files, you can either browse for directories and files to include in the backup or enter their names followed by a comma (''C:/Program Files/SEPsesam/var/db,C:\Users\AA\Documents\references''). If you want to back up the entire file system, enter ''all'' as the source. If you only want to back up files that match a specific pattern, use the [[Special:MyLanguage/ | Specify the '''Source'''. If you want to back up individual files, you can either browse for directories and files to include in the backup or enter their names followed by a comma (''C:/Program Files/SEPsesam/var/db,C:\Users\AA\Documents\references''). If you want to back up the entire file system, enter ''all'' as the source. If you only want to back up files that match a specific pattern, use the [[Special:MyLanguage/FAQ#incl-excl_files|include list]] instead. Note that if you select the source by browsing, the ''task type'' and ''task name'' are set automatically. If you enter the source manually, you have to enter the ''task name'' and select the appropriate [[Special:MyLanguage/SEP_sesam_Glossary#task_type|''task type'']].</translate></li> | ||
<li><translate><!--T:74--> | <li><translate><!--T:74--> | ||
In the '''Exclude list''', specify the files or folders you do not want to back up in one of the following ways:</translate><br /> | In the '''Exclude list''', specify the files or folders you do not want to back up in one of the following ways:</translate><br /> | ||
<translate><!--T:75--> | {{anchor|browse_button}}<translate><!--T:75--> '''Exclude using the ''browse'' button'''</translate><br /><translate><!--T:76--> | ||
The easiest way to exclude specific files or folders from backup is to use the large ''browse'' button (next to the fields ''Source'' and ''Exclude list'') and select the source for exclusion in the ''Client File View'' window. In our example, we have excluded ''logs'' and ''program files'' from the backup, as shown in the screenshot below.</translate><br /> | |||
The easiest way to exclude specific files or folders from | |||
<translate><!--T:77--> | <translate><!--T:77--> | ||
[[image: | [[image:Basic_exclude_list_Apollon.jpg|700px|link=]]</translate> | ||
<br clear=all> | <br clear=all> | ||
<translate><!--T:78--> | {{anchor|editor}}<translate><!--T:78--> | ||
'''Add files, file types or regular expressions in the ''Exclude list editor'''''</translate><br /> | |||
<translate><!--T:79--> | <translate><!--T:79--> | ||
In the '''Exclude list editor''', you can specify exclusions using regular expressions. On Windows, you can also use the option ''Pattern exclude'', but on Linux it is only possible to exclude using regular expressions ('' | In the '''Exclude list editor''', you can specify exclusions using regular expressions. On Windows, you can also use the option ''Pattern exclude'', but on Linux it is only possible to exclude using regular expressions (''regex exclude'').</translate> | ||
<br /><translate><!--T:80--> | <br /><translate><!--T:80--> | ||
Add the exclusion patterns one after the other, followed by a comma. | Add the exclusion patterns one after the other, followed by a comma. On Linux, each exclude must be specified with a leading <code>\.</code> (for example, <tt>\./tmp/$,\./dev/null$</tt>). The procedure for using regex exclude is SEP sesam version dependent. For more details, see [[Special:MyLanguage/Exclude_with_Regular_Expressions|Exclude with Regular Expressions]]. </translate><br /> | ||
<translate><!--T:81--> [[image:Exclude_list_Apollon.jpg|700px|link=]]</translate> | |||
<br /> | |||
<translate> | |||
<!--T:81--> | |||
[[image: | |||
<br clear=all> | <br clear=all> | ||
<translate><!--T:82--> | <translate><!--T:82--> | ||
Line 82: | Line 50: | ||
<!--T:83--> | <!--T:83--> | ||
For more examples of exclusions using regular expression patterns, see [[Special:MyLanguage/RegExp:_Examples_for_Excluding_Matched_Patterns|Examples for Excluding Matched Patterns]].</translate> | For more examples of exclusions using regular expression patterns, see [[Special:MyLanguage/RegExp:_Examples_for_Excluding_Matched_Patterns|Examples for Excluding Matched Patterns]].</translate> | ||
{{ | {{note|<translate><!--T:26--> | ||
note | Exclude using regular expressions is the default setting, but you can change it to use the file pattern (?,*) instead of regex by modifying the configuration file <tt><SESAM_VAR>/var/ini/sm.ini</tt> on the [[Special:MyLanguage/SEP_sesam_Glossary#SBC|SEP sesam Client]]. In the config file <tt>sm.ini</tt> change the entry</translate><br /> <translate><!--T:67--> | ||
Exclude using regular expressions is the default setting, but you can change it to use the file pattern (?,*) instead of | |||
<nowiki>EXCLUDE_MATCH= REGEXP to EXCLUDE_MATCH= PATTERN</nowiki></translate>.}} | <nowiki>EXCLUDE_MATCH= REGEXP to EXCLUDE_MATCH= PATTERN</nowiki></translate>.}} | ||
==={{anchor|custom}}<translate><!--T:27--> | |||
Create a custom exclude list on the client=== | |||
<!--T:28--> | <!--T:28--> | ||
You can specify a custom exclude list of items to be skipped during backup by creating a special file on SEP sesam Client. Typically, you would create a separate exclude file if the number of files or directories to be excluded for backup exceeds the allowed length for the exclude list (max. 1024 characters). Such a | You can specify a custom exclude list of items to be skipped during backup by creating a special file on SEP sesam Client. Typically, you would create a separate exclude file if the number of files or directories to be excluded for backup exceeds the allowed length for the exclude list (max. 1024 characters). Such a custom exclude list takes precedence over an exclude list specified in the GUI (the latter is ignored if both are specified). | ||
<!--T:29--> | <!--T:29--> | ||
A custom exclude list must be a text file that is created on the SEP sesam Client | A custom exclude list must be a text file that is created on the SEP sesam Client where the backup will be executed. The syntax for exclude entries is platform/OS dependent, see:</translate> | ||
*<translate><!--T:30--> | *<translate><!--T:30--> | ||
[[ | [[#linux|Exclude list on Linux]]</translate> | ||
*<translate><!--T:31--> | *<translate><!--T:31--> | ||
[[ | [[#windows|Exclude list on Windows]]</translate> | ||
*<translate><!--T:32--> | *<translate><!--T:32--> | ||
[[ | [[#novell|Exclude list for Micro Focus OES (formerly Novell OES)]]</translate> | ||
<translate><!--T:33--> | <translate><!--T:33--> | ||
Line 107: | Line 75: | ||
<translate><!--T:34--> | <translate><!--T:34--> | ||
Create or open the '''backup task''', select the '''Options''' tab and under | Create or open the '''backup task''', select the '''Options''' tab and under ''Additional call arguments'' in the '''Backup options''' field, enter the specified file in the form: | ||
-X C:/sesam/exclude_list.txt</translate> | -X C:/sesam/exclude_list.txt</translate> | ||
===={{anchor|linux}}<translate><!--T:35--> | |||
Exclude list on Linux==== | |||
<!--T:36--> | <!--T:36--> | ||
Line 116: | Line 85: | ||
*<translate><!--T:37--> | *<translate><!--T:37--> | ||
Each file or directory you want to exclude from the backup must be specified on a separate line (one entry per line). </translate> | Each file or directory you want to exclude from the backup must be specified on a separate line (one entry per line). </translate> | ||
*<translate><!--T:97--> Each exclude must be specified with a leading {{path|\.}}.</translate> | |||
*<translate><!--T:38--> | *<translate><!--T:38--> | ||
Line 127: | Line 98: | ||
\./tmp$ | \./tmp$ | ||
\./home/John Doe/videos.zip$ | \./home/John Doe/videos.zip$ | ||
\./home/John Doe/Business Documents/YearEnd Closing for business year | \./home/John Doe/Business Documents/YearEnd Closing for business year 2021$ | ||
===={{anchor|windows}}<translate><!--T:41--> | |||
Exclude list on Windows==== | |||
<!--T: | |||
<!--T:42--> | <!--T:42--> | ||
Line 139: | Line 107: | ||
* <translate><!--T:43--> | * <translate><!--T:43--> | ||
Use only {{path|/}} (slash) in the exclude file and NOT {{path|\}} (backslash).</translate> | Use only {{path|/}} (slash) in the exclude file and NOT {{path|\}} (backslash).</translate> | ||
*<translate><!--T:96--> Use the syntax "/$" for excluding directories, for example, <tt>F:/tmp/$</tt>.</translate> | |||
* <translate><!--T:44--> | * <translate><!--T:44--> | ||
Each file or directory you want to exclude from the backup must be specified | Each file or directory you want to exclude from the backup must be specified on a separate line (one entry per line). This also applies to paths that contain spaces.</translate> | ||
<translate><!--T:45--> | <translate><!--T:45--> | ||
This is an example of the ''exclude_list.txt'' file on Windows:</translate> | This is an example of the ''exclude_list.txt'' file on Windows:</translate> | ||
D:/DOWNLOAD | D:/DOWNLOAD/ | ||
D:/PREKITS | D:/PREKITS/ | ||
D:/Dev | D:/Dev/ | ||
D:/kit_2_3_1_7 | D:/kit_2_3_1_7/ | ||
D:/kit_2_3_1_5 | D:/kit_2_3_1_5/ | ||
D:/knoppix | D:/knoppix/ | ||
D:/ACHIM | D:/ACHIM/ | ||
D:/gui | D:/gui/ | ||
===={{anchor|novell}}<translate><!--T:46--> | |||
Exclude list for Micro Focus OES (formerly Novell OES)==== | |||
<!--T:47--> | <!--T:47--> | ||
Create the exclude file on the client in the directory {{path|/etc/sesam}}, for example {{path|/etc/sesam/exclude_list.txt}}. The following rules apply:</translate> | Create the exclude file on the client in the directory {{path|/etc/sesam}}, for example {{path|/etc/sesam/exclude_list.txt}}. The following rules apply:</translate> | ||
*<translate><!--T:48--> | *<translate><!--T:48--> | ||
Each file or directory you want to exclude from the backup must be specified | Each file or directory you want to exclude from the backup must be specified on a separate line (one entry per line). </translate> | ||
*<translate><!--T:49--> | *<translate><!--T:49--> | ||
Line 180: | Line 148: | ||
<translate><!--T:53--> | <translate><!--T:53--> | ||
For example, ''/media/nss/VOL1'' is set as the source in the backup task. This means that | For example, ''/media/nss/VOL1'' is set as the source in the backup task. This means that the entire contents ''VOL1'' will be backed up, except for the items in the exclusion file specified by the following entry in the ''backup task properties'' -> '''Options''' tab -> '''Backup options''' (previously ''Save options'') field:</translate> | ||
-X /etc/sesam/exclude_list.txt | -X /etc/sesam/exclude_list.txt | ||
<translate><!--T:54--> | <translate><!--T:54--> | ||
SEP sesam will exclude all files and directories | SEP sesam will exclude from backup all files and directories that are listed in the file.</translate> | ||
==={{anchor|nosbc}}Creating a special file ''nosbc'' to permanently exclude a directory=== | ==={{anchor|nosbc}}<translate><!--T:55--> | ||
Creating a special file ''nosbc'' to permanently exclude a directory=== | |||
<!--T:56--> | <!--T:56--> | ||
Line 193: | Line 162: | ||
<!--T:57--> | <!--T:57--> | ||
This behavior can be switched off for a specific backup task by entering the ''-o noexcl'' switch in the '''backup task properties''', tab '''Options''' -> '''Backup options'''. | This behavior can be switched off for a specific backup task by entering the ''-o noexcl'' switch in the '''backup task properties''', tab '''Options''' -> '''Backup options'''.</translate> | ||
==={{anchor|sm.ini}}Using ''sm.ini'' to completely exclude files from backups on the client=== | ==={{anchor|sm.ini}}<translate><!--T:58--> | ||
Using ''sm.ini'' to completely exclude files from backups on the client=== | |||
<!--T:59--> | <!--T:59--> | ||
Line 201: | Line 171: | ||
<translate><!--T:60--> | <translate><!--T:60--> | ||
The default location of the sm.ini file is <tt><SESAM_ROOT>\var\ini\sm.ini</tt>. | The default location of the <tt>sm.ini</tt> file is <tt><SESAM_ROOT>\var\ini\sm.ini</tt>. | ||
<!--T:61--> | <!--T:61--> | ||
To define the exclusions for the client, open the <tt>sm.ini</tt> file and under the parameter <tt>SBC_EXCLUDE</tt> enter one parameter per line. | To define the exclusions for the client, open the <tt>sm.ini</tt> file and under the parameter <tt>SBC_EXCLUDE</tt> enter one parameter per line. | ||
*On Linux, use regular expressions to define the exclusions in <tt>sm.ini</tt>.</translate><br /> | |||
<translate><!--T:92--> The following example shows the pattern for excluding the directories ''/dev'', ''/mnt'' and ''/media'' from backup.</translate> | |||
<translate><!--T:92--> The following example shows the pattern for excluding the directories ''/dev'', ''/mnt'' and ''/media'' from backup | |||
[SBC_EXCLUDE] | [SBC_EXCLUDE] | ||
ExcludePattern1=\./mnt$ | ExcludePattern1=\./mnt$ | ||
Line 214: | Line 182: | ||
ExcludePattern3=\./media$ | ExcludePattern3=\./media$ | ||
{{ | {{Note|<translate><!--T:84--> | ||
The ''ExcludePattern900'' and higher exclude parameters are used for SEP sesam specific | The ''ExcludePattern900'' and higher exclude parameters are used for SEP sesam specific exclude patterns. To define your own exclude patterns, use the parameters ''ExcludePattern1'' to ''ExcludePattern899''.</translate>}} | ||
<translate><!--T:62--> | *<translate><!--T:62--> | ||
On Windows, use file patterns to define the exclusions in <tt>sm.ini</tt>. This allows you to exclude files that match the specified names or paths (note that <file_name> can also contain wildcard characters, e.g., * and ?).</translate> | |||
<noinclude | <noinclude><div class="noprint"> | ||
{{Copyright}}</div></noinclude> | |||
Latest revision as of 16:19, 28 March 2024
For each backup, you can back up only selected files, files that match a specific pattern, and exclude specific files, file types or directories from backups.
Some files are only temporary, while others are permanently in use. These files should either be excluded from normal backup or backed up in a special way. For example, you may not want to back up temporary (.tmp) files, read-only files, or files from specific directories (e.g., the download directory). SEP sesam provides a number of ways to set exclusions:
- Setting up an Exclude list in the GUI.
- Creating a custom exclude list on the SEP sesam Client (SBC CLI) to exclude a larger number of files.
- Creating a special file nosbc in the directory itself to permanently mark the directory for exclusion.
- Using the SEP sesam configuration file sm.ini to exclude files from all backups on the client.
Exclude list in the GUI
When creating a backup task, you specify the source for your backup and define any files or patterns you want to exclude from the backup. Note that if the number of files to be excluded from the backup exceeds the allowed length for the exclude list, you should set up the exclusion as described in the section Create a custom exclude list on the client. Such a custom exclude list (e.g., -X C:/sesam/exclude_list.txt) takes precedence over an exclude list set in the GUI.
- From Main Selection -> Tasks -> By Clients, select your client and click New Backup Task. The New Backup Task window opens.
- Specify the Source. If you want to back up individual files, you can either browse for directories and files to include in the backup or enter their names followed by a comma (C:/Program Files/SEPsesam/var/db,C:\Users\AA\Documents\references). If you want to back up the entire file system, enter all as the source. If you only want to back up files that match a specific pattern, use the include list instead. Note that if you select the source by browsing, the task type and task name are set automatically. If you enter the source manually, you have to enter the task name and select the appropriate task type.
- In the Exclude list, specify the files or folders you do not want to back up in one of the following ways:
Exclude using the browse button
The easiest way to exclude specific files or folders from backup is to use the large browse button (next to the fields Source and Exclude list) and select the source for exclusion in the Client File View window. In our example, we have excluded logs and program files from the backup, as shown in the screenshot below.
Add files, file types or regular expressions in the Exclude list editor
In the Exclude list editor, you can specify exclusions using regular expressions. On Windows, you can also use the option Pattern exclude, but on Linux it is only possible to exclude using regular expressions (regex exclude).
Add the exclusion patterns one after the other, followed by a comma. On Linux, each exclude must be specified with a leading\.
(for example, \./tmp/$,\./dev/null$). The procedure for using regex exclude is SEP sesam version dependent. For more details, see Exclude with Regular Expressions.
Click OK.
For more examples of exclusions using regular expression patterns, see Examples for Excluding Matched Patterns.
Note | |
Exclude using regular expressions is the default setting, but you can change it to use the file pattern (?,*) instead of regex by modifying the configuration file <SESAM_VAR>/var/ini/sm.ini on the SEP sesam Client. In the config file sm.ini change the entry EXCLUDE_MATCH= REGEXP to EXCLUDE_MATCH= PATTERN. |
Create a custom exclude list on the client
You can specify a custom exclude list of items to be skipped during backup by creating a special file on SEP sesam Client. Typically, you would create a separate exclude file if the number of files or directories to be excluded for backup exceeds the allowed length for the exclude list (max. 1024 characters). Such a custom exclude list takes precedence over an exclude list specified in the GUI (the latter is ignored if both are specified).
A custom exclude list must be a text file that is created on the SEP sesam Client where the backup will be executed. The syntax for exclude entries is platform/OS dependent, see:
Once you have created the exclude file, for example exclude_list.txt, enter it in the backup task properties as follows:
Create or open the backup task, select the Options tab and under Additional call arguments in the Backup options field, enter the specified file in the form:
-X C:/sesam/exclude_list.txt
Exclude list on Linux
Create the exclude file on the client in the directory /etc/sesam
, for example /etc/sesam/exclude_list.txt
. The following rules apply:
- Each file or directory you want to exclude from the backup must be specified on a separate line (one entry per line).
- Each exclude must be specified with a leading
\.
.
- Wildcards are not supported.
- The exclusion entries have to be set up using regular expression syntax.
This is an example of the exclude_list.txt on Linux:
\./tmp$ \./home/John Doe/videos.zip$ \./home/John Doe/Business Documents/YearEnd Closing for business year 2021$
Exclude list on Windows
Create the exclude file on the client in the directory C:\Program Files\SEPsesam\var\ini
, for example exclude_list.txt
. The following rules apply:
- Use only
/
(slash) in the exclude file and NOT\
(backslash). - Use the syntax "/$" for excluding directories, for example, F:/tmp/$.
- Each file or directory you want to exclude from the backup must be specified on a separate line (one entry per line). This also applies to paths that contain spaces.
This is an example of the exclude_list.txt file on Windows:
D:/DOWNLOAD/ D:/PREKITS/ D:/Dev/ D:/kit_2_3_1_7/ D:/kit_2_3_1_5/ D:/knoppix/ D:/ACHIM/ D:/gui/
Exclude list for Micro Focus OES (formerly Novell OES)
Create the exclude file on the client in the directory /etc/sesam
, for example /etc/sesam/exclude_list.txt
. The following rules apply:
- Each file or directory you want to exclude from the backup must be specified on a separate line (one entry per line).
- Use only the pattern format for exclude.
- Wildcards are allowed in the file or directory entries.
- A folder to be excluded must end with a
/
(slash).
This is an example of the exclude_list.txt file:
/media/nss/VOL1/tmp/ /media/nss/VOL1/USR/*/Notes/Workspace/ /media/nss/VOL1/data/do_not_backup.txt
For example, /media/nss/VOL1 is set as the source in the backup task. This means that the entire contents VOL1 will be backed up, except for the items in the exclusion file specified by the following entry in the backup task properties -> Options tab -> Backup options (previously Save options) field:
-X /etc/sesam/exclude_list.txt
SEP sesam will exclude from backup all files and directories that are listed in the file.
Creating a special file nosbc to permanently exclude a directory
You can permanently exclude a directory from all backups on the client by creating a special file in the directory itself – this file is called .nosbc on Unix or nosbc on Windows. By creating such a file in the directory, the directory will not be backed up, even if it is included in the specified source.
This behavior can be switched off for a specific backup task by entering the -o noexcl switch in the backup task properties, tab Options -> Backup options.
Using sm.ini to completely exclude files from backups on the client
You can use the central SEP sesam config file sm.ini to specify the files on the client that should never be backed up. The advantage of this method is that you can exclude files or directories from all backups performed on the respective client.
The default location of the sm.ini file is <SESAM_ROOT>\var\ini\sm.ini.
To define the exclusions for the client, open the sm.ini file and under the parameter SBC_EXCLUDE enter one parameter per line.
- On Linux, use regular expressions to define the exclusions in sm.ini.
The following example shows the pattern for excluding the directories /dev, /mnt and /media from backup.
[SBC_EXCLUDE] ExcludePattern1=\./mnt$ ExcludePattern2=\./dev$ ExcludePattern3=\./media$
Note | |
The ExcludePattern900 and higher exclude parameters are used for SEP sesam specific exclude patterns. To define your own exclude patterns, use the parameters ExcludePattern1 to ExcludePattern899. |
- On Windows, use file patterns to define the exclusions in sm.ini. This allows you to exclude files that match the specified names or paths (note that <file_name> can also contain wildcard characters, e.g., * and ?).