Moab Viewpoint
Configuring the Archive Element

Configuring the Archive Element

Archives can be created by the user to back up reservations. Users can then restore environments when needed. Components in the Create Archive page are configurable in the vpcs.xml file. A user opens the Create Archive page in the Manage environment by selecting the reservation and clicking the Create Archive icon.

Archive dialog box

The following sample archive section of the vpcs.xml file demonstrates the configuration used to generate the Create Archive page:

<archive>
	<create enabled="true" cutoff-date="9">
		<create-archive-script host="moab"
			path="/opt/moab/tools/create.archive.pl" />
		<storage-options display="false">
			<option id="san" display-value="San" cost="2.82" />
		</storage-options>
		<duration-options>
			<option id="1" display-value="1 Month" />
			<option id="2" display-value="2 Months" />
			<option id="3" display-value="3 Months" />
		</duration-options>
		<archive-billable value="true" />
	</create>
	<restore enabled="true">
		<restore-script host="moab"
			path="/opt/moab/tools/restore.backup.pl" />
		<restore-billable>false</restore-billable>
	</restore>
</archive>

The following are descriptions of key <archive> elements:

  • <create-archive-script> - This is used to specify the location of the create archive script. The host attribute specifies the machine name where the create archive script resides. For example, host="moab" means the create.archive.pl script resides on the same machine on which Moab is running. The path attribute defines the full path to the script.
  • <storage-options> - This indicates whether to display a list of media on which to store the archive. As "San" is presently the only option, it is not necessary to display a list of options, so the display attribute is set to "false".
  • <option> - This specifies data to appear in the single select list box if the display attribute for the <storage-options> element is set to "true". Even if setting display to "false", it is important to include the <option> element with a value for the cost attribute, because the cost attribute is used to derive the cost of any created archive. Cost is the number of cost units per gigabyte of storage.
  • <duration-options> - This creates a single select list box that allows the user to specify how many months to keep the archive active.
  • <archive-billable> - If archives are billable, set this value to "true".
  • <restore-script> - This specifies where the restore archive script resides. For example, host="moab" means the restore.backup.pl script resides on the same machine on which Moab is running. The path attribute defines the full path to the script.
  • <create> and <restore> - These elements have a boolean attribute called enabled that enables or disables archive creation or restoration.