ZxConfig CLI Commands
zxsuite config account Deprecated
zxsuite config account *set|get|empty* *accountName* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
command(M) |
String |
set|get|empty |
|
acc ountName(M) |
Account Name/ID |
||
attribute(O) |
String |
||
value(O) |
String |
(M) – mandatory parameter, (O) – optional parameter
Usage Example
zxsuite config account get accountName attribute debranded
Usage Example
zxsuite config account set accountName attribute debranded value true
Usage Example
zxsuite config account empty accountName attribute debranded
Warning
This command is deprecated use instead:
zxsuite config get account {account} {attribute} zxsuite config set
account {account} {attribute} {value} zxsuite config unset account
{account} {attribute}
zxsuite config clean
zxsuite config clean
Usage Example
zxsuite config clean
zxsuite config cos Deprecated
zxsuite config cos *set|get|empty* *cosName* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
command(M) |
String |
set|get|empty |
|
cosName(M) |
String |
||
attribute(O) |
String |
||
value(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config cos get cosName attribute debranded
Usage Example
zxsuite config cos set cosName attribute debranded value true
Usage Example
zxsuite config cos empty cosName attribute debranded
Warning
This command is deprecated use instead:
zxsuite config get cos {cos} {attribute} zxsuite config set cos
{cos} {attribute} {value} zxsuite config unset cos {cos}
{attribute}
zxsuite config distributionList
zxsuite config distributionList *set|get|empty*
*distributionListName* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
command(M) |
String |
set|get|empty |
|
distribution ListName(M) |
String |
||
attribute(O) |
String |
||
value(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config distributionList get distributionListName attribute allowDlMemberAddAsFriend
Usage Example
zxsuite config distributionList set distributionListName attribute allowDlMemberAddAsFriend value true
Usage Example
zxsuite config distributionList empty distributionListName attribute allowDlMemberAddAsFriend
zxsuite config doRestartService
zxsuite config doRestartService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config doRestartService
zxsuite config doStartService
zxsuite config doStartService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config doStartService
zxsuite config doStopService
zxsuite config doStopService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config doStopService
zxsuite config domain Deprecated
zxsuite config domain *set|get|empty* *domainName* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
command(M) |
String |
set|get|empty |
|
do mainName(M) |
Domain Name |
||
attribute(O) |
String |
||
value(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config domain get domainName attribute debranded
Usage Example
zxsuite config domain set domainName attribute debranded value true
Usage Example
zxsuite config domain empty domainName attribute debranded
Warning
This command is deprecated use instead:
zxsuite config get domain {domain} {attribute} zxsuite config set
domain {domain} {attribute} {value} zxsuite config unset domain
{domain} {attribute}
zxsuite config dump account
zxsuite config dump account *account* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
Account Name/ID |
||
sh ow-inherited(O) |
Boolean |
true|false |
true |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config dump account user@example.com
Dumps all the attributes related to the account u0@example.com skipping inherited values
Usage Example
zxsuite config dump account user@example.com show-inherited true
Dumps all the attributes related to the account u0@example.com showing inherited values
zxsuite config dump cos
zxsuite config dump cos *cos* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
cos(M) |
Unknown |
||
sh ow-inherited(O) |
Boolean |
true|false |
true |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config dump cos example_cos
Dumps all the attributes related to the cos example_cos skipping inherited values
Usage Example
zxsuite config dump cos example_cos show-inherited true
Dumps all the attributes related the the cos example_cos showing inherited values
zxsuite config dump domain
zxsuite config dump domain *domain* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
Domain Name |
||
sh ow-inherited(O) |
Boolean |
true|false |
true |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config dump domain example.com
Dumps all the attributes related to the domain example.com skipping inherited values
Usage Example
zxsuite config dump domain example.com show-inherited true
Dumps all the attributes related the the domain example.com showing inherited values
zxsuite config dump global
zxsuite config dump global
Usage Example
zxsuite config dump global
Dumps the global config
zxsuite config dump server
zxsuite config dump server *server* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
server(M) |
Unknown |
||
sh ow-inherited(O) |
Boolean |
true|false |
true |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config dump server mail.example.com
Dumps all the attributes related to the server mail.example.com skipping inherited values
Usage Example
zxsuite config dump server mail.example.com show-inherited true
Dumps all the attributes related to the server mail.example.com showing inherited values
zxsuite config empty account
zxsuite config empty account *account* *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
Account Name/ID |
||
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config empty account u0@example.net teamChatEnabled
Removes the assigned value to the attribute ‘teamChatEnabled’ of the account
zxsuite config empty cos
zxsuite config empty cos *cos* *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
cos(M) |
Unknown |
||
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config empty cos example_cos teamChatEnabled
Removes the assigned value to the attribute ‘teamChatEnabled’ of the COS
zxsuite config empty domain
zxsuite config empty domain *domain* *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
Domain Name |
||
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config empty domain example.com teamChatEnabled
Removes the assigned value to the attribute ‘teamChatEnabled’ of the domain
zxsuite config empty global
zxsuite config empty global *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config empty global teamChatEnabled
Removes the assigned value to the attribute ‘teamChatEnabled’
zxsuite config empty server
zxsuite config empty server *server* *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
server(M) |
Unknown |
||
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config empty server mail.example.com teamChatEnabled
Removes the assigned value to the attribute ‘teamChatEnabled’ of the server
zxsuite config getServices
zxsuite config getServices
Usage Example
zxsuite config getServices
zxsuite config get account
zxsuite config get account *account* *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
Account Name/ID |
||
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config get account u0@example.net teamChatEnabled
Retrieves the value of the attribute ‘teamChatEnabled’ of the account
zxsuite config get cos
zxsuite config get cos *cos* *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
cos(M) |
Unknown |
||
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config get cos example_cos teamChatEnabled
Retrieves the value of the attribute ‘teamChatEnabled’ of the COS
zxsuite config get domain
zxsuite config get domain *domain* *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
Domain Name |
||
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config get domain example.com teamChatEnabled
Retrieves the value of the attribute ‘teamChatEnabled’ of the domain
zxsuite config get global
zxsuite config get global *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config get global teamChatEnabled
Retrieves the value of the global attribute ‘teamChatEnabled’
zxsuite config get server
zxsuite config get server *server* *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
server(M) |
Unknown |
||
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config get server mail.example.com teamChatEnabled
Retrieves the value of the attribute ‘teamChatEnabled’ of the server
zxsuite config global Deprecated
zxsuite config global *set|get|empty* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
command(M) |
String |
set|get|empty |
|
attribute(O) |
String |
||
value(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config global get attribute debranded
Usage Example
zxsuite config global set attribute debranded value true
Usage Example
zxsuite config global empty attribute debranded
Warning
This command is deprecated use instead:
zxsuite config get global {attribute} zxsuite config set global
{attribute} {value} zxsuite config unset global {attribute}
zxsuite config info
zxsuite config info *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config info teamChatEnabled
zxsuite config server Deprecated
zxsuite config server *set|get|empty* *serverName* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
command(M) |
String |
set|get|empty |
|
se rverName(M) |
String |
||
attribute(O) |
String |
||
value(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config server get serverName attribute debranded
Usage Example
zxsuite config server set serverName attribute debranded value true
Usage Example
zxsuite config server empty serverName attribute debranded
Warning
This command is deprecated use instead:
zxsuite config get server {server} {attribute} zxsuite config set
server {server} {attribute} {value} zxsuite config unset server
{server} {attribute}
zxsuite config set account
zxsuite config set account *account* *attribute* *value*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
Account Name/ID |
||
a ttribute(M) |
String |
||
value(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config set account u0@example.com teamChatEnabled true
Sets the value of the attribute ‘teamChatEnabled’ to true for the account
zxsuite config set cos
zxsuite config set cos *cos* *attribute* *value*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
cos(M) |
Unknown |
||
a ttribute(M) |
String |
||
value(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config set cos example_cos teamChatEnabled true
Sets the value of the attribute ‘teamChatEnabled’ to true for the COS
zxsuite config set domain
zxsuite config set domain *domain* *attribute* *value*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
Domain Name |
||
a ttribute(M) |
String |
||
value(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config set domain example.net teamChatEnabled true
Sets the value of the attribute ‘teamChatEnabled’ to true for the domain
zxsuite config set global
zxsuite config set global *attribute* *value*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
a ttribute(M) |
String |
||
value(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config set global teamChatEnabled true
Sets the value of the global attribute ‘teamChatEnabled’ to true
zxsuite config set server
zxsuite config set server *server* *attribute* *value*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
server(M) |
Unknown |
||
a ttribute(M) |
String |
||
value(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config set server mail.example.com teamChatEnabled true
Sets the value of the attribute ‘teamChatEnabled’ to true for the server
zxsuite config status
zxsuite config status
Usage Example
zxsuite config status
zxsuite config unset account
zxsuite config unset account *account* *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
Account Name/ID |
||
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config unset account u0@example.net teamChatEnabled
Removes the assigned value to the attribute ‘teamChatEnabled’ of the account
zxsuite config unset cos
zxsuite config unset cos *cos* *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
cos(M) |
Unknown |
||
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config unset cos example_cos teamChatEnabled
Removes the assigned value to the attribute ‘teamChatEnabled’ of the COS
zxsuite config unset domain
zxsuite config unset domain *domain* *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
Domain Name |
||
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config unset domain example.com teamChatEnabled
Removes the assigned value to the attribute ‘teamChatEnabled’ of the domain
zxsuite config unset global
zxsuite config unset global *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config unset global teamChatEnabled
Removes the assigned value to the global attribute ‘teamChatEnabled’
zxsuite config unset server
zxsuite config unset server *server* *attribute*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
server(M) |
Unknown |
||
a ttribute(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite config unset server mail.example.com teamChatEnabled
Removes the assigned value to the attribute ‘teamChatEnabled’ of the server