commands/restore/restore.cif
author Tom Sutcliffe <thomas.sutcliffe@accenture.com>
Wed, 15 Sep 2010 00:44:34 +0100
changeset 70 b06038904ef8
parent 0 7f656887cf89
permissions -rw-r--r--
Added ==smoke-test support and ciftest command. Commands can now define a "==smoke-test" section in their CIF files, which defines a snippet of fshell script that will be run as part of "fshell smoketest" or by invoking ciftest directly. See the ciftest documentation for more details. Added ==smoke-test sections to a few commands, the ones that were easy to test!

# restore.cif
# 
# Copyright (c) 2010 Accenture. All rights reserved.
# This component and the accompanying materials are made available
# under the terms of the "Eclipse Public License v1.0"
# which accompanies this distribution, and is available
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
# 
# Initial Contributors:
# Accenture - Initial contribution
#

==name restore

==short-description

Put the handset into restore mode.

==long-description

A means of requesting backup aware modules to close their file handles. Note, this command does not actually B<perform> a restore, it merely prepares the system for one.

==see-also

L<backup|backup>

==argument enum operation

The required operation.

==enum-value start

Request that all backup aware modules release their file handles and prepare for a restore.

==enum-value stop

Request that all backup aware modules reclaim their files.

==copyright

Copyright (c) 2008-2010 Accenture. All rights reserved.