ZxTeam CLI Commands
zxsuite team addOwner
# zxsuite team4 addOwner _conversation_id_ _owner_
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
convers ation_id(M) |
String |
Group, Space, or Channel ID |
|
owner(M) |
Account Name |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite team addOwner aced5e2e-f457-4d30-a3fb-9b18fac486a6@example.com user2@example.com
user2@example.com becomes an owner of the rooms with conversation_id aced5e2e-f457-4d30-a3fb-9b18fac486a6@example.com
zxsuite team clusterStatus
zxsuite team clusterStatus
Usage Example
zxsuite team clusterStatus
zxsuite team doClearChatDB
zxsuite team doClearChatDB *start* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
action(M) |
String |
start |
|
iamsure(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite team doClearChatDB
zxsuite team doConversationsMessagesCleanup
zxsuite team doConversationsMessagesCleanup
Usage Example
zxsuite team doConversationsMessagesCleanup
zxsuite team doDeployTeamZimlet
zxsuite team doDeployTeamZimlet
Usage Example
zxsuite team doDeployTeamZimlet
Deploy Zextras Suite Team
zxsuite team doImportChannels
zxsuite team doImportChannels [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
delet e_destination_b efore_import(O) |
Boolean |
true|false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite team doImportChannels
zxsuite team doMoveAllRooms
zxsuite team doMoveAllRooms [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
destination(O) |
String |
ma il3.example.com |
|
force(O) |
Boolean |
false |
false |
n otifications(O) |
Email Address[,..] |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite –progress team doMoveAllRooms server3.example.com notifications user1@example.com,user2@example.com
zxsuite –progress team doMoveAllRooms server3.example.com force true
Move every room to server3 and sends notifications to user1@example.com and user2@example.com
zxsuite team doMoveRoom
zxsuite team doMoveRoom *room-id* *destination* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
room-id(M) |
String |
0b3 13912-1334-43d6 -b1ad-ec8500fa1 505@example.com |
|
des tination(M) |
String |
mail3.example.com |
|
force(O) |
Boolean |
false |
false |
n otifications(O) |
Email Address[,..] |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite –progress team doMoveRoom ROOM-ID server3.example.com notifications user1@example.com, user2@example.com
Move room ROOM-ID to server3 and sends notifications to user1@example.com and user2@example.com
zxsuite team doRestartService
zxsuite team doRestartService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite team doRestartService
zxsuite team doRoomsCleanup
zxsuite team doRoomsCleanup
Usage Example
zxsuite team doRoomsCleanup
zxsuite team doStartService
zxsuite team doStartService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite team doStartService
zxsuite team doStopService
zxsuite team doStopService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite team doStopService
zxsuite team doUsersCleanup
zxsuite team doUsersCleanup
Usage Example
zxsuite team doUsersCleanup
zxsuite team dumpSessions
zxsuite team dumpSessions
Usage Example
zxsuite team dumpSessions
zxsuite team flushConversationsCache
zxsuite team flushConversationsCache
Usage Example
zxsuite team flushConversationsCache
zxsuite team getServices
zxsuite team getServices
Usage Example
zxsuite team getServices
zxsuite team iceServer add
zxsuite team iceServer add *turn:turn.example.com:3478?transport=udp*
[param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
url(M) |
String |
turn:turn. example.com:347 8?transport=udp |
|
username(O) |
String |
myuser |
|
credential(O) |
String |
mysecretkey |
|
account(O) |
String |
||
cos(O) |
String |
default |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite team iceServer add turn:turn.example.com credential mysecret username myuser
Usage Example
zxsuite team iceServer add turn:turn.example.com credential mysecret username myuser account testaccount@example.com
zxsuite team iceServer get
zxsuite team iceServer get [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(O) |
String |
||
cos(O) |
String |
default |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite team iceServer get
Usage Example
zxsuite team iceServer get cos default
zxsuite team iceServer remove
zxsuite team iceServer remove
*turn:turn.example.com:3478?transport=udp* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
url(M) |
String |
turn:turn. example.com:347 8?transport=udp |
|
username(O) |
String |
myuser |
|
credential(O) |
String |
mysecretkey |
|
account(O) |
String |
||
cos(O) |
String |
default |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite team iceServer remove turn:turn.example.com credential mysecret username myuser
Usage Example
zxsuite team iceServer remove turn:turn.example.com credential mysecret username myuser account testaccount@example.com
zxsuite team monitor
zxsuite team monitor *operation_uuid* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
operat ion_uuid(M) |
Uuid |
||
op eration_host(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite team monitor
zxsuite team rooms
zxsuite team rooms [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
members(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite team rooms
zxsuite team space get
zxsuite team space get
Usage Example
zxsuite team space get
zxsuite team video-server add
zxsuite team video-server add *videoserver.example.com* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
host(M) |
String |
videoser ver.example.com |
|
port(O) |
Integer |
8188 |
|
secret(O) |
String |
api-secret |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite team video-server add videoserver.example.com
zxsuite team video-server add videoserver.example.com port 12003 secret api-secret
zxsuite team video-server remove
zxsuite team video-server remove *videoserver.example.com* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
host(M) |
String |
videoser ver.example.com |
|
port(O) |
Integer |
2003 |
8188 |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite team video-server remove videoserver.example.com
zxsuite team video-server remove videoserver.example.com port 12345