1lsm_fs_ss_restore(3)      Libstoragemgmt C API Manual     lsm_fs_ss_restore(3)
2
3
4

NAME

6       lsm_fs_ss_restore - Restores a file system snapshot.
7

SYNOPSIS

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

ARGUMENTS

14       conn        Valid connection.
15
16       fs          Pointer of lsm_fs which contains the snapshot
17
18       ss          Pointer of lsm_fs_ss to restore to.
19
20       files       Pointer of lsm_string_list. If defined, only restore speci‐
21                   fied files.  If NULL and 'all_files' set to 1, restore  all
22                   files.
23
24       restore_files
25                   Pointer  of  lsm_string_list.  If  defined, rename restored
26                   files to defined file paths and names.
27
28       all_files   int. 0 for only restore defined files, 1  for  restore  for
29                   all files.
30
31       job         Output  pointer  of string. If storage system support asyn‐
32                   chronous action on this, a job will be created and could be
33                   tracked via lsm_job_status_get. NULL if storage system does
34                   not support asynchronous action on this.
35
36       flags       Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.
37

VERSION

39       1.0
40

DESCRIPTION

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

CAPABILITY

46       LSM_CAP_FS_SNAPSHOT_RESTORE LSM_CAP_FS_SNAPSHOT_RESTORE_SPECIFIC_FILES
47

RETURN

49       Error code as enumerated by 'lsm_error_number'.
50           * LSM_ERR_OK
51               On success.
52           * LSM_ERR_JOB_STARTED
53               A job is started. Please check the 'job' output pointer.
54           * LSM_ERR_INVALID_ARGUMENT
55               When any argument is NULL or not a valid lsm_connect pointer
56               or invalid flags.
57           * LSM_ERR_NOT_FOUND_FS
58               When file system not found.
59           * LSM_ERR_NOT_FOUND_FS_SS
60               When file system snapshot not found.
61           * LSM_ERR_NO_SUPPORT
62               Not supported.
63
64
65
66April 2023                     lsm_fs_ss_restore          lsm_fs_ss_restore(3)
Impressum