1DBWRAP_TOOL(1) System Administration tools DBWRAP_TOOL(1)
2
6 dbwrap_tool - low level TDB/CTDB manipulation tool using the dbwrap
7 interface
8
10 dbwrap_tool [-?|--help] [--usage] [--persistent] [--non-persistent]
11 [-d|--debuglevel=DEBUGLEVEL] [--debug-stdout]
12 [--configfile=CONFIGFILE] [--option=name=value]
13 [-l|--log-basename=LOGFILEBASE] [--leak-report] [--leak-report-full]
14 {<database>} {<operation>} [<key> [<type> [<value>]]]
15
17 This tool is part of the samba(7) suite.
18 The dbwrap_tool program is used to read and manipulate TDB/CTDB
20 databases using the dbwrap interface.
21 The following database operations are available:
23 • fetch: fetch a record
25 • store: create or modify a record
27 • delete: remove a record
29 • exists: test for existence of a record
31 • erase: remove all records
33 • listkeys: list all available records
35 • listwatchers: list processes, which are waiting for changes
37 in a record
38 The following types are available:
41 • int32: signed 32bit integer
43 • uint32: unsigned 32bit integer
45 • string: "hello world"
47 • hex: hex strings like "68656C6C6F20776F726C6400" ("hello
49 world")
50
53 --persistent
54 Open the database as a persistent database.
55 Exactly one of --persistent and --non-persistent must be specified.
57 --non-persistent
59 Open the database as a non-persistent database.
60 Caveat: opening a database as non-persistent when there is
62 currently no other opener will wipe the database.
63 Exactly one of --persistent and --non-persistent must be specified.
65 -?|--help
67 Print a summary of command line options.
68 --usage
70 Display brief usage message.
71 -d|--debuglevel=DEBUGLEVEL
73 level is an integer from 0 to 10. The default value if this
74 parameter is not specified is 1 for client applications.
75 The higher this value, the more detail will be logged to the log
77 files about the activities of the server. At level 0, only critical
78 errors and serious warnings will be logged. Level 1 is a reasonable
79 level for day-to-day running - it generates a small amount of
80 information about operations carried out.
81 Levels above 1 will generate considerable amounts of log data, and
83 should only be used when investigating a problem. Levels above 3
84 are designed for use only by developers and generate HUGE amounts
85 of log data, most of which is extremely cryptic.
86 Note that specifying this parameter here will override the log
88 level parameter in the /etc/samba/smb.conf file.
89 --debug-stdout
91 This will redirect debug output to STDOUT. By default all clients
92 are logging to STDERR.
93 --configfile=<configuration file>
95 The file specified contains the configuration details required by
96 the client. The information in this file can be general for client
97 and server or only provide client specific like options such as
98 client smb encrypt. See /etc/samba/smb.conf for more information.
99 The default configuration file name is determined at compile time.
100 --option=<name>=<value>
102 Set the smb.conf(5) option "<name>" to value "<value>" from the
103 command line. This overrides compiled-in defaults and options read
104 from the configuration file. If a name or a value includes a space,
105 wrap whole --option=name=value into quotes.
106 -l|--log-basename=logdirectory
108 Base directory name for log/debug files. The extension ".progname"
109 will be appended (e.g. log.smbclient, log.smbd, etc...). The log
110 file is never removed by the client.
111 --leak-report
113 Enable talloc leak reporting on exit.
114 --leak-report-full
116 Enable full talloc leak reporting on exit.
117 -V|--version
119 Prints the program version number.
120
122 fetch
123 dbwrap_tool <database> fetch <key> <type>
124 store
126 dbwrap_tool <database> store <key> <type> <value>
127 delete
129 dbwrap_tool <database> delete <key>
130 exists
132 dbwrap_tool <database> exists <key>
133 erase
135 dbwrap_tool <database> erase
136 listkeys
138 dbwrap_tool <database> listkeys
139 listwatchers
141 dbwrap_tool <database> listwatchers
142
144 List all keys from winbindd_idmap.tdb
145 dbwrap_tool --persistent winbindd_idmap.tdb listkeys
146 Fetch record with key "USER HWM" as uint32
148 dbwrap_tool --persistent winbindd_idmap.tdb fetch "USER HWM" uint32
149 Remove record with key "USER HWM"
151 dbwrap_tool --persistent winbindd_idmap.tdb remove "USER HWM"
152 Store and overwrite record "USER HWM" with value 214
154 uint32: dbwrap_tool --persistent winbindd_idmap.tdb store "USER
155 HWM" uint32 214 hex: dbwrap_tool --persistent winbindd_idmap.tdb
156 store "USER HWM" hex D6000000
157
159 Use with caution!
160
162 This man page is part of version 4.19.3 of the Samba suite.
163
165 smbd(8), samba(7)
166
168 The original Samba software and related utilities were created by
169 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
170 Source project similar to the way the Linux kernel is developed.
171 The dbwrap_tool manpage was written by Bjoern Baumbach.
173Samba 4.19.3 11/27/2023 DBWRAP_TOOL(1)