Restorer Ultimate Documentation

Contents
Index

Syntax of a Description File for RAID Configurations

Syntax of a Description File for RAID Configurations

(Available on Restorer Ultimate PRO and Restorer Ultimate PRO Network only)

You may create and store your own RAID configurations The syntax of those files is similar to that of the XML language. They are stored in an .xml file specified on the Restorer Ultimate Settings .

A number of file examples are shown on the Description Files for RAID Configurations topic.

There are two types of such description files: for RAID presets and custom-created RAID layouts.

RAID preset configuration file

<?xml version="1.0" encoding="UTF-8"?>

</Parents>

</RAID>

</RAIDList>

Custom-created RAID configuration file example

<?xml version="1.0" encoding="UTF-8"?>

</Parents>

<Table>

<Block id="A1">ReedSolomon</Block>

<Block id="E1">XorOfData</Block>

<Block id="D2">XorOfData</Block>

<Block id="E2">ReedSolomon</Block>

<Block id="C3">XorOfData</Block>

<Block id="D3">ReedSolomon</Block>

<Block id="B4">XorOfData</Block>

<Block id="C4">ReedSolomon</Block>

<Block id="A5">XorOfData</Block>

<Block id="B5">ReedSolomon</Block>

<Block id="A6" sequence="1">XorOfAll</Block>

<Block id="B6" sequence="2">XorOfAll</Block>

<Block id="C6" sequence="3">XorOfAll</Block>

<Block id="D6" sequence="4">XorOfAll</Block>

<Block id="E6" sequence="5">XorOfAll</Block>

</Table>

</Sequences>

</RAID>

</RAIDList>

File structure

File header

The file starts with a standard XML header:

<?xml version="1.0" encoding="utf-8"?>

Section RAIDList

< RAIDList >

It can contain any number of the <RAID> sections and requires a closing element </FileTypeList>.

Section structure example:

...

</RAID>

...

...

</RAID>

Section RAID

This section describes each RAID layout.

It must contain at least one <Table> and <Parents> sections and can contain one block <Sequences> ..

</Parents>

<Table>

</Table>

</Sequences>

</RAID>

</RAIDList>

Attributes :

blocksize	<u32>	Required	The block size of the RAID in bytes
name	<string>	Optional	The name of the RAID layout
rows	<u16>	Required	The number of rows in the RAID layout table.
type	<u16>	Required	The type of the RAID preset. The following types are supported: 1: RAID0 (Stripe set) 2: RAID10 3: RAID1E 4: RAID4 5: RAID5 6: RAID5E 7: RAID5EE 8: RAID6 / Reed-Solomon Encoding 9: RAID6E / Reed-Solomon Encoding 10: RAID6 / Vertical Xor Encoding 256: Custom Raid Table If the RAID type parameter contradicts to the RAID table, the RAID table always prevails.
order	<u16>	Required/Optional	The RAID sub-type. For example, order="2" means Left Asynchronous for RAID5 layouts. Any value for the custom RAID layouts will be ignored.
parityDelay	<u16>	Required	The Parity delay parameter.

Section structure example:

</Parents>

<Table>

</Table>

</Sequences>

</RAID>

Section Parents

This section describes the RAID parents. It contains the <Parent> elements of the RAID.

Section structure example:

</Parents>

Element Parent

The element specifies the parent of the RAID.

Attributes :

comp	<string>	Required/Optional	The file-container with the parent object.
name	<string>	Required	The object name of the RAID parent.
offset	<u16>	Required is not 0	The offset value in bytes
size=	<u16>	Required	The object size in bytes
order	<u16>	Required	The order of the RAID object

Section Table

This section describes the RAID layout table. It contains the <Block> elements which number is a product of two attributes in the <RAID> section: <parents> x <rows> .

Section structure example:

<Table>

</Table>

</RAID>

</RAIDList>

Element Block

The element specifies the block number in the RAID layout table (a positive integer number) or an error correction block of the following types:

• PD or ParityOfData

• PA or ParityOfAll

• RS or ReedSolomon

• U or Unknown

• I or Ignore

Any other value is treated as Unknown .

Attributes :

id	<string>	Required	The alpha-numerical identifier of the block in the RAID layout table. The element in the 3-rd column of the 2-nd line is designated as C2 . AA is used after letter Z , and so on.
sequence	<string>	Optional	The numerical identifier for non-default sequences.

Section Sequences

This section describes the non-default data checksum sequences used to preserve data integrity. It is not necessary to explicitly list default sequences (the table rows). Sequences can contain any number of the <Sequence> elements.

Section structure example:

</Parents>

<Table>

...

</Table>

...

</Sequences>

</RAID>

</RAIDList>

Element Sequence

The element contains the list of the RAID blocks belonging to that sequence. The elements are separated by a space .

Attributes :

<u16>

Required

The sequence identifier.

Element example:

See the RAID configuration file example .

Comments

An XML standard string for a comment.

Home > File Recovery > Data Recovery from Volume Sets and RAIDs > Syntax of a Description File for RAID Configurations