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