1ZARAFA-ADMIN(1) Zarafa user reference ZARAFA-ADMIN(1)
2
6 zarafa-admin - Manages Zarafa users and stores.
7
9 zarafa-admin ACTION [OPTION...]
10
12 This tool can be used to create the public store and to add, update and
13 remove users from Zarafa. The Zarafa server must be running for
14 zarafa-admin to work.
15 If no action is given, a listing of the possible parameters is printed.
17 When invalid actions or not enough options for an action are given, an
18 error message is printed.
19 When using LDAP as the users source, create, modify and delete actions
21 are done in the LDAP tree and not using the zarafa-admin tool. Please
22 see the EXTERNAL USERS() section for more information.
23
25 zarafa-admin needs an action command with the appropriate options.
26 Valid actions are:
27 -s
29 Create a public store. No other options are needed. Only one public
30 store can be created. Successive calls will fail.
31 -c username
33 Create a new user, -p, -f and -e options are required, -a and -n
34 parameters are optional. To set a password using a password prompt,
35 use the -P option in stead of -p.
36 -d username
38 Delete a user. No other options are needed. The deleted store of
39 the user will be marked as orphan store and can be restored with
40 --hook-store
41 -u username
43 Update user information. Valid parameters are: [-p|-P], -f, -e, -a,
44 -n and -U to update user information. Use: --qo, --qw, --qs or --qh
45 to set quota levels. Use 0 with quota options to set as
46 ´unlimited´.
47 --enable-feature and --disable-feature to enable or disable
49 specific features for users.
50 -g groupname
52 Create a new group. Valid parameters are: -e
53 --update-group groupname
55 Update group information. Valid parameters are: -e
56 -G groupname
58 Delete a group. No other options are needed.
59 -b username
61 Add a user to a group. Use the -i to set the groupname.
62 -B username
64 Remove a user from a group. Use the -i to set the groupname.
65 -l
67 List all users available in Zarafa. When using an external user
68 source, this action will implicitly synchronize all users in the
69 external source, creating, updating and/or removing users and
70 stores.
71 -L
73 List all groups available in Zarafa. When using an external user
74 source, this action will implicitly synchronize all groups in the
75 external source, creating updating and/or removing groups and
76 memberships.
77 --list-companies
79 List all tenans available in Zarafa. When using an external user
80 source, this action will implicitly synchronize all tenants in the
81 external source, creating updating and/or removing companies.
82 This option is only available in multi-tenancy Zarafa
84 --details name
86 Show all the details of a user, showing the fullname,
87 e-mailaddress, active state, administator state, group memberships
88 and quota settings. Optionally use --type to indicate for what kind
89 of object the details are being requested.
90 Note: This function does not synchronize with the external user
92 plugin. Thus changes from e.g. LDAP will not be set during this
93 function.
94 --type type
96 Additional argument for --details. The argument with this option
97 indicates for what type of object the details are being requested.
98 Allowed values are ´user´, ´group´ or ´tenant´ When this option is
99 not used, it defaults to ´user´
100 --create-company companyname
102 Create a new tenant space.
103 Use: --qo, --qw, --qs, --qh to set quota levels for the tenant.
105 Use: --udqo, --udqw, --udqs, --udqh to set the default quota levels
107 for the users inside the tenant.
108 This option is only available in multi-tenancy Zarafa.
110 --update-company companyname
112 Update an existing tenant space.
113 Use: --qo, --qw, --qs, --qh to set quota levels for the tenant.
115 Use: --udqo, --udqw, --udqs, --udqh to set the default quota levels
117 for the users inside the .
118 This option is only available in multi-tenancy Zarafa.
120 --delete-company companyname
122 Delete company space.
123 This option is only available in multi-tenancy Zarafa.
125 --set-system-admin companyname
127 Set system administrator for the tentant specified by -I.
128 Please be aware that this option does not provide the user with
130 administrator privileges. The system administrator is considered
131 the main contact person for a company, it will for example be used
132 as default sender for quota warning emails.
133 This option is only available in multi-tenancy Zarafa.
135 --add-to-viewlist companyname
137 Add tenant ´companyname´ to remote-view list of company specified
138 by -I. After this command the ´companyname´ is capable of viewing
139 all members of the company specified by -I.
140 This option is only available in multi-tenancy Zarafa.
142 --del-from-viewlist companyname
144 Delete company ´companyname´ from remote-view list of tenant
145 specified by -I. After this command the ´companyname´ is no longer
146 capable of viewing all members of the tenant specified by -I.
147 This option is only available in multi-tenancy Zarafa.
149 --list-view
151 List all tentants in the remote-view list of the tenant specified
152 by -I. The tenants in this list are able to view all members of the
153 specified tenant in their Address Book.
154 This option is only available in multi-tenancy Zarafa.
156 --add-to-adminlist username
158 Add user ´username´ to remote-admin list of tenant specified by -I.
159 This is the administrator list for remote administrators, as such
160 it only manages administrators from a different tenant. Users who
161 should be administrator over their own tenant are managed by
162 updating (-u) the user and specifying the -a argument.
163 Users can only be administrator over a different company when they
165 have also been granted view privileges, can be granted by using the
166 --add-to-viewlist.
167 This option is only available in multi-tenancy Zarafa.
169 --del-from-adminlist username
171 Delete user ´username´ from remote-admin list of company specified
172 by -I. This is the administrator list for remote administrators, as
173 such it only manages administrators from a different tenant. Users
174 who should be administrator over their own tenant are managed by
175 updating (-u) the user and specifying the -a argument.
176 This option is only available in multi-tenancy Zarafa.
178 --list-admin
180 List all users in the remote-admin list of the tenant specified by
181 -I. This is the administrator list for remote administrators, as
182 such it only manages administrators from a different tenant. Users
183 who should be administrator over their own tenant are managed by
184 updating (-u) the user and specifying the -a argument.
185 Users can only be administrator over a different tenant when they
187 have also been granted view privileges, can be granted by using the
188 --add-to-viewlist.
189 This option is only available in multi-tenancy Zarafa.
191 --add-userquota-recipient user
193 Add ´user´ as recipient to userquota warning emails. You can
194 optionally use -I to set the tenant space to apply the recipient
195 action on.
196 --del-userquota-recipient user
198 Delete ´user´ as recipient to userquota warning emails. You can
199 optionally use -I to set the tenant space to apply the recipient
200 action on.
201 --list-userquota-recipients
203 List all additional recipients for a userquota warning email. Use
204 -I to request the recipient list for a particular tenant space.
205 --add-companyquota-recipient user
207 Add ´user´ as recipient to tenant quota warning emails. You can
208 optionally use -I to set the tenant space to apply the recipient
209 action on.
210 --del-companyquota-recipient user
212 Delete ´user´ as recipient to tenant quota warning emails. You can
213 optionally use -I to set the tenant space to apply the recipient
214 action on.
215 --list-companyquota-recipients
217 List all additional recipients for a tenant quota warning email.
218 Use -I to request the recipient list for a particular tenant space
219 --list-sendas user
221 List all users who are able to directly send an email as user. This
222 has been set in the LDAP server, or with the --add-sendas command
223 for Unix and DB plugins. Optionally use --type to indicate for what
224 kind of object the sendas details are being requested.
225 --clear-cache
227 Clears the server´s caches. All data cached inside the
228 zarafa-server is cleared. Although this can never cause any data
229 loss, it can affect the performance of your server, since any data
230 requested after the cache is cleared needs to be re-requested from
231 the database or LDAP server. Normally this option is never needed;
232 it is mostly used as a diagnostics tool.
233 --purge-softdelete days
235 Starts a softdelete purge on the server, removing all soft-deleted
236 items which have been deleted days days ago, or earlier
237 --purge-deferred
239 The server has an optimization in which changes to the tproperties
240 table are not writted directly, but delayed for a more efficient
241 write at a later time. The server auto-purges these regularly. This
242 command allows you to purge all changes pending. It may be useful
243 to run this during low I/O load of your server (eg at night).
244 --list-orphans
246 When a user is removed, the store becomes orphaned. This option
247 shows a list of stores that are not hooked to a user. You can use
248 the --remove-store and --hook-store from this list.
249 --hook-store store-guid
251 You can hook an orphaned store to an existing user, so you may
252 access the store again. Use the -u username to specify the user to
253 hook the store to.
254 You can copy an orphaned store to the public store, so you can read
256 the store in the public folders. Use the --copyto-public to copy
257 the store to the public folder ´Admin/deleted stores´.
258 --remove-store store-guid
260 Use this action to remove the store from the database. The store is
261 actually just marked as deleted, so the softdelete system can
262 remove the store from the database.
263 --create-store username
265 This action will create a store for a newly created user, and is
266 normally called through the createuser script. If the
267 --list-orphans action listed users without a store, you can create
268 a new store for those users with this command.
269 --unhook-store
271 You can unhook a store from a user, so you can remove the store and
272 create a new one. Use the -u username to specify the user to unhook
273 the store from.
274 --force-resync usernames
276 You can force a resync of cached profiles when the data is out of
277 sync. One or more usernames can be specified.
278 --user-count
280 Shows an overview of user counts per type of user, and how much are
281 allowed by your current license.
282 --config file
284 Use a configuration file. See the CONFIG() section for more
285 information.
286 Default: /etc/zarafa/admin.cfg
288
290 The options used by actions are as follows:
291 -U ´new username´
293 Use this parameter to rename a user. This option is only valid with
294 the -u update action.
295 -p password
297 Set password for a user. This option is only valid with the -c
298 create or -u update action.
299 -P
301 Set password for a user. The password can be entered on the
302 password prompt. The password will not be shown. This option is
303 only valid with the -c create or -u update action.
304 -f ´full name´
306 Specify full user name. Use single quotes around the name to pass
307 it as a single parameter. This option is only valid with the -c
308 create or -u update action.
309 -e ´email address´
311 Specify the email address. This address will be used to set the
312 ´From´ email address in outgoing email messages. Use single quotes
313 around the name to pass it as a single parameter. This option is
314 only valid with the -c create or -u update action.
315 -a [yes|y|1|2 / no|n|0]
317 Set the user as administrator by passing ´yes´. When passing ´no´,
318 administrator rights will be revoked from the user. This option is
319 only valid with the -c create or -u update action.
320 It is also possible to pass 2 as administrator level, this will
322 make the user a system administrator who can create/modify/delete
323 companies.
324 -n [yes|y|1 / no|n|0]
326 Specify a non-active user. This user cannot login, but email can be
327 delivered, and the store can be opened by users with correct
328 rights.
329 --qo [yes|y|1 / no|n|0]
331 Override the default server quota settings for this user. User
332 specific quota levels will used. The default value of this option
333 is ´no´, always using server quota levels. This option is only
334 valid with the -c create or -u update action.
335 --qw value in Mb
337 Set the warning quota level for a user. The user may receive a
338 warning email when this level is reached. See zarafa-monitor(1) for
339 warning emails. This option is only valid with the -c create or -u
340 update action.
341 --qs value in Mb
343 Set the soft quota level for a user. The user will be unable to
344 receive new emails, bouncing the email back to the sender. This
345 option is only valid with the -c create or -u update action.
346 --qh value in Mb
348 Set the hard quota level for a user. The user will be unable to
349 receive and create new emails. This option is only valid with the
350 -c create or -u update action.
351 --udqo [yes|y|1 / no|n|0]
353 Override the default server quota settings for all user within the
354 specified tenant. default value of this option is ´no´, always
355 using server quota levels.
356 --udqw value in Mb
358 Set the warning quota level for all users within the specified
359 tentant. The user may receive a warning email when this level is
360 reached. See zarafa-monitor(1) for warning emails.
361 --udqs value in Mb
363 Set the soft quota level for all users within the specified
364 tentant. The user will be unable to receive new emails, bouncing
365 the email back to the sender. See zarafa-monitor(1) for warning
366 emails.
367 --udqh value in Mb
369 Set the hard quota level for all users within the specified tenant.
370 The user will be unable to receive and create new emails. See
371 zarafa-monitor(1) for warning emails.
372 --host, -h path
374 Connect to the Zarafa server through path, e.g.
375 file:///path/to/socket. Default: file:///var/run/zarafa. This
376 option can always be specified.
377 -i groupname
379 This sets the groupname for -b and -B actions.
380 -I companyname
382 This sets the companyname for all user, group and tenant commands.
383 This option is only available for multi-tenancy Zarafa.
384 --mr-accept [yes|y|1 / no|n|0]
386 Specified that meeting requests should automatically be accepted
387 for this user. This means that when a meeting request is sent to
388 this user when specified as being a ´resource´, the request will
389 directly be honoured and written to the calendar. This is a
390 client-side action and this setting therefore does not affect
391 actual meeting requests being delivered via zarafa-dagent.
392 --mr-decline-conflict [yes|y|1 / no|n|0]
394 This option only has effect when --mr-accept=yes is in effect. When
395 specifying --mr-decline-conflict, meeting requests that conflict
396 with an existing meeting will be declined.
397 --mr-decline-recurring [yes|y|1 / no|n|0]
399 This option only has effect when --mr-accept=yes is in effect. When
400 specifying --mr-decline-recurring, meeting requests that are
401 recurring will be declined.
402 --add-sendas sender
404 Add user sender to the list of the senders you´re updating as a
405 ´send as´ user. The sender can now send mails under the updated
406 user´s name, unless the updated user sets the sender as a delegate.
407 When the sender is a delegate, the mail will be sent with ´On
408 behalf of´ markings in the email. This option is only valid with
409 the -u and --update-group update action.
410 --del-sendas sender
412 Remove user sender from the list of the senders you´re updating as
413 a ´send as´ user. This option is only valid with the -u and
414 --update-group update action.
415 --lang language
417 Use language to create new stores; this means that folders in the
418 new store will be in the language specified. Only useful in
419 combination with --create-store. When this options in not
420 specified, the system default will be selected according the LC_*
421 and LANG environment variables, depending on your OS.
422
424 Normally, no configuration file is used or required. The following
425 options can be set in the configuation file:
426 server_socket
428 Unix socket to find the connection to the Zarafa server.
429 Default: file:///var/run/zarafa
431 sslkey_file
433 Use this file as key to logon to the server. This is only used when
434 server_socket is set to an HTTPS transport. See the zarafa-
435 server(1) manual page on how to setup SSL keys.
436 Default: value not set.
438 sslkey_pass
440 The password of the SSL key file that is set in sslkey_file.
441 Default: value not set.
443
445 For creating a user:
446 zarafa-admin -c loginname -p password -f ´Firstname Lastname´ -e
448 f.lastname@tenant.com
449 For creating a non-login store:
451 zarafa-admin -c loginname -p password -f ´Firstname Lastname´ -e
453 f.lastname@tenant.com -n 1
454 For modifying the password and e-mail address:
456 zarafa-admin -u loginname -p newpass -e fistname@tenant.com
458 For deleting a user:
460 zarafa-admin -d loginname
462 For adding a user to a group:
464 zarafa-admin -b loginname -i groupname
466 For setting a specific quota level for a user. Warning level to 80 Mb,
468 soft level to 90 Mb and hard level to 100 Mb:
469 zarafa-admin -u loginname --qo yes --qw 80 --qs 90 --qh 100
471
473 When the users are located in an external database, and the Zarafa
474 server is configured to use these users, a lot of commands from the
475 zarafa-admin tool make no sense anymore. An example of an external
476 database, and currently the only option, is an LDAP database.
477 The following actions can still be used, all other commands will be
479 automatically triggered by changing the values in the LDAP server.
480 -s: create public store.
482 -l: list users known to Zarafa.
484 -L: list groups known to Zarafa.
486 --details username: show user details.
488 --sync: trigger full synchonise for users and groups from the external
490 source.
491 When the users change in the external source, the Zarafa server
493 instantly synchronizes to these changes. There are two exceptions that
494 need some extra attention, and these are when users are created or
495 deleted. When a user is created, the createuser_script from the zarafa-
496 server.cfg(5) will be started to create a store for a user. Likewise,
497 when deleting a user, the deleteuser_script from the zarafa-
498 server.cfg(5) will be started to delete a store from a user. The same
499 is valid for creating and deleting a group and tenant, starting the
500 creategroup_script/createcompany_script and
501 deletegroup_script/deletecompany_script scripts respectively.
502
504 Could not create user/store/public store.
505 When you get this error, make sure the Zarafa server and database
507 server are running.
508
510 Written by Zarafa.
511
513 zarafa-server(1) zarafa-server.cfg(5)
514Zarafa 7.0 August 2011 ZARAFA-ADMIN(1)