6.9. Users Table

6.9. Users Table
	Chapter 6. Command language

The service of user authentication is provided through a centralized “archive” where users are defined as well as the services to which they have access and some service-related parameters. These services are:

CHAT

Two default users exist: admin and guest: they can't be removed and are disabled by default.

Admin user can be activated only with a password not empty, while guest user can't have a password.

An Abilis user named 'super' is automatically created in the 8.9 configuration, it's only used for CP 'SUPERUSER' purposes in LOGIN-MODE:USERS (please refer to Control Port for more explanations), it is not available to other services.

[13:07:42] ABILIS_CPX:d user:super

Parameter:          | Value:
--------------------+----------------------------------------------------------
USER:                 super
REAL-NAME:            super                                        <Read Only>
ID:                   43                                           <Read Only>
PWD:                  1f0d9472713490184a0607af64f2bd99346e2360ad6a76551fee1ebe80b536f0
ACT:                  YES                                          <Read Only>                 #LOGIN-MODE:USERS
CP-LEVEL:             SUPER                                        <Read Only>
SSH-IP-PERMIT:        *
TELNET-IP-PERMIT:     *
-------------------------------------------------------------------------------

It is forcedly activated when LOGIN-MODE:USERS and it is forcedly deactivated when LOGIN-MODE:LEGACY, please refer to Section 23.2, “CP LOGIN-MODE”.

[13:07:42] ABILIS_CPX:d user:super

Parameter:          | Value:
--------------------+----------------------------------------------------------
USER:                 super
REAL-NAME:            super                                        <Read Only>
ID:                   10                                           <Read Only>
ACT:                  NO                                           <Read Only>                 #LOGIN-MODE:LEGACY
-------------------------------------------------------------------------------

	Tip
	For more information please see: Section 23.2, “CP LOGIN-MODE”.

Users Table can be managed with the following commands:

d user: displays the Users table;
a user: adds a new user;
c user: clears an existing user;
s user: modifies the parameter of an existing user.

6.9.1. D USER (Display User)

This command shows the content of the Users Table in a synthetic format. The available syntax of the commands is:

d user: shows the user's list;
d user:<username> : shows the Users Table entry identified by the “user:<username>” in a synthetic format, i.e. The parameters of the services which aren't enabled are omitted.
d user: ? shows the meaning of all parameters.

[15:36:52] ABILIS_CPX:d user

------------------------+-------------+----------------------------------------
USER             PWD ACT|CTIP CLUS    |CHAT LDAP PPP FTP HTTP MAIL IAX SIP VO
------------------------+-------------+----------------------------------------
admin            *** YES #    #        NO   YES  YES YES YES  NO   NO  NO  NO
guest                NO  #    #        NO   NO   NO  NO  NO   NO   NO  NO  NO
super                NO  #    #        NO   NO   NO  NO  NO   NO   NO  NO  NO

[15:36:57] ABILIS_CPX:d user:admin

Parameter:          | Value:
--------------------+----------------------------------------------------------
USER:                 admin
REAL-NAME:            admin                                        
ID:                   1                                            <Read Only>
PWD:                  ***
ACT:                  YES                                          
CP-LEVEL:             NO                                           
SSH-IP-PERMIT:        *
TELNET-IP-PERMIT:     *
CTI-ROLE:             EXTENSION
GROUP:                
CTIP:                 #
CTIP-CDI-PERMIT:      *
CLUS:                 #
CLUS-CDI-PERMIT:      *
ADDRBOOK-SYNC:        SYS                                          
ADDRBOOK-NUMBER:      NONE                                         
ADDRBOOK-OUTDIAL:     NONE                                         
ADDRBOOK-PRIV-MAX:    SYS
ADDRBOOK-PUB-EDITABLE:YES                                          <Read Only>
IO-MAP:               #
OPC-ROLE:             OPERATOR
OPC-VIEW:             *
OPC-HIDE-NUMBERS:     NO
OPC-MONITOR:          NONE
OPC-PRIVACY:          NO
CHAT:                 NO    
CHAT-USER:            SYS
CHAT-PWD:             SYS
LDAP:                 YES   
LDAP-OWN-ADDRBOOK:    NO                                           
PPP:                  YES                                          
PPP-AUTH:             CHAP
PPP-RES:              ANY
PPP-NEIGH:            #
PPP-MASK:             255.255.255.255
PPP-ROUTE:            #
FTP:                  YES   
FTP-HOMEDIR:          
FTP-PROT:             PLAIN
HTTP:                 YES
HTTP-LEVEL:           ADMINISTRATOR
HTTP-HOME-URL:        
HTTP-PROT:            PLAIN,SSL
-------------------------------------------------------------------------------

Meaning of the most important parameters:

REAL-NAME

Real name of the user. Max 32 ASCII characters. Spaces require double quotes (E.g. "my real name").

PWD

User password. Max 32 ASCII characters. Space not allowed. For user 'super' only, it can be set by 32 bytes hash, entered as 64 characters. Case sensitive match.

CP-LEVEL

CP access level [NO, USER, ADMIN, SUPER].

	Tip
	For more information please see: Section 23.3.2, “LOGIN-MODE:USERS access levels”.

	Important
	Only when `LOGIN-MODE`:`USERS`.

SSH-IP-PERMIT

IP addresses allowed when the user logs in via SSH. The name of an IP/IR list or * or LOCAL or NO.

	Important
	Only when `LOGIN-MODE`:`USERS`.

TELNET-IP-PERMIT

IP addresses allowed when the user logs in via TELNET. The name of an IP/IR list or * or LOCAL or NO.

	Important
	Only when `LOGIN-MODE`:`USERS`.

6.9.1.1. D USERE (Display User Extended)

This command shows the content of the Users Table in extended format. The available syntax of the command is:

d usere: shows the list in extended format of all users
d usere:<username> : shows the content of the Users Table in extended format, i.e. all users defined with their full set of configuration information are displayed.

[15:41:01] ABILIS_CPX:d usere:admin

Parameter:          | Value:
--------------------+----------------------------------------------------------
USER:                 admin
REAL-NAME:            admin                                        
ID:                   1                                            <Read Only>
PWD:                  ***
ACT:                  YES                                          
CP-LEVEL:             NO                                           
SSH-IP-PERMIT:        *
TELNET-IP-PERMIT:     *
CTI-ROLE:             EXTENSION
GROUP:                
CTIP:                 #
CTIP-CDI-PERMIT:      *
CLUS:                 #
CLUS-CDI-PERMIT:      *
ADDRBOOK-SYNC:        SYS                                          
ADDRBOOK-NUMBER:      NONE                                         
ADDRBOOK-OUTDIAL:     NONE                                         
ADDRBOOK-PRIV-MAX:    SYS
ADDRBOOK-PUB-EDITABLE:YES                                          <Read Only>
IO-MAP:               #
OPC-ROLE:             OPERATOR
OPC-VIEW:             *
OPC-HIDE-NUMBERS:     NO
OPC-MONITOR:          NONE
OPC-PRIVACY:          NO
CHAT:                 NO    
CHAT-USER:            SYS
CHAT-PWD:             SYS
LDAP:                 YES   
LDAP-OWN-ADDRBOOK:    NO                                           
PPP:                  YES                                          
PPP-AUTH:             CHAP
PPP-RES:              ANY
PPP-NEIGH:            #
PPP-MASK:             255.255.255.255
PPP-ROUTE:            #
FTP:                  YES   
FTP-HOMEDIR:          
FTP-PROT:             PLAIN
HTTP:                 YES
HTTP-LEVEL:           ADMINISTRATOR
HTTP-HOME-URL:        
HTTP-PROT:            PLAIN,SSL
MAIL:                 NO    
MAIL-MB-MAXSIZE:      SYS
MAIL-MB-MAXMAILS:     SYS
MAIL-MSG-LIFETIME:    SYS
MAIL-AUTH:            SYS
IAX:                  NO    
IAX-HOST:             DYNAMIC
IAX-SRCADD:           SYS
IAX-PORT:             (DYNAMIC)
IAX-IP-PERMIT:        *
IAX-MAXSES-BID:       2
IAX-MAXSES-IN:        0
IAX-MAXSES-OUT:       0
IAX-CDI-PERMIT:       *
IAX-NUMBER:           
IAX-ADDRBOOK-NUM:     IAX-NUMBER
IAX-CG-NUM:           AUTO
IAX-FWD-CG-NUM:       CALLER
IAX-CTIP-TYPE:        SYS
IAX-RG-IN:            SYS
IAX-ROUTE-BY-SD:      NO                                           
IAX-PROVIDE-SG:       NO
IAX-CLIP-RULE:        SYS
IAX-BUSY-NOCHAN:      NO
IAX-LCS-GROUP:        NONE
IAX-CPO:              SYS
IAX-CPO-STATE:        SYS
IAX-CPO-DROP:         SYS
IAX-SS:               NO
IAX-SS-PICKUP:        NO
IAX-SS-PRES-CG:       YES
IAX-SS-CF-DND:        YES
IAX-SS-VM:            YES
IAX-CONTEXT:          
IAX-PROVIDE-NAME:     BLANK
IAX-AUTH:             SYS
IAX-NETSTATS:         SYS
IAX-TRUNK:            SYS
IAX-TRUNK-FREQ:       SYS
IAX-TRUNK-TS:         SYS
IAX-CHAN-FREQ:        SYS
IAX-TRANSFER:         SYS
IAX-DISC-AUDIO:       SYS
IAX-HTML-IN:          SYS
IAX-HTML-OUT:         SYS
IAX-REM-USER:         
IAX-REM-PASS:                 
IAX-REM-AUTH:         SYS
IAX-REM-REG:          NO                                           
SIP:                  NO    
SIP-TYPE:             PHONE                                        
SIP-DOMAIN:           SYS
SIP-HOST:             DYNAMIC
SIP-REMPORT:          (DYNAMIC)
SIP-LOCPORT:          SYS
SIP-SRCADD:           SYS
SIP-IP-PERMIT:        *
SIP-MAXSES-BID:       2
SIP-MAXSES-IN:        0
SIP-MAXSES-OUT:       0
SIP-BUSY-INUSE:       NO
SIP-CDI-HEADER:       REQUEST-URI
SIP-CDI-PERMIT:       *
SIP-NUMBER:           
SIP-ADDRBOOK-NUM:     SIP-NUMBER
SIP-CG-NUM:           AUTO
SIP-FWD-CG-NUM:       CALLER
SIP-DISPLAY-NAME:     SG-CG
SIP-CTIP-TYPE:        SYS
SIP-RG-IN:            SYS
SIP-ROUTE-BY-SD:      NO                                           
SIP-PROVIDE-SG:       NO
SIP-CLIP-RULE:        SYS
SIP-BUSY-NOCHAN:      NO
SIP-LCS-GROUP:        NONE
SIP-CPO-RTP:          SYS
SIP-CPO-SIGNALLING:   NO
SIP-RCC:              YES
SIP-OPC-AUTOANSWER:   YES
SIP-SS:               NO
SIP-SS-PICKUP:        NO
SIP-SS-PRES-CG:       YES
SIP-SS-CF-DND:        YES
SIP-SS-VM:            YES
SIP-CHAN-FREQ:        SYS
SIP-REMOTE-NAT:       NO
SIP-LOCAL-NAT:        NO
SIP-EXTERNAL-IP:      SYS
SIP-PRACK:            YES
SIP-QUALIFY:          NO
SIP-SEND-Q850:        YES
SIP-KEEPALIVE:        SYS
SIP-DTMF-MODE:        SYS
SIP-DISC-AUDIO:       SYS
SIP-BC-TRANSP:        UDI
SIP-T38:              SYS
SIP-T38-G711:         SYS
SIP-T38-PACKING:      SYS
SIP-T38-REDUND:       SYS
SIP-T38-REDUND-PCK:   SYS
SIP-UA:               SYS
SIP-UA-PERMIT:        *
SIP-REM-USER:         
SIP-REM-PASS:                 
SIP-REM-AUTH-USER:    AUTO ()
SIP-REM-REG-EXPIRY:   120
SIP-REM-REG:          NO                                           
VO:                   NO
VO-CHANNELS:          1     
VO-CDI-PERMIT:        *
VO-PS-NUM:            SYS
VO-CB-NUM:            SYS
VO-CB-CGO:            SYS
-------------------------------------------------------------------------------

6.9.2. A USER (Add User)

This command adds a new entry in the Users Table.

[15:50:16] ABILIS_CPX:a user:pippo pwd:pippo http:yes

COMMAND EXECUTED

[15:50:33] ABILIS_CPX:d user

- Not Saved (SAVE CONF) -------------------------------------------------------
------------------------+-------------+----------------------------------------
USER             PWD ACT|CTIP CLUS    |CHAT LDAP PPP FTP HTTP MAIL IAX SIP VO
------------------------+-------------+----------------------------------------
admin            *** YES #    #        NO   YES  YES YES YES  NO   NO  NO  NO
guest                NO  #    #        NO   NO   NO  NO  NO   NO   NO  NO  NO
pippo            *** YES #    #        NO   NO   NO  NO  YES  NO   NO  NO  NO

	Note
	A restricted user name character set can be used. Avoided those characters that aren't valid in file names '\', '/', ':', '*', '?', '"', '>', '<', '\|'.

The following command displays the syntax:

[15:41:15] ABILIS_CPX:a user: ?

A USER:val [par:val]          Add an entry to the Users Access Control table
                              Up to 1000 users can be configured.

USER:      User name. Max. 32 ASCII characters.                    <Mandatory>
           Characters '\', '/', ':', '*', '?', '"', '<', '>', '|'
           and spaces are not allowed. Case is preserved.
           The strings "*", "#", "A" and "ALL", "anonymous" and
           "any-authenticated" are invalid/reserved to the system
           and cannot be used for user name value.

User's parameters:
...

6.9.3. C USER (Clear User)

This command deletes an entry in the Users Table.

[17:46:42] ABILIS_CPX:c user:user10

YOU ASKED TO DELETE USER 'user10'.

REMOVAL OF USER:user10 WILL ERASE Call Logs,
Voice Mail messages, Abilis Address book contacts and
LDAP Address book contacts OF THIS USER.
ALL OCCURRENCES OF THIS USER IN Http/Ftp/Ldap Rights, CtiVr Routings,
CtiIax/CtiSip/CtiVo Numbers AND OPC Lists WILL BE REMOVED.

PROCEED ANYWAY (N/Y)?y

COMMAND EXECUTED

The following command displays the syntax:

[15:47:55] ABILIS_CPX:c user: ?

C USER:val                    Clear a user from the Users Access Control table

USER:      User name. Max. 32 ASCII characters.                    <Mandatory>

6.9.4. S USER (Set User)

This command modifies an entry in the Users Table.

[15:51:07] ABILIS_CPX:s user:pippo ftp:yes

COMMAND EXECUTED

[15:51:26] ABILIS_CPX:d user:pippo

- Not Saved (SAVE CONF) -------------------------------------------------------
Parameter:          | Value:
--------------------+----------------------------------------------------------
USER:                 pippo
REAL-NAME:            pippo
ID:                   5             <Read Only>
PWD:                  ***
ACT:                  YES                                          
CP-LEVEL:             NO                                           
SSH-IP-PERMIT:        *
TELNET-IP-PERMIT:     *
CTI-ROLE:             EXTENSION
GROUP:                
CTIP:                 #
CTIP-CDI-PERMIT:      *
CLUS:                 #
CLUS-CDI-PERMIT:      *
ADDRBOOK-SYNC:        SYS                                          
ADDRBOOK-NUMBER:      AUTO                                         
ADDRBOOK-OUTDIAL:     NONE                                         
ADDRBOOK-PRIV-MAX:    SYS
ADDRBOOK-PUB-EDITABLE:SYS                                          
IO-MAP:               #
OPC-ROLE:             USER
OPC-VIEW:             *
OPC-HIDE-NUMBERS:     NO
OPC-MONITOR:          SIP
OPC-PRIVACY:          NO
CHAT:                 NO    
CHAT-USER:            SYS
CHAT-PWD:             SYS
FTP:                  YES   
FTP-HOMEDIR:          
FTP-PROT:             PLAIN,SSL
HTTP:                 YES
HTTP-LEVEL:           BASIC
HTTP-HOME-URL:        
HTTP-PROT:            PLAIN,SSL
-------------------------------------------------------------------------------

The following command displays the syntax:

[15:47:53] ABILIS_CPX:s user: ?

S USER[E]:val par:val [par:val]      Set parameter(s) of an entry of the Users
                                     Access Control table

USER[E]:val    User name. Max. 32 ASCII characters.
USER[E]:A      All entries of the Users Access Control table
USER[E]:ALL    All entries of the Users Access Control table

User's parameters:
...


6.8. General and system information		6.10. Address book management