NAME¶

lsm_fs_ss_restore - Restores a file system snapshot.

SYNOPSIS¶

int lsm_fs_ss_restore (lsm_connect *conn, lsm_fs *fs, lsm_fs_ss *ss, lsm_string_list *files, lsm_string_list *restore_files, int all_files, char **job, lsm_flag flags);

ARGUMENTS¶

conn

Valid connection.

fs

Pointer of lsm_fs which contains the snapshot

ss

Pointer of lsm_fs_ss to restore to.

files

Pointer of lsm_string_list. If defined, only restore specified files. If NULL and 'all_files' set to 1, restore all files.

restore_files

Pointer of lsm_string_list. If defined, rename restored files to defined file paths and names.

all_files

int. 0 for only restore defined files, 1 for restore for all files.

job

Output pointer of string. If storage system support asynchronous action on this, a job will be created and could be tracked via lsm_job_status_get. NULL if storage system does not support asynchronous action on this.

flags

Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.

VERSION¶

1.0

DESCRIPTION¶

Restores a file system or files to a previous state as specified in the snapshot.

CAPABILITY¶

LSM_CAP_FS_SNAPSHOT_RESTORE LSM_CAP_FS_SNAPSHOT_RESTORE_SPECIFIC_FILES

RETURN¶

Error code as enumerated by 'lsm_error_number'.
* LSM_ERR_OK
On success.
* LSM_ERR_JOB_STARTED
A job is started. Please check the 'job' output pointer.
* LSM_ERR_INVALID_ARGUMENT
When any argument is NULL or not a valid lsm_connect pointer
or invalid flags.
* LSM_ERR_NOT_FOUND_FS
When file system not found.
* LSM_ERR_NOT_FOUND_FS_SS
When file system snapshot not found.
* LSM_ERR_NO_SUPPORT
Not supported.