grommunio-admin-user¶
Name¶
grommunio-admin user — User management
Synopsis¶
grommunio-admin user create [–no-defaults] [<FIELDS>] USERNAME
grommunio-admin user delete [-c] [-k] [-y] USERSPEC
grommunio-admin user list [-f ATTRIBUTE=<value>] [-s FIELD]
[USERSPEC]
grommunio-admin user modify [<FIELDS>] [–delete-chat-user]
[–no-ldap] [–remove-alias ALIAS] [–remove-property PROPSPEC]
[–remove-storeprop PROPSPEC] USERSPEC
grommunio-admin user query [-f ATTRIBUTE=<value>] [–format FORMAT]
[–separator SEPARATOR][-s FIELD] [ATTRIBUTE …]
grommunio-admin user show [-f ATTRIBUTE=<value>] [-s FIELD]
USERSPEC
Description¶
Subcommand to show and delete users.
No functionality for adding or modifying users is implemented at the moment.
Commands¶
create
- Create a new user
delete
- Delete user
list
- List users Deprecated. Use query instead.
modify
- Modify a user
query
- Query user attributes
show
- Show detailed information about a user
Options¶
ATTRIBUTE
Attributes to query. Available attributes are ID, aliases, changePassword, chat, chatAdmin, domainID, forward, homeserverID, lang, ldapID, maildir, pop3_imap, privArchive, privChat, privFiles, privVideo, publicAddress, smtp, status and username.
If no attributes are specified, ID, username and status are shown.
USERNAME
- E-Mail address of the user
USERSPEC
- User name prefix or user ID
-c
,--keep-chat
- Deactivate but do not permanently delete chat user
--delete-chat-user
- Permanently delete chat user
-f FIELD=<value>
,--filter FIELD=<value>
- Filter expression in the form of ‘field=value’. Can be specified multiple times to refine filter
--format FORMAT
- Output format. Can be one of csv, json-flat, json-structured and pretty. Default is pretty.
-k
,--keep-files
- Do not delete user files from disk
--no-defaults
- Do not apply configured default values
--no-ldap
- Detach user from LDAP object
--remove-alias ALIAS
- Remove ALIAS from user (can be given multiple times)
--remove-property PROPSPEC
- Remove property from user (can be given multiple times)
--remove-storeprop PROPSPEC
- Remove property from user’s store (can be given multiple times)
--separator SEPARATOR
- String to use for column separation (csv and pretty only). Must have length 1 if format is csv. Default is “,” for csv and ” ” for pretty.
-s FIELD
,--sort FIELD
- Sort by field. Can be given multiple times
-y
,--yes
- Assume yes instead of prompting
Fields¶
--changePassword <bool>
- Whether the user can change the password
--chat <bool>
- Whether to create a chat user
--chatAdmin <bool>
- Whether the user has chat admin privileges
--homeserver ID
- ID of the home server or 0 for local user
--lang LANG
- User store language
--ldapID LDAPID
- Identifier of the LDAP object linked to the user
--pop3-imap <bool>
- Whether the user has the POP3/IMAP privilege
--privArchive <bool>
- Whether the user has the archiving privilege
--privChat <bool>
- Whether the user has the chat privilege
--privFiles <bool>
- Whether the user has the files privilege
--privVideo <bool>
- Whether the user has the video privilege
--public-address <bool>
- Whether the user has the public address privilege
--smtp <bool>
- Whether the user has the SMTP privilege
--status STATUS
- User address status. Either numeric value or one of normal, suspended, out-of-date, deleted or shared.
--alias ALIAS
- Add alias
--property propspec=value
- Set property defined by propspec to value
--storeprop propspec=value
- Set store property defined by propspec to value
See Also¶
grommunio-admin, grommunio-admin-domain, grommunio-admin-exmdb, grommunio-admin-fs, grommunio-admin-ldap, grommunio-admin-passwd, grommunio-admin-server