man5-editing-pass-20051213
[openafs.git] / src / man / vos_backupsys.1
1 vos backupsys              AFS Commands           vos backupsys
2
3
4 NAME
5
6    vos   backupsys -- create  Backup  volume  version  of  all
7
8                        indicated ReadWrite volumes.
9
10
11    vos backupsys  [-prefix <common prefix on volume(s)>]
12    [-server <machine name>]  [-partition <partition name>]
13    [-cell <cell name>]  [-noauth]  [-localauth]  [-verbose]
14    [-help]
15
16 ACCEPTABLE ABBREVIATIONS/ALIASES
17
18    vos backups  [-pr <common prefix on volume(s)>]  [-s
19    <machine name>]
20    [-pa <partition name>]  [-c <cell name>]  [-n]  [-l]  [-v]
21    [-h]
22
23 DESCRIPTION
24
25    Clones each indicated ReadWrite  volume  to  make  a  Backup
26    version  of  it.    Names  each  Backup  version by adding a
27    .backup extension to the name of its ReadWrite source.    It
28    places  each  Backup  at  the  same  site as its source, and
29    changes the VLDB status flag for each Backup to valid.
30
31    If a Backup version already exists for  a  volume,  the  new
32    clone replaces it.  The status flag remains valid.
33
34    By  combining  the -prefix, -server and -partition arguments
35    in different ways, it is possible to create Backup copies of
36    varying  numbers  of  volumes.  The possibilities are listed
37    here from most to least inclusive
38
39    To create a Backup version of:
40
41       - every ReadWrite volume in  the  system,  omit  all
42         three  arguments.    This could take a rather long
43         time  to  execute,  depending  on  the  number  of
44         volumes.
45
46       - every  ReadWrite  volume  whose name begins with a
47         certain character string  (for  example,  sys.  or
48         user.), regardless of site, use -prefix.
49
50       - every  ReadWrite  volume on a file server machine,
51         specify the file server name with -server.
52
53       - every ReadWrite volume that resides on a partition
54         of  the same name (for instance, on /vicepa on any
55         file server machine), specify the  partition  name
56         with -partition.
57
58       - every ReadWrite volume on a certain partition of a
59         file server  machine,  specify  both  -server  and
60         -partition.
61
62
63
64       - every  ReadWrite volume with a certain prefix that
65         resides on a file server machine, combine  -prefix
66         and  -server.    The  -prefix argument may also be
67         combined with  -partition,  or  both  -server  and
68         -partition, in this way.
69
70       - a  single ReadWrite volume, give its complete name
71         as -prefix.  This is actually better done with the
72         vos backup   command,   which   employs   a   more
73         streamlined technique for finding a single volume.
74
75 ARGUMENTS
76
77    -prefix         specifies a character string of any  length.
78                    Every  volume  whose  name  begins with this
79                    exact string  will  be  cloned  (subject  to
80                    modulations  from  -server  and -partition).
81                    Include field separators (such  as  periods)
82                    if   appropriate.    This  argument  may  be
83                    combined with -server and/or -partition.
84
85    -server         names the  file  server  machine  where  the
86                    ReadWrite     source    volume(s)    reside.
87                    Abbreviated forms of machine  names  may  be
88                    allowed  depending  on  the  naming  service
89                    available at the time the command is issued;
90                    see  page xii in the introductory About This
91                    Manual  chapter.    This  argument  may   be
92                    combined with -prefix and/or -partition.
93
94    -partition      names  the  particular  partition  where the
95                    ReadWrite  source  volume(s)  reside.     In
96                    addition  to  the  full  /vicepx  form  of a
97                    partition  name,  three  shorter  forms  are
98                    acceptable; see page xii in the introductory
99                    About This Manual chapter.    This  argument
100                    may be combined with -prefix and/or -server.
101
102    -cell           specifies  the  cell  in  which  to  run the
103                    command.  See section 8.3 in  the  Reference
104                    Manual for more details.  -noauth
105                    tells the Volume and Volume Location Servers
106                    to  assign  the  identity  anonymous  to the
107                    issuer.  See section 8.3  in  the  Reference
108                    Manual for more details.  -localauth
109                    constructs a server ticket using a key  from
110                    /usr/afs/etc/KeyFile.    See  section 8.3 in
111                    the  Reference  Manual  for  more   details.
112                    -verbose
113                    tells the Volume and Volume Location Servers
114                    to  report  on  what  they are doing as they
115                    execute the command.  See section 8.3 in the
116                    Reference Manual for more details.  -help
117                    prints the online help for this command.  Do
118                    not  provide  any  other  arguments or flags
119                    with this one.    See  section  8.3  in  the
120                    Reference Manual for more details.
121
122
123
124 EXAMPLES
125
126    The  following  creates  a Backup version of every volume in
127    the cell's file system whose name begins with "user".
128
129    % vos backups user
130
131    The following, appropriate in the Transarc Corporation cell,
132    creates  a Backup version of every volume on the file server
133    machine fs3.transarc.com.
134
135    % vos backups -s fs3.transarc.com
136
137    The following, appropriate in the Transarc Corporation cell,
138    creates  a  Backup  version  of  every volume on the /vicepc
139    partition of the file server machine fs5.transarc.com.
140
141    % vos backups -s fs5.transarc.com -p c
142
143    The following, appropriate in the Transarc Corporation cell,
144    creates  a Backup version of every volume on the file server
145    machine db1.transarc.com whose name begins with "sys".
146
147    % vos backups sys db1.transarc.com
148
149 PRIVILEGE REQUIRED
150
151    Issuer must be listed in /usr/afs/etc/UserList on -server.
152
153 MORE INFORMATION
154
155    vos backup