blob: c6a69f89ba135415a64746fbb63f2b2379ebc7ad (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="dbwrap_tool.1">
<refmeta>
<refentrytitle>dbwrap_tool</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="source">Samba</refmiscinfo>
<refmiscinfo class="manual">System Administration tools</refmiscinfo>
<refmiscinfo class="version">&doc.version;</refmiscinfo>
</refmeta>
<refnamediv>
<refname>dbwrap_tool</refname>
<refpurpose>low level TDB/CTDB manipulation tool using the dbwrap interface</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dbwrap_tool</command>
<arg choice="opt">-?|--help</arg>
<arg choice="opt">--usage</arg>
<arg choice="opt">--persistent</arg>
<arg choice="opt">--non-persistent</arg>
<arg choice="opt">-d|--debuglevel=DEBUGLEVEL</arg>
<arg choice="opt">--debug-stdout</arg>
<arg choice="opt">--configfile=CONFIGFILE</arg>
<arg choice="opt">--option=name=value</arg>
<arg choice="opt">-l|--log-basename=LOGFILEBASE</arg>
<arg choice="opt">--leak-report</arg>
<arg choice="opt">--leak-report-full</arg>
<arg choice="req"><database></arg>
<arg choice="req"><operation></arg>
<arg choice="opt"><key>
<arg choice="opt"><type>
<arg choice="opt"><value></arg></arg></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The dbwrap_tool program is used to read and manipulate
TDB/CTDB databases using the dbwrap interface.</para>
<para>The following database operations are available:
<itemizedlist>
<listitem><para>fetch: fetch a record</para></listitem>
<listitem><para>store: create or modify a record</para></listitem>
<listitem><para>delete: remove a record</para></listitem>
<listitem><para>exists: test for existence of a record</para></listitem>
<listitem><para>erase: remove all records</para></listitem>
<listitem><para>listkeys: list all available records</para></listitem>
<listitem><para>listwatchers: list processes, which are waiting for changes in a record</para></listitem>
</itemizedlist>
</para>
<para>The following types are available:
<itemizedlist>
<listitem><para>int32: signed 32bit integer</para></listitem>
<listitem><para>uint32: unsigned 32bit integer</para></listitem>
<listitem><para>string: "hello world"</para></listitem>
<listitem><para>hex: hex strings like "68656C6C6F20776F726C6400" ("hello world")</para></listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>--persistent</term>
<listitem><para>Open the database as a persistent database.
</para>
<para>
Exactly one of --persistent and --non-persistent must be
specified.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--non-persistent</term>
<listitem><para>Open the database as a non-persistent database.
</para>
<para>
Caveat: opening a database as non-persistent when there
is currently no other opener will wipe the database.
</para>
<para>
Exactly one of --persistent and --non-persistent must be
specified.
</para></listitem>
</varlistentry>
&popt.autohelp;
&cmdline.common.samba.client;
</variablelist>
</refsect1>
<refsect1>
<title>COMMANDS</title>
<refsect2>
<title>fetch</title>
<cmdsynopsis>
<command>dbwrap_tool</command> <database> fetch <key> <type>
</cmdsynopsis>
</refsect2>
<refsect2>
<title>store</title>
<cmdsynopsis>
<command>dbwrap_tool</command> <database> store <key> <type> <value>
</cmdsynopsis>
</refsect2>
<refsect2>
<title>delete</title>
<cmdsynopsis>
<command>dbwrap_tool</command> <database> delete <key>
</cmdsynopsis>
</refsect2>
<refsect2>
<title>exists</title>
<cmdsynopsis>
<command>dbwrap_tool</command> <database> exists <key>
</cmdsynopsis>
</refsect2>
<refsect2>
<title>erase</title>
<cmdsynopsis>
<command>dbwrap_tool</command> <database> erase </cmdsynopsis>
</refsect2>
<refsect2>
<title>listkeys</title>
<cmdsynopsis>
<command>dbwrap_tool</command> <database> listkeys
</cmdsynopsis>
</refsect2>
<refsect2>
<title>listwatchers</title>
<cmdsynopsis>
<command>dbwrap_tool</command> <database> listwatchers
</cmdsynopsis>
</refsect2>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<variablelist>
<varlistentry><term>List all keys from winbindd_idmap.tdb</term>
<listitem><para><command>dbwrap_tool</command> --persistent winbindd_idmap.tdb listkeys</para></listitem>
</varlistentry>
<varlistentry><term>Fetch record with key "USER HWM" as uint32</term>
<listitem><para><command>dbwrap_tool</command> --persistent winbindd_idmap.tdb fetch "USER HWM" uint32</para></listitem>
</varlistentry>
<varlistentry><term>Remove record with key "USER HWM"</term>
<listitem><para><command>dbwrap_tool</command> --persistent winbindd_idmap.tdb remove "USER HWM"</para></listitem>
</varlistentry>
<varlistentry><term>Store and overwrite record "USER HWM" with value 214</term>
<listitem><para>uint32: <command>dbwrap_tool</command> --persistent winbindd_idmap.tdb store "USER HWM" uint32 214</para></listitem>
<listitem><para>hex: <command>dbwrap_tool</command> --persistent winbindd_idmap.tdb store "USER HWM" hex D6000000</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>NOTES</title>
<para>Use with caution!</para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is part of version &doc.version; of the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry></para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The dbwrap_tool manpage was written by Bjoern Baumbach.</para>
</refsect1>
</refentry>
|
