dbwrap_tool(1)

1DBWRAP_TOOL(1)            System Administration tools           DBWRAP_TOOL(1)
2
3
4

NAME

6       dbwrap_tool - low level TDB/CTDB manipulation tool using the dbwrap
7       interface
8

SYNOPSIS

10       dbwrap_tool [--persistent] [--non-persistent] [-d <debug level>]
11        [-s <config file>] [-l <log file base>] [-V] [--option=<name>=<value>]
12        {<database>} {<operation>} [<key> [<type> [<value>]]]
13

DESCRIPTION

15       This tool is part of the samba(7) suite.
16
17       The dbwrap_tool program is used to read and manipulate TDB/CTDB
18       databases using the dbwrap interface.
19
20       The following database operations are available:
21
22              ·   fetch: fetch a record
23
24              ·   store: create or modify a record
25
26              ·   delete: remove a record
27
28              ·   exists: test for existence of a record
29
30              ·   erase: remove all records
31
32              ·   listkeys: list all available records
33
34              ·   listwatchers: list processes, which are waiting for changes
35                  in a record
36
37
38       The following types are available:
39
40              ·   int32: signed 32bit integer
41
42              ·   uint32: unsigned 32bit integer
43
44              ·   string: "hello world"
45
46              ·   hex: hex strings like "68656C6C6F20776F726C6400" ("hello
47                  world")
48
49

OPTIONS

51       --persistent
52           Open the database as a persistent database.
53
54           Exactly one of --persistent and --non-persistent must be specified.
55
56       --non-persistent
57           Open the database as a non-persistent database.
58
59           Caveat: opening a database as non-persistent when there is
60           currently no other opener will wipe the database.
61
62           Exactly one of --persistent and --non-persistent must be specified.
63
64       -d|--debuglevel=level
65           level is an integer from 0 to 10. The default value if this
66           parameter is not specified is 1.
67
68           The higher this value, the more detail will be logged to the log
69           files about the activities of the server. At level 0, only critical
70           errors and serious warnings will be logged. Level 1 is a reasonable
71           level for day-to-day running - it generates a small amount of
72           information about operations carried out.
73
74           Levels above 1 will generate considerable amounts of log data, and
75           should only be used when investigating a problem. Levels above 3
76           are designed for use only by developers and generate HUGE amounts
77           of log data, most of which is extremely cryptic.
78
79           Note that specifying this parameter here will override the log
80           level parameter in the smb.conf file.
81
82       -V|--version
83           Prints the program version number.
84
85       -s|--configfile=<configuration file>
86           The file specified contains the configuration details required by
87           the server. The information in this file includes server-specific
88           information such as what printcap file to use, as well as
89           descriptions of all the services that the server is to provide. See
90           smb.conf for more information. The default configuration file name
91           is determined at compile time.
92
93       -l|--log-basename=logdirectory
94           Base directory name for log/debug files. The extension ".progname"
95           will be appended (e.g. log.smbclient, log.smbd, etc...). The log
96           file is never removed by the client.
97
98       --option=<name>=<value>
99           Set the smb.conf(5) option "<name>" to value "<value>" from the
100           command line. This overrides compiled-in defaults and options read
101           from the configuration file.
102
103       -?|--help
104           Print a summary of command line options.
105
106       --usage
107           Display brief usage message.
108

COMMANDS

110   fetch
111       dbwrap_tool <database> fetch <key> <type>
112
113   store
114       dbwrap_tool <database> store <key> <type> <value>
115
116   delete
117       dbwrap_tool <database> delete <key>
118
119   exists
120       dbwrap_tool <database> exists <key>
121
122   erase
123       dbwrap_tool <database> erase
124
125   listkeys
126       dbwrap_tool <database> listkeys
127
128   listwatchers
129       dbwrap_tool <database> listwatchers
130

EXAMPLES

132       List all keys from winbindd_idmap.tdb
133           dbwrap_tool --persistent winbindd_idmap.tdb listkeys
134
135       Fetch record with key "USER HWM" as uint32
136           dbwrap_tool --persistent winbindd_idmap.tdb fetch "USER HWM" uint32
137
138       Remove record with key "USER HWM"
139           dbwrap_tool --persistent winbindd_idmap.tdb remove "USER HWM"
140
141       Store and overwrite record "USER HWM" with value 214
142           uint32: dbwrap_tool --persistent winbindd_idmap.tdb store "USER
143           HWM" uint32 214 hex: dbwrap_tool --persistent winbindd_idmap.tdb
144           store "USER HWM" hex D6000000
145

NOTES

147       Use with caution!
148

VERSION

150       This man page is part of version 4.9.1 of the Samba suite.
151

AUTHOR

156       The original Samba software and related utilities were created by
157       Andrew Tridgell. Samba is now developed by the Samba Team as an Open
158       Source project similar to the way the Linux kernel is developed.
159
160       The dbwrap_tool manpage was written by Bjoern Baumbach.
161
162
163
164Samba 4.9.1                       05/11/2019                    DBWRAP_TOOL(1)