bbstoreaccounts
1
bbstoreaccounts
View and change account information on the store
server
bbstoreaccounts [-c configfile] command account_id
[command-specific arguments]
Description
bbstoreaccounts is the tool for managing accounts
on the store server. It can be used to view information related to
accounts, as well as create, change and delete accounts on the store
server.
bbstoreaccounts alwas takes at least 2
parameters: the command name and the account ID. Some commands require
additional parameters, and some commands have optional parameters.
Options
-c <configfile>
The configfile to use for connecting to the store. Default is
/etc/box/bbstored.conf.
Commands
The commands tells bbstoreaccounts what action to perform.
check <account-id> [fix]
The check command verifies the integrity of
the store account given, and optionally fixes any corruptions.
Note: It is recommended to run the
'simple' check command (without fix) before using
the fix option, This gives an overview of the
extent of any problems, before attempting to fix them.
create <account-id> <discset>
<softlimit> <hardlimit>
Creates a new store account with the parameters given. The
parameters are as follows:
account-id: the ID of the new account
to be created. A 32-bit hexadecimal number. Cannot already exist
on the server.
discset: the disc set from
raidfile.conf(5) where the backups for this client will be
stored.. A number. Each RAID-file set has a number in
raidfile.conf. This number is what's used.
softlimit: The soft limit is the amount
of storage that the server will guarantee to be available for
storage.
hardlimit: The amount of storage that
the the server will allow, before rejecting uploads, and
starting to eliminate old and deleted files to get back down to
softlimit.
delete <account-id> [yes]
Deletes the account from the store server completely. Removes
all backups and deletes all references to the account in the config
files.
delete will ask for confirmation from the
user, when called. Using the yes flag, eliminates
that need. This is useful when deleting accounts from within a
script or some other automated means.
info <account-id>
Display information about the given account. Example:
[root]# bbstoreaccounts info 1
Account ID: 00000001
Last object ID: 58757
Blocks used: 9864063 (38531.50Mb)
Blocks used by old files: 62058 (242.41Mb)
Blocks used by deleted files: 34025 (132.91Mb)
Blocks used by directories: 6679 (26.09Mb)
Block soft limit: 11796480 (46080.00Mb)
Block hard limit: 13107200 (51200.00Mb)
Client store marker: 1139559852000000
Explanation:
Account ID: The account ID being displayed.
Last Object ID: A counter that keeps track of the objects
that have been backed up. This number refers to the last file
that was written to the store. The ID is displayed as a decimal
number, and the object ID can be converted to a path name to a
file as follows: convert the number to hex (e.g.: 58757 =>
0xE585); The last backed up file will be (relative from the
client's store root): e5/o85.rfw. Longer
numbers infer more directories in the structure, so as an
example 3952697264 as the last object ID gives 0xEB995FB0, which
translates to a backup pathname of
eb/99/5f/ob0.rfw.
Blocks used: The number of blocks used by the store. The
size in Mb depends on the number of blocks, as well as the block
size for the disc set given in
raidfile.conf(5). In this case the block size
is 4096.
Blocks used by old files: The number of blocks occupied by
files that have newer versions in the store. This data is at
risk for being removed during housekeeping.
Blocks used by deleted files: The number of blocks used by
files that have been deleted on the client. Thi s data is at
risk for being removed during housekeeping.
Blocks used by directories: The number of blocks used by
directories in the store.
Block soft limit: The soft limit in blocks. The soft limit
is the maximum guaranteed storage space available to the
account. When housekeeping starts, and the old and deleted files
are removed, they are removed in chronological order (oldest
first), until the data used is less than the soft limit.
Block hard limit: The hard limit in blocks. The hard limit
is the most amount of storage the server will allow in an
account. Any data above this amount will be rejected.
Housekeeping will reduce the storage use, so more data can be
uploaded.
Client store marker: TODO What exactly is this?
setlimit <account-id> <softlimit>
<hardlimit>
Changes the storage space allocation for the given account. No
server restart is needed.
Parameters:
account-id: the ID of the new account
to be created. A 32-bit hexadecimal number. Cannot already exist
on the server.
softlimit: The soft limit is the amount
of storage that the server will guarantee to be available for
storage.
hardlimit: The amount of storage that
the the server will allow, before rejecting uploads, and
starting to eliminate old and deleted files to get back down to
softlimit.
Author
Ben Summers and contributors. For help, please go to the Wiki, or subscribe to the Box
Backup mailing
list.
See Also
bbstored.conf(5)
raidfile.conf(5)
Files
bbstoreaccounts uses the Box Backup server
configuration file, usually located in
/etc/box/bbstored.conf.
Bugs
If you find a bug in Box Backup, and you want to let us know about
it, join the mailing
list, and send a description of the problem there.
To report a bug, give us at least the following information:
The version of Box Backup you are running
The platform you are running on (Hardware and OS), for both
client and server.
If possible attach your config files (bbstored.conf,
bbackupd.conf) to the bug report.
Also attach any log file output that helps shed light on the
problem you are seeing.
And last but certainly not least, a description of what you are
seeing, in as much detail as possible.