Hello DiQ!
There are three commands specifically related to buddy list management in the ZeXtras CLI:
zxsuite chat doAddBuddies
Code:
Syntax:
zxsuite chat doAddBuddies {user1} {user2} [attr1 value1 [attr2 value2...]]
PARAMETER LIST
NAME TYPE
user1(M) Account Name
user2(M) Account Name
user1nick(O) String
user2nick(O) String
(M) == mandatory parameter, (O) == optional parameter
Usage example:
zxsuite chat doAddBuddies john@example.com jack@example.com user1nick "My Best Friend"
Makes John and Jack ZxChat buddies. Jack will see John as 'My Best Friend' in the ZxChat
zxsuite chat doMakeBuddies
Code:
Syntax:
zxsuite chat doMakeBuddies {distribution_list}
PARAMETER LIST
NAME TYPE
distribution_list(M) String
(M) == mandatory parameter, (O) == optional parameter
Usage example:
zxsuite chat doMakeBuddies example_list@example.com
Makes all the users in example_list@example.com ZxChat buddies with each other.
** NOTE ** This command can create a lot of entries in the ZxChat buddy database.
For example, if there are 100 members in the distribution list, the entries
added to the database will be 100 * 99 = 9900
zxsuite chat doRemoveBuddies
Code:
Syntax:
zxsuite chat doRemoveBuddies {user1} {user2}
PARAMETER LIST
NAME TYPE
user1(M) Account Name
user2(M) Account Name
(M) == mandatory parameter, (O) == optional parameter
Usage example:
zxsuite chat doRemoveBuddies john@example.com jack@example.com
Unbuddies John and Jack in the ZxChat.
You can find a full list of any module's commands by running either `zxsuite help [modulename]` or `zxsuite [modulename]`, e.g.
Code:
zimbra@test:~$ zxsuite help chat
Commands regarding ZeXtras Chat module
doAddBuddies - Makes two users chat buddies
zxsuite chat doAddBuddies {user1} {user2} [attr1 value1 [attr2 value2...]]
doClearChatDB - Empties the chat buddies database
zxsuite chat doClearChatDB [attr1 value1 [attr2 value2...]]
doMakeBuddies - Makes all users in a distribution list friends with each other
zxsuite chat doMakeBuddies {distribution_list}
doMigrateZimbraIMRoster - Migrate Zimbra IM rosters from the local Zimbra IM instance. Pending buddy requests are not imported. Works on Zimbra 6.x and 7.x.
zxsuite chat doMigrateZimbraIMRoster
doRemoveBuddies - Unbuddy two users
zxsuite chat doRemoveBuddies {user1} {user2}
doRestartService - restart a given service
zxsuite chat doRestartService {service_name}
doStartService - start a given service
zxsuite chat doStartService {service_name}
doStopService - stop a given service
zxsuite chat doStopService {service_name}
getAccountStatus - Get current account status
zxsuite chat getAccountStatus {account}
getBuddyList - Shows a user's buddyList
zxsuite chat getBuddyList {account}
getProperty - Get configuration properties
zxsuite chat getProperty [attr1 value1 [attr2 value2...]]
getServerStatus - Get current chat server status
zxsuite chat getServerStatus
getServices - show current status of all services for this module
zxsuite chat getServices
setProperty - Set configuration property
zxsuite chat setProperty {property_name} {property_value}
zimlet - Manage ZxChat zimlet
zxsuite chat zimlet [attr1 value1 [attr2 value2...]]
Furthermore, running a command with no arguments will display the command's usage message...
Have a nice day,
Cine
the ZeXtras team
Bookmarks