Chapter 7: Using the SafeWord 2008 Management Console
Reporting
171
As the command line reporting tool is simply a text-based shell script, it is
easily configurable. You will need to specify the name of the SafeWord server
machine, the port on which the Admin Server is listening, and the userid and
password of an administrative user through which the report queries can be
executed. Table 10 details the variables that are defined in both versions of the
shell script.
Table 10:
Shell script variables
Using the command line reporting tool
For Windows:
report.bat
template-file report-output-file [password].
The first two arguments are required. The first argument specifies the location
of a saved report template. Refer to “Report templates” on page 169
for
instructions on how to define and save a report template. By default, report
templates are saved in the
“templates”
subdirectory of the Console installation.
The second argument specifies the location of the target Excel worksheet file.
The Console installer creates a subdirectory called
“reports”
in which all
generated reports can be contained.
The third argument is optional and allows you to specify the password of the
administrative user that is used to execute the desired report queries. This is
useful in situations where it is not appropriate to store the cleartext fixed
password in the shell script.
Variable Name
Purpose
ADMIN_HOST
Specify the IP address or hostname of the machine on
which the SafeWord Admin Server is installed
ADMIN_PORT
Specify the port number on which the SafeWord Admin
Server is listening (By default, this port number is 5040).
ADMIN_USER
Specify the userid of the administrative user account
that will execute the desired report queries. This user
account must use a fixed password to authenticate to
SafeWord.
ADMIN_PASSWORD
Specify the password for the named administrative user.
This value need not be defined in the shell script as it
can be supplied as a command line argument to the
reporting tool. If you do decide to define the password in
the shell script, you should ensure that the script is
properly secured, either via operating system security
features or via physical machine security.
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
