Changeset 2305 for box/trunk/documentation/bbstoreaccounts.xml
- Timestamp:
- 01/10/2008 00:28:57 (4 years ago)
- File:
-
- 1 edited
-
box/trunk/documentation/bbstoreaccounts.xml (modified) (7 diffs)
Legend:
- Unmodified
- Added
- Removed
-
box/trunk/documentation/bbstoreaccounts.xml
r2127 r2305 1 1 <?xml version="1.0" encoding="UTF-8"?> 2 <refentry> 2 <refentry version="5.0" xmlns="http://docbook.org/ns/docbook" 3 xmlns:xlink="http://www.w3.org/1999/xlink" 4 xmlns:xi="http://www.w3.org/2001/XInclude" 5 xmlns:svg="http://www.w3.org/2000/svg" 6 xmlns:m="http://www.w3.org/1998/Math/MathML" 7 xmlns:html="http://www.w3.org/1999/xhtml" 8 xmlns:db="http://docbook.org/ns/docbook"> 3 9 <refmeta> 4 10 <refentrytitle>bbstoreaccounts</refentrytitle> 5 11 6 12 <manvolnum>8</manvolnum> 13 14 <refmiscinfo>Box Backup 0.11</refmiscinfo> 7 15 </refmeta> 8 16 … … 10 18 <refname>bbstoreaccounts</refname> 11 19 12 <refpurpose>View and change account information on the store 13 server</refpurpose> 20 <refpurpose>Box Backup store accounts manager</refpurpose> 14 21 </refnamediv> 15 22 16 23 <refsynopsisdiv> 17 24 <cmdsynopsis> 18 <command>bbstoreaccounts [-c configfile] command account_id 19 [command-specific arguments]</command> 25 <command>bbstoreaccounts</command> 26 27 <arg>-c config-file</arg> 28 29 <arg choice="plain">command</arg> 30 31 <arg choice="plain">account-id</arg> 32 33 <arg>command-specific arguments</arg> 20 34 </cmdsynopsis> 21 35 </refsynopsisdiv> … … 24 38 <title>Description</title> 25 39 26 <para>< literal>bbstoreaccounts</literal> is the tool for managing accounts40 <para><command>bbstoreaccounts</command> is the tool for managing accounts 27 41 on the store server. It can be used to view information related to 28 42 accounts, as well as create, change and delete accounts on the store 29 server. 30 31 <para>< literal>bbstoreaccounts</literal> always takes at least 243 server.</para> 44 45 <para><command>bbstoreaccounts</command> always takes at least 2 32 46 parameters: the command name and the account ID. Some commands require 33 47 additional parameters, and some commands have optional parameters.</para> … … 36 50 <title>Options</title> 37 51 38 <para><literal>-c <configfile></literal></para> 39 40 <para>The configfile to use for connecting to the store. Default is 41 <literal>/etc/box/bbstored.conf</literal>.</para> 52 <para><variablelist> 53 <varlistentry> 54 <term><option>-c config-file</option></term> 55 56 <listitem> 57 <para>The configfile to use for connecting to the store. Default 58 is <filename>/etc/box/bbstored.conf</filename>.</para> 59 </listitem> 60 </varlistentry> 61 </variablelist></para> 42 62 </refsection> 43 63 … … 47 67 <para>The commands tells bbstoreaccounts what action to perform.</para> 48 68 49 <itemizedlist> 50 <listitem> 51 <para><literal>check <account-id> [fix]</literal></para> 52 53 <para>The <literal>check</literal> command verifies the integrity of 54 the store account given, and optionally fixes any corruptions. 55 <emphasis role="bold">Note</emphasis>: It is recommended to run the 56 'simple' check command (without <literal>fix</literal>) before using 57 the <literal>fix</literal> option, This gives an overview of the 58 extent of any problems, before attempting to fix them.</para> 59 </listitem> 60 61 <listitem> 62 <para><literal>create <account-id> <discset> 63 <softlimit> <hardlimit></literal></para> 64 65 <para>Creates a new store account with the parameters given. The 66 parameters are as follows:</para> 67 68 <itemizedlist> 69 <listitem> 70 <para><literal>account-id</literal>: the ID of the new account 71 to be created. A 32-bit hexadecimal number. Cannot already exist 72 on the server.</para> 73 </listitem> 74 75 <listitem> 76 <para><literal>discset</literal>: the disc set from 77 raidfile.conf(5) where the backups for this client will be 78 stored.. A number. Each RAID-file set has a number in 79 raidfile.conf. This number is what's used.</para> 80 </listitem> 81 82 <listitem> 83 <para><literal>softlimit</literal>: The soft limit is the amount 84 of storage that the server will guarantee to be available for 85 storage.</para> 86 </listitem> 87 88 <listitem> 89 <para><literal>hardlimit</literal>: The amount of storage that 90 the the server will allow, before rejecting uploads, and 91 starting to eliminate old and deleted files to get back down to 92 <literal>softlimit</literal>. </para> 93 </listitem> 94 </itemizedlist> 95 </listitem> 96 97 <listitem> 98 <para><literal>delete <account-id> [yes]</literal></para> 99 100 <para>Deletes the account from the store server completely. Removes 101 all backups and deletes all references to the account in the config 102 files.</para> 103 104 <para><literal>delete</literal> will ask for confirmation from the 105 user, when called. Using the <literal>yes</literal> flag, eliminates 106 that need. This is useful when deleting accounts from within a 107 script or some other automated means.</para> 108 </listitem> 109 110 <listitem> 111 <para><literal>info <account-id></literal></para> 112 113 <para>Display information about the given account. Example:</para> 114 115 <programlisting>[root]# bbstoreaccounts info 1 69 <para><variablelist> 70 <varlistentry> 71 <term><command>check</command> <varname>account-id</varname> 72 <optional>fix</optional></term> 73 74 <listitem> 75 <para>The <command>check</command> command verifies the 76 integrity of the store account given, and optionally fixes any 77 corruptions. <emphasis role="bold">Note</emphasis>: It is 78 recommended to run the 'simple' check command (without 79 <command>fix</command>) before using the <command>fix</command> 80 option. This gives an overview of the extent of any problems, 81 before attempting to fix them.</para> 82 </listitem> 83 </varlistentry> 84 85 <varlistentry> 86 <term><command>create</command> <varname>account-id</varname> 87 <varname>disc-set</varname> <varname>soft-limit</varname> 88 <varname>hard-limit</varname></term> 89 90 <listitem> 91 <para>Creates a new store account with the parameters given. The 92 parameters are as follows:</para> 93 94 <para><variablelist> 95 <varlistentry> 96 <term><option>account-id</option></term> 97 98 <listitem> 99 <para>The ID of the new account to be created. A 32-bit 100 hexadecimal number. Cannot already exist on the 101 server.</para> 102 </listitem> 103 </varlistentry> 104 105 <varlistentry> 106 <term><option>disc-set</option></term> 107 108 <listitem> 109 <para>The disc set from <citerefentry> 110 <refentrytitle>raidfile.conf</refentrytitle> 111 112 <manvolnum>5</manvolnum> 113 </citerefentry> where the backups for this client will 114 be stored. A number. Each RAID-file set has a number in 115 raidfile.conf. This number is what's used.</para> 116 </listitem> 117 </varlistentry> 118 119 <varlistentry> 120 <term><option>soft-limit</option></term> 121 122 <listitem> 123 <para>The soft limit is the amount of storage that the 124 server will guarantee to be available for 125 storage.</para> 126 </listitem> 127 </varlistentry> 128 129 <varlistentry> 130 <term><option>hard-limit</option></term> 131 132 <listitem> 133 <para>The amount of storage that the the server will 134 allow, before rejecting uploads, and starting to 135 eliminate old and deleted files to get back down to 136 soft-limit.</para> 137 </listitem> 138 </varlistentry> 139 </variablelist></para> 140 </listitem> 141 </varlistentry> 142 143 <varlistentry> 144 <term><command>delete</command> <varname>account-id</varname> 145 <optional>yes</optional></term> 146 147 <listitem> 148 <para>Deletes the account from the store server completely. 149 Removes all backups and deletes all references to the account in 150 the config files.</para> 151 152 <para><command>delete</command> will ask for confirmation from 153 the user, when called. Using the <option>yes</option> flag, 154 eliminates that need. This is useful when deleting accounts from 155 within a script or some other automated means. 0</para> 156 </listitem> 157 </varlistentry> 158 159 <varlistentry> 160 <term><command>info</command> <varname>account-id</varname></term> 161 162 <listitem> 163 <para>Display information about the given account. 164 Example:<programlisting>[root]# bbstoreaccounts info 1 116 165 Account ID: 00000001 117 166 Last object ID: 58757 … … 122 171 Block soft limit: 11796480 (46080.00Mb) 123 172 Block hard limit: 13107200 (51200.00Mb) 124 Client store marker: 1139559852000000 </programlisting> 125 126 <para>Explanation:</para> 127 128 <itemizedlist> 129 <listitem> 130 <para>Account ID: The account ID being displayed.</para> 131 </listitem> 132 133 <listitem> 134 <para>Last Object ID: A counter that keeps track of the objects 135 that have been backed up. This number refers to the last file 136 that was written to the store. The ID is displayed as a decimal 137 number, and the object ID can be converted to a path name to a 138 file as follows: convert the number to hex (e.g.: 58757 => 139 0xE585); The last backed up file will be (relative from the 140 client's store root): <literal>e5/o85.rfw</literal>. Longer 141 numbers infer more directories in the structure, so as an 142 example 3952697264 as the last object ID gives 0xEB995FB0, which 143 translates to a backup pathname of 144 <literal>eb/99/5f/ob0.rfw.</literal></para> 145 </listitem> 146 147 <listitem> 148 <para>Blocks used: The number of blocks used by the store. The 149 size in Mb depends on the number of blocks, as well as the block 150 size for the disc set given in 151 <literal>raidfile.conf(5)</literal>. In this case the block size 152 is 4096.</para> 153 </listitem> 154 155 <listitem> 156 <para>Blocks used by old files: The number of blocks occupied by 157 files that have newer versions in the store. This data is at 158 risk for being removed during housekeeping.</para> 159 </listitem> 160 161 <listitem> 162 <para>Blocks used by deleted files: The number of blocks used by 163 files that have been deleted on the client. This data is at 164 risk for being removed during housekeeping.</para> 165 </listitem> 166 167 <listitem> 168 <para>Blocks used by directories: The number of blocks used by 169 directories in the store.</para> 170 </listitem> 171 172 <listitem> 173 <para>Block soft limit: The soft limit in blocks. The soft limit 174 is the maximum guaranteed storage space available to the 175 account. When housekeeping starts, and the old and deleted files 176 are removed, they are removed in chronological order (oldest 177 first), until the data used is less than the soft limit.</para> 178 </listitem> 179 180 <listitem> 181 <para>Block hard limit: The hard limit in blocks. The hard limit 182 is the most amount of storage the server will allow in an 183 account. Any data above this amount will be rejected. 184 Housekeeping will reduce the storage use, so more data can be 185 uploaded.</para> 186 </listitem> 187 188 <listitem> 189 <para>Client store marker: TODO What exactly is this? </para> 190 </listitem> 191 </itemizedlist> 192 </listitem> 193 194 <listitem> 195 <para><literal>setlimit <account-id> <softlimit> 196 <hardlimit></literal></para> 197 198 <para>Changes the storage space allocation for the given account. No 199 server restart is needed.</para> 200 201 <para>Parameters:</para> 202 203 <itemizedlist> 204 <listitem> 205 <para><literal>account-id</literal>: the ID of the new account 206 to be created. A 32-bit hexadecimal number. Cannot already exist 207 on the server.</para> 208 </listitem> 209 210 <listitem> 211 <para><literal>softlimit</literal>: The soft limit is the amount 212 of storage that the server will guarantee to be available for 213 storage.</para> 214 </listitem> 215 216 <listitem> 217 <para><literal>hardlimit</literal>: The amount of storage that 218 the the server will allow, before rejecting uploads, and 219 starting to eliminate old and deleted files to get back down to 220 <literal>softlimit</literal>.</para> 221 </listitem> 222 </itemizedlist> 223 </listitem> 224 </itemizedlist> 173 Client store marker: 1139559852000000</programlisting></para> 174 175 <para>Explanation:</para> 176 177 <para><variablelist> 178 <varlistentry> 179 <term>Account ID</term> 180 181 <listitem> 182 <para>The account ID being displayed.</para> 183 </listitem> 184 </varlistentry> 185 186 <varlistentry> 187 <term>Last Object ID</term> 188 189 <listitem> 190 <para>A counter that keeps track of the objects that 191 have been backed up. This number refers to the last file 192 that was written to the store. The ID is displayed as a 193 decimal number, and the object ID can be converted to a 194 path name to a file as follows: convert the number to 195 hex (e.g.: 58757 => 0xE585); The last backed up file 196 will be (relative from the client's store root): 197 <filename>e5/o85.rfw</filename>. Longer numbers infer 198 more directories in the structure, so as an example 199 3952697264 as the last object ID gives 0xEB995FB0, which 200 translates to a backup pathname of 201 <filename>eb/99/5f/ob0.rfw</filename>.</para> 202 </listitem> 203 </varlistentry> 204 205 <varlistentry> 206 <term>Blocks used</term> 207 208 <listitem> 209 <para>The number of blocks used by the store. The size 210 in Mb depends on the number of blocks, as well as the 211 block size for the disc set given in <citerefentry> 212 <refentrytitle>raidfile.conf</refentrytitle> 213 214 <manvolnum>5</manvolnum> 215 </citerefentry>. In this case the block size is 216 4096.</para> 217 </listitem> 218 </varlistentry> 219 220 <varlistentry> 221 <term>Blocks used by old files</term> 222 223 <listitem> 224 <para>The number of blocks occupied by files that have 225 newer versions in the store. This data is at risk for 226 being removed during housekeeping.</para> 227 </listitem> 228 </varlistentry> 229 230 <varlistentry> 231 <term>Blocks used by deleted files</term> 232 233 <listitem> 234 <para>The number of blocks used by files that have been 235 deleted on the client. This data is at risk for being 236 removed during housekeeping.</para> 237 </listitem> 238 </varlistentry> 239 240 <varlistentry> 241 <term>Blocks used by directories</term> 242 243 <listitem> 244 <para>The number of blocks used by directories in the 245 store.</para> 246 </listitem> 247 </varlistentry> 248 249 <varlistentry> 250 <term>Block soft limit</term> 251 252 <listitem> 253 <para>The soft limit in blocks. The soft limit is the 254 maximum guaranteed storage space available to the 255 account. When housekeeping starts, and the old and 256 deleted files are removed, they are removed in 257 chronological order (oldest first), until the data used 258 is less than the soft limit.</para> 259 </listitem> 260 </varlistentry> 261 262 <varlistentry> 263 <term>Block hard limit</term> 264 265 <listitem> 266 <para>The hard limit in blocks. The hard limit is the 267 most amount of storage the server will allow in an 268 account. Any data above this amount will be rejected. 269 Housekeeping will reduce the storage use, so more data 270 can be uploaded.</para> 271 </listitem> 272 </varlistentry> 273 274 <varlistentry> 275 <term>Client store marker</term> 276 277 <listitem> 278 <para><citerefentry> 279 <refentrytitle>bbstored</refentrytitle> 280 281 <manvolnum>8</manvolnum> 282 </citerefentry> uses this number to determine if it 283 needs to rescan the entire store. If this number is 284 different from the last time it checked, a rescan will 285 take place.</para> 286 </listitem> 287 </varlistentry> 288 </variablelist></para> 289 </listitem> 290 </varlistentry> 291 292 <varlistentry> 293 <term><command>setlimit</command> <varname>account-id</varname> 294 <varname>soft-limit</varname> <varname>hard-limit</varname></term> 295 296 <listitem> 297 <para>Changes the storage space allocation for the given 298 account. No server restart is needed.</para> 299 300 <para>Parameters:</para> 301 302 <para><variablelist> 303 <varlistentry> 304 <term><option>account-id</option></term> 305 306 <listitem> 307 <para>The ID of the account to be modified.</para> 308 </listitem> 309 </varlistentry> 310 311 <varlistentry> 312 <term><option>soft-limit</option></term> 313 314 <listitem> 315 <para>The soft limit is the amount of storage that the 316 server will guarantee to be available for 317 storage.</para> 318 </listitem> 319 </varlistentry> 320 321 <varlistentry> 322 <term><option>hard-limit</option></term> 323 324 <listitem> 325 <para>The amount of storage that the the server will 326 allow before rejecting uploads and starting to eliminate 327 old and deleted files to get back down to 328 <option>soft-limit</option>.</para> 329 </listitem> 330 </varlistentry> 331 </variablelist></para> 332 </listitem> 333 </varlistentry> 334 </variablelist></para> 225 335 </refsection> 226 336 </refsection> 227 337 228 338 <refsection> 229 <title>Author</title> 230 231 <para>Ben Summers and contributors. For help, please go to the <ulink 232 url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box 233 Backup <ulink 234 url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 235 list.</ulink></para> 339 <title>Examples</title> 340 341 <para>Create an account with ID 3af on disc set 0, with a 20GB soft-limit 342 and a 22GB hard-limit:<programlisting>bbstoreaccounts create 3af 0 20G 22G</programlisting>Alter 343 existing account ID 20 to have a 50GB soft-limit and a 55GB 344 hard-limit:<programlisting>bbstoreaccounts setlimit 20 50G 55G</programlisting></para> 345 </refsection> 346 347 <refsection> 348 <title>Files</title> 349 350 <para><filename>/etc/box/bbstored/accounts.txt</filename></para> 236 351 </refsection> 237 352 … … 239 354 <title>See Also</title> 240 355 241 <para><literal>bbstored.conf(5)</literal></para> 242 243 <para><literal>raidfile.conf(5)</literal></para> 244 </refsection> 245 246 <refsection> 247 <title>Files</title> 248 249 <para><literal>bbstoreaccounts</literal> uses the Box Backup server 250 configuration file, usually located in 251 <filename>/etc/box/bbstored.conf</filename>. </para> 252 </refsection> 253 254 <refsection> 255 <title>Bugs</title> 256 257 <para>If you find a bug in Box Backup, and you want to let us know about 258 it, join the <ulink 259 url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 260 list</ulink>, and send a description of the problem there.</para> 261 262 <para>To report a bug, give us at least the following information:</para> 263 264 <itemizedlist> 265 <listitem> 266 <para>The version of Box Backup you are running</para> 267 </listitem> 268 269 <listitem> 270 <para>The platform you are running on (hardware and OS), for both 271 client and server.</para> 272 </listitem> 273 274 <listitem> 275 <para>If possible attach your config files (bbstored.conf, 276 bbackupd.conf) to the bug report.</para> 277 </listitem> 278 279 <listitem> 280 <para>Also attach any log file output that helps shed light on the 281 problem you are seeing.</para> 282 </listitem> 283 284 <listitem> 285 <para>And last but certainly not least, a description of what you are 286 seeing, in as much detail as possible.</para> 287 </listitem> 288 </itemizedlist> 356 <para><citerefentry> 357 <refentrytitle>bbstored</refentrytitle> 358 359 <manvolnum>8</manvolnum> 360 </citerefentry>, <citerefentry> 361 <refentrytitle>bbstored-config</refentrytitle> 362 363 <manvolnum>8</manvolnum> 364 </citerefentry></para> 365 </refsection> 366 367 <refsection> 368 <title>Authors</title> 369 370 <para><author> 371 <personname>Ben Summers</personname> 372 </author></para> 373 374 <para><author> 375 <personname>Per Thomsen</personname> 376 </author></para> 377 378 <para><author> 379 <personname>James O'Gorman</personname> 380 </author></para> 289 381 </refsection> 290 382 </refentry>
Note: See TracChangeset
for help on using the changeset viewer.
