Skip to main content

Terminal Commands

Clients​

The following commands are available in the terminal:

createClient​

createClient — Create a new client

Synopsis​

createClient <username> <password> <clientid> <rolename> <textname> <textdescription>

deleteClient​

deleteClient — Delete a client

Synopsis​

deleteClient <username>

disableClient​

disableClient — Disable a client

Synopsis​

disableClient <username>

enableClient​

enableClient — Enable a client

Synopsis​

enableClient <username>

getClient​

getClient — Get the details for a client

Synopsis​

getClient <clientname>

listClients​

listClients — List all clients

Synopsis​

listClients

modifyClient​

modifyClient — Modify a client

Synopsis​

modifyClient <username> <password> <clientid> <textname> <textdescription>

Groups​

addGroupClient​

addGroupClient — Add a client to a group

Synopsis​

addGroupClient <username> <groupname> <priority>

addGroupRole​

addGroupRole - Add a role to a group

Synopsis​

addGroupRole <groupname> <rolename> <priority>

createGroup​

createGroup — Create a new group

Synopsis​

createGroup <groupname> <rolename> <textname> <textdescription>

deleteGroup​

deleteGroup — Delete a client

Synopsis​

deleteGroup <groupname>

getAnonymousGroup​

getAnonymousGroup — Get anonymous group

Synopsis​

getAnonymousGroup

getGroup​

getGroup — Get the details for a group

Synopsis​

getGroup <groupname>

listGroups​

listGroups — List all groups

Synopsis​

listGroups

modifyGroup​

modifyGroup — Modify a group

Synopsis​

modifyGroup <groupname> <textname> <textdescription>

removeGroupClient​

removeGroupClient — Remove a client from a group

Synopsis​

removeGroupClient <username> <groupname>

removeGroupRole​

removeGroupRole — Remove a role from a group

Synopsis​

removeGroupRole <groupname> <rolename>

setAnonymousGroup​

setAnonymousGroup — Set anonymous group

Synopsis​

setAnonymousGroup <groupname>

Roles​

addRoleACL​

addRoleACL — Add ACL to role

Synopsis​

addRoleACL <rolename> <acltype> <topic filter> allow|deny <priority>

createRole​

createRole — Create a new role

Synopsis​

createRole <rolename> <textname> <textdescription>

deleteRole​

deleteRole — Delete a role

Synopsis​

deleteRole <rolename>

getDefaultACLAccess​

getDefaultACLAccess — Get the default ACL access

Synopsis​

getDefaultACLAccess

getRole​

getRole — Get the details for a role

Synopsis​

getRole <rolename>

modifyRole​

modifyRole — Modify a role

Synopsis​

modifyRole <rolename> <textname> <textdescription>

listRoles​

listRoles — List all roles

Synopsis​

listRoles

removeRoleACL​

removeRoleACL — Remove an ACL from a role

Synopsis​

removeRoleACL <rolename> <acltype> <topic>

setDefaultACLAccess​

setDefaultACLAccess — Set the default ACL access'

Synopsis​

setDefaultACLAccess <acltype> true|false