1PUPPET-FILEBUCKET(8) Puppet manual PUPPET-FILEBUCKET(8)
2
6 puppet-filebucket - Store and retrieve files in a filebucket
7
9 A stand-alone Puppet filebucket client.
10
12 puppet filebucket mode [-h|--help] [-V|--version] [-d|--debug]
13 [-v|--verbose] [-l|--local] [-r|--remote] [-s|--server server]
14 [-f|--fromdate date] [-t|--todate date] [-b|--bucket directory] file
15 file ...
16 Puppet filebucket can operate in three modes, with only one mode per
18 call:
19 backup: Send one or more files to the specified file bucket. Each sent
21 file is printed with its resulting md5 sum.
22 get: Return the text associated with an md5 sum. The text is printed to
24 stdout, and only one file can be retrieved at a time.
25 restore: Given a file path and an md5 sum, store the content associated
27 with the sum into the specified file path. You can specify an entirely
28 new path to this argument; you are not restricted to restoring the con‐
29 tent to its original location.
30 diff: Print a diff in unified format between two checksums in the file‐
32 bucket or between a checksum and its matching file.
33 list: List all files in the current local filebucket. Listing remote
35 filebuckets is not allowed.
36
38 This is a stand-alone filebucket client for sending files to a local or
39 central filebucket.
40 Note that ´filebucket´ defaults to using a network-based filebucket
42 available on the server named ´puppet´. To use this, you´ll have to be
43 running as a user with valid Puppet certificates. Alternatively, you
44 can use your local file bucket by specifying ´--local´, or by specify‐
45 ing ´--bucket´ with a local path.
46
48 Note that any setting that´s valid in the configuration file is also a
49 valid long argument. For example, ´ssldir´ is a valid setting, so you
50 can specify ´--ssldir directory´ as an argument.
51 See the configuration file documentation at https://pup‐
53 pet.com/docs/puppet/latest/configuration.html for the full list of
54 acceptable parameters. A commented list of all configuration options
55 can also be generated by running puppet with ´--genconfig´.
56 --bucket
58 Specify a local filebucket path. This overrides the default path
59 set in ´$clientbucketdir´.
60 --debug
62 Enable full debugging.
63 --fromdate
65 (list only) Select bucket files from ´fromdate´.
66 --help Print this help message.
68 --local
70 Use the local filebucket. This uses the default configuration
71 information and the bucket located at the ´$clientbucketdir´
72 setting by default. If ´--bucket´ is set, puppet uses that path
73 instead.
74 --remote
76 Use a remote filebucket. This uses the default configuration
77 information and the bucket located at the ´$bucketdir´ setting
78 by default.
79 --server_list
81 A list of comma seperated servers; only the first entry is used
82 for file storage. This setting takes precidence over server.
83 --server
85 The server to use for file storage. This setting is only used if
86 server_list is not set.
87 --todate
89 (list only) Select bucket files until ´todate´.
90 --verbose
92 Print extra information.
93 --version
95 Print version information.
96
98 ## Backup a file to the filebucket, then restore it to a temporary directory
99 $ puppet filebucket backup /etc/passwd
100 /etc/passwd: 429b225650b912a2ee067b0a4cf1e949
101 $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949
102 ## Diff between two files in the filebucket
104 $ puppet filebucket -l diff d43a6ecaa892a1962398ac9170ea9bf2 7ae322f5791217e031dc60188f4521ef
105 1a2
106 > again
107 ## Diff between the file in the filebucket and a local file
109 $ puppet filebucket -l diff d43a6ecaa892a1962398ac9170ea9bf2 /tmp/testFile
110 1a2
111 > again
112 ## Backup a file to the filebucket and observe that it keeps each backup separate
114 $ puppet filebucket -l list
115 d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
116 $ echo again >> /tmp/TestFile
118 $ puppet filebucket -l backup /tmp/TestFile
120 /tmp/TestFile: 7ae322f5791217e031dc60188f4521ef
121 $ puppet filebucket -l list
123 d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
124 7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile
125 ## List files in a filebucket within date ranges
127 $ puppet filebucket -l -f 2015-01-01 -t 2015-01-11 list
128 <Empty Output>
129 $ puppet filebucket -l -f 2015-05-10 list
131 d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
132 7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile
133 $ puppet filebucket -l -f "2015-05-11 09:30:00" list
135 7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile
136 $ puppet filebucket -l -t "2015-05-11 09:30:00" list
138 d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
139 ## Manage files in a specific local filebucket
140 $ puppet filebucket -b /tmp/TestBucket backup /tmp/TestFile2
141 /tmp/TestFile2: d41d8cd98f00b204e9800998ecf8427e
142 $ puppet filebucket -b /tmp/TestBucket list
143 d41d8cd98f00b204e9800998ecf8427e 2015-05-11 09:33:22 /tmp/TestFile2
144 ## From a Puppet master, list files in the master bucketdir
146 $ puppet filebucket -b $(puppet config print bucketdir --section master) list
147 d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
148 7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile
149
151 Luke Kanies
152
154 Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0
155 License
156Puppet, Inc. January 2020 PUPPET-FILEBUCKET(8)