Configuration Format

In this article

    To export and import product configuration, Veeam Agent for Oracle Solaris uses configuration files in the XML format. A configuration file contains three main blocks:

    For a sample configuration file, see Example.

    Backup Repository Settings

    The Repositories block contains backup repository settings. The block contains information about backup repositories that use a local storage, remote storage or network shared folder as a target location for backups. The block has the following structure:

    <Repositories>
       <Repository Name="<LocalRepoName>" Type="LocalDrive">
           <LocalRepoOptions Version="1" Location="/mnt/repo1" DeviceMountPoint="" />
       </Repository>
       <Repository Name="<LocalRepoName2>" Type="LocalDrive">
           <LocalRepoOptions Version="1" Location="/mnt/repo2" DeviceMountPoint="" />
       </Repository>
       ...
    </Repositories>

    Adjustable variables:

    Backup Job Settings

    The Jobs block contains backup job settings. The block contains sub-blocks for each job configured in Veeam Agent for Oracle Solaris. The block has the following structure:

    Jobs
     Job1
       Job options
         Schedule settings
         Active full backup settings
         Old backups retention
       Objects for backup
     Job2
       ...

    For example:

    <Job Name="Machine Backup" creation_time="2021-04-28 20:00:00" RepoName="[VBRNAME] VbrRepoName" password="yourpassword" hint="passhint">

       <JobOptions>
       </JobOptions>

           <Schedule>
           </Schedule>

           <ActiveFullOptions>
           </ActiveFullOptions>

           <EnableDeletedVmDataRetention />

       <ObjectsForBackup>
       </ObjectsForBackup>

    </Job>

    Adjustable variables:

    The password and hint elements are optional and can be omitted.

    Job Options

    The JobsOptions block contains backup job settings. The block has the following structure:

    <JobOptions
       Version="2"
       Compression="ZlibHigh"
       BlockSize="KbBlockSize1024"
       PrejobCommand=""
       PostjobCommand=""
       MaxPoints="7"
       RetryCount="1"
       RetryTimeOutMs="600000"
       Schedule="true">
       ...
    </JobOptions>

    Adjustable variables:

    Schedule Settings

    The Schedule block contains backup schedule settings. The block has the following structure:

    <Schedule Hours="6" Minutes="0" Type="0" Version="3" IsEnabled="true" WeekDayNumber="Every" DayOfMonth="0">

        <Time Type="0"
        Hours="6"
        Minutes="0" />
                 
       <WeekMask
       Monday="true"
       Tuesday="true"
       Wednesday="true"
       Thursday="true"
       Friday="true"
       Saturday="true"
       Sunday="true"
       />
                 
       <MonthMask
       January="true"
       February="true"
       March="true"
       April="true"
       May="true"
       June="true"
       July="true"
       August="true"
       September="true"
       October="true"
       November="true"
       December="true"
       />

    </Schedule>

    Adjustable variables:

    Active Full Backup Settings

    The ActiveFullOptions block contains active full backup schedule settings. The block has the following structure:

    <ActiveFullOptions Version="1" IsEnabled="true" WeekDayNumber="Every" DayOfMonth="0">
                 
       <WeekMask
       Monday="false"
       Tuesday="false"
       Wednesday="false"
       Thursday="false"
       Friday="false"
       Saturday="false"
       Sunday="true"
       />
                 
       <MonthMask
       January="true"
       February="true"
       March="true"
       April="true"
       May="true"
       June="true"
       July="true"
       August="true"
       September="true"
       October="true"
       November="true"
       December="true"
       />
           
    </ActiveFullOptions>

    Adjustable variables:

    Alternatively, you can set the value of this element to 0 (zero). In this case, active full backup will be performed on true days from WeekMask block.

    Old Backups Retention Settings

    This block contains retention settings for old backups. These settings are applicable to backup jobs targeted at a Veeam backup repository. To learn more, see Creating Backup Jobs.

    The entire block can be removed if not required.

    The block has the following structure:

    <EnableDeletedVmDataRetention EnableDeletedVmDataRetention="true" />
    <RetainDays RetainDays="30" />

    Adjustable variable:

    RetainDays — number of days to keep the backup created with the backup job in the target location.

    Backup Object Settings

    The ObjectsForBackup block contains backup scope settings. The block contains Object sub-blocks for each object (directory or file mask) included in or excluded from backup.

    The Object block has the following structure:

    <Object ObjectType="Directory" RecordType="Include" Value="/var" />

    Adjustable variables:

    Veeam Backup Server Settings

    The VbrServers block contains Veeam backup server settings. The block has the following structure:

    <VbrServers>
       <VbrServer
       Name="VBRNAME"
       login="USERNAME"
       domain=" "
       fqdn=" "
       password="<your password here>"
       Endpoint="<DNS name/IP address>:<Port>"/>
    </VbrServers>

    Adjustable variables:

    Example

    This example displays configuration of Veeam Agent for Oracle Solaris with the following settings:

    <?xml version="1.0" encoding="UTF-8"?>
    <Config Version="4" PlatformId="{b671deaf-a237-4c3e-0004-000000000003}">

    <VbrServers>
       <VbrServer
       Name="VBRNAME"
       login="USERNAME"
       domain=" "
       fqdn=" "
       password="Pa$$w0rd"
       Endpoint="10.1.1.10:10006"/>
    </VbrServers>

    <Repositories>
       <Repository Name="LocalRepoName" Type="LocalDrive">
           <LocalRepoOptions Version="1" Location="/mnt/repo" DeviceMountPoint="" />
       </Repository>
    </Repositories>

    <Jobs>
       <Job Name="MyJob1" creation_time="2021-04-28 20:00:00" RepoName="[VBRNAME] VbrRepoName">

           <JobOptions
               Version="2"
               Compression="ZlibHigh"
               BlockSize="KbBlockSize1024"
               PrejobCommand=""
               PostjobCommand=""
               MaxPoints="7"
               RetryCount="1"
               RetryTimeOutMs="600000"
               Schedule="true">

               <EnableDeletedVmDataRetention EnableDeletedVmDataRetention="true" />
               <RetainDays RetainDays="30" />
               
               <Schedule Hours="6" Minutes="0" Type="0" Version="3" IsEnabled="true" WeekDayNumber="Every" DayOfMonth="0">

                   <Time Type="0"
                   Hours="6"
                   Minutes="0" />

                   <WeekMask
                   Monday="true"
                   Tuesday="true"
                   Wednesday="true"
                   Thursday="true"
                   Friday="true"
                   Saturday="true"
                   Sunday="true"
                   />
                 
                   <MonthMask
                   January="true"
                   February="true"
                   March="true"
                   April="true"
                   May="true"
                   June="true"
                   July="true"
                   August="true"
                   September="true"
                   October="true"
                   November="true"
                   December="true"
                   />

               </Schedule>
               
               <ActiveFullOptions Version="1" IsEnabled="true" WeekDayNumber="Every" DayOfMonth="0">  
               
                   <WeekMask
                   Monday="false"
                   Tuesday="false"
                   Wednesday="false"
                   Thursday="false"
                   Friday="false"
                   Saturday="false"
                   Sunday="true"
                   />
                 
                   <MonthMask
                   January="true"
                   February="true"
                   March="true"
                   April="true"
                   May="true"
                   June="true"
                   July="true"
                   August="true"
                   September="true"
                   October="true"
                   November="true"
                   December="true"
                   />
           
               </ActiveFullOptions>
                 
          </JobOptions>
           
          <ObjectsForBackup>
               
              <Object ObjectType="Directory" RecordType="Include" Value="/etc" />
              <Object ObjectType="Directory" RecordType="Include" Value="/var" />
              <Object ObjectType="Directory" RecordType="Exclude" Value="/etc/system.d" />
           
          </ObjectsForBackup>
      </Job>
    </Jobs>