2.3. listuser

listuser is the tool to list and search for users.

2.3.1. Parameters

-h,--helpPrints a help text
--environmentShow info about commandline environment
--nonlRemove all newlines (\n) from output
-c,--contextid <integer>The id of the context
-s,--searchpattern <string>Search/List pattern, default *
--csvCommand output as csv
-i,--ignorecase Do a case-insensitive search with the given search pattern

2.3.2. Extra parameters when authentication is enabled

-A,--adminuser <string>Context Admin user name
-P,--adminpass <string>Context Admin password

2.3.3. Return value

0 on success

>0 on failure

2.3.4. Mandatory parameters

contextid adminuser adminpass

2.3.5. Command output

Standard output (only a subset of available attributes are printed also only disabled modules):

idenabledimapServersmtpserverlanguageWebdavWebdavXml
3truelocalhostlocalhosten_USfalsefalse

csv output:

PasswordMech2String,Enabled,Username,PrimaryEmail,Sur_name,Given_name,Birthday,Anniversary,Branches,Business_category,Postal_code_business,State_business, Street_business,Telephone_callback,City_home,Commercial_register,Country_home,Company,Department,Display_name,Email2,Email3,EmployeeType,Fax_business,Fax_home,Fax_other,ImapServer, ImapLogin,SmtpServer,Instant_messenger1,Instant_messenger2,Telephone_ip,Telephone_isdn,Mail_folder_drafts_name,Mail_folder_sent_name,Mail_folder_spam_name,Mail_folder_trash_name, Manager_name,Marital_status,Cellular_telephone1,Cellular_telephone2,Nickname,Number_of_children,Note,Number_of_employee,Telephone_pager,Password_expired,Telephone_assistant, Telephone_business1,Telephone_business2,Telephone_car,Telephone_company,Telephone_home1,Telephone_home2,Telephone_other,Postal_code_home,Profession,Telephone_radio,Room_number, Sales_volume,City_other,Country_other,Middle_name,Postal_code_other,State_other,Street_other,Spouse_name,State_home,Street_home,Suffix,Tax_id,Telephone_telex,Timezone,Telephone_ttytdd, Url,Userfield01,Userfield02,Userfield03,Userfield04,Userfield05,Userfield06,Userfield07,Userfield08,Userfield09,Userfield10,Userfield11,Userfield12,Userfield13,Userfield14,Userfield15, Userfield16,Userfield17,Userfield18,Userfield19,Userfield20,City_business,Country_business,Assistant_name,Telephone_primary,Email1,PasswordMech,Mail_folder_confirmed_ham_name, Mail_folder_confirmed_spam_name,Spam_filter_enabled,Id,Info,Title,Position,Password,Aliases,Categories,access-calendar,access-contacts,access-delegate-tasks,access-edit-public-folder, access-forum,access-ical,access-infostore,access-pinboard-write,access-projects,access-read-create-shared-Folders,access-rss-bookmarks,access-rss-portal,access-syncml,access-tasks, access-vcard,access-webdav,access-webdav-xml,access-webmail

2.3.6. Example

 root@oxhe:~# /opt/open-xchange/sbin/listuser -c 6
Id Name     Displayname Email            
 2 admin    admin       admin@example.com
 3 holger   Holger      holger@example.com