Archiving master node setting with mastersettings

Ops Center Protector User Guide

Version

7.7.x

Audience

anonymous

Part Number

MK-99PRT002-08

ft:lastEdition

2023-10-26

The master node configuration files can be zipped to an archive file using the mastersettings command. During the procedure, only the master node settings are zipped up; other information such as repositories and their metadata stores and log messages are excluded.

We recommend that you back up the master node configuration files once a week. You can set up a backup policy on a recurring schedule that runs the mastersettings CLI tool as a pre-script, then backs up the resulting zip file.

Note: A host based front end capacity license is required to perform backup of the master node using mastersettings.

Table. Command line options
Abbreviated Argument	Full Argument	Description
`-h`	`--help`	Displays command line parameter usage instructions.
`-e`	`--export zipfile`	Zips up all configuration files to zipfile. If no path is specified, the file will be created in the $Protector_HOME\runtime directory. If no .zip suffix is specified, then it will be appended. The file is created in zip format and can be read with commonly available tools such as WinZip.
`-c`	`--config cfgfile`	Used with `--export` and `--import`. Specifies a configuration file used to control what files are included and excluded in the archive. By default, the cfgfile name mastersettings.cfg is assumed. (See About the mastersettings.cfg file.)
`-i`	`--import zipfile`	Restores all master node configuration files from `zipfile` The CofioHub service must be stopped prior to importing.
`-p`	`--preclear True\|False`	Used when importing a zip file. Indicates whether existing master node configuration files are to be deleted prior to restoring them from the archive.

Usage examples:

Archiving the master node configuration files:

mastersettings -e mastercfgfiles.zip

Configuring of mastersettings:

mastersettings.cfg is an XML file that contains information indicating which Ops Center Protector files are to be:

included or ignored when creating the archive (exporting)
deleted or ignored when restoring the archive (importing)

This file is located in the following directory:

$Protector_HOME$\db\config

The mastersettings.cfg file can contain information as described in the following table.

Table. Configuration file options:
Item Name	Description
`Path`	The path to be backed up. The path specified is relative to the `$Protector_HOME` directory.
`Depth`	The depth, defined as a value, within the path to be backed up: -1 (default) backs up all files in all subdirectories. 1 backs up only the files in the path. 2 backs up all files in the path and within subdirectories of the path (but not the subdirectories themselves).
`Export Mask`	Controls which files in the path are backed up. Can contain the following entries: (If no export mask is specified then all files will be matched and exported).
	`NameMask` A file name mask such as `*.cfg`.
	`MatchAction` Indicates how to process matching files: Either `CopyFile` or `IgnoreFile`
	NonMatchAction Indicates how to process non-matching files: Either `CopyFile` or `IgnoreFile`
`Import Mask`	Controls what is cleared from the path prior to a restore. Can contain the following entries: (If no import mask is specified then all files will be matched and deleted prior to the restore unless the option --preclear false is specified at the command line).
	`NameMask` A file name mask such as `*.cfg`.
	`MatchAction` Indicates how to process matching files: Either `DeleteFile` or `IgnoreFile`
	`NonMatchAction` Indicates how to process non-matching files: Either `DeleteFile` or `IgnoreFile`

Configuration file examples:

The following XML tells mastersettings.exe to export all files in and below the main Ops Center Protector configuration directory:

<item name="Entry" argtype="list" >
    <item name="Path" argtype="single" >
        <value type="string" >db/config</value>
    </item>
    <item name="Depth" argtype="single" >
        <value type="int32" >2</value>
    </item>
</item>

The following XML tells mastersettings.exe not to export any files from the media manager events directory, but to delete all events from that directory prior to a restore. This will ensure that all events that are logged prior to an import are deleted, because they will not be relevant after the master settings have been restored.

<item name="Entry" argtype="list" >
    <item name="Path" argtype="single" >
         <value type="string" >db/mediamanager/events</value>
    </item>
    <item name="Export Mask" argtype="list" >
        <item name="MatchAction" argtype="single" >
            <value type="string" >IgnoreFile</value>
        </item>
    </item>
    <item name="Import Mask" argtype="list" >
        <item name="MatchAction" argtype="single" >
            <value type="string" >DeleteFile</value>
        </item>
    </item>
</item>