Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »


This is a draft under construction.

CLI Commands

pjsip show endpoints


Shows a tabulated list of all endpoints, with each row displaying attributes related to an endpoint that may be commonly referenced or helpful when administering a system.
The output should be displayed as a tabulated listing of columns and rows, with each row holding information about an individual endpoint, or else additional information about the last endpoint listed.
In the mock up below, we see:
  • content relative to endpoint 6001 listed in a single line.
  • content relative to endpoint 6002 listed in multiple lines, where the two additional lines contain two contact listings in the 7999 AOR which is associated with endpoint 6002.
  • The list ends with a summary of how many Endpoints exist, and then how many are considered online or offline via Qualify responses


Mock Up Output

Name/Auth Username   Dev State   Hint Ext   AORs/Contacts                    Qualify   Active Channels
6001/6001            NOT_INUSE   6001       6001/sip:6001@     35ms     
6002/6002            RINGING     6002       6002/sip:6002@     32ms      <channel name>
                                            7999/sip:7999@     34ms
                                            7999/sip:7999@     35ms
2 Endpoints [Monitored: 2 online, 0 offline Unmonitored: 0 online, 0 offline]



We can only fit so much information here, and there is lots to choose from. This information was selected while thinking about items that you might check while troubleshooting and want to see all in one place.
  • Name/Auth Username -  Endpoint section name/username from associated auth  (how should we differ outbound vs inbound?)
  • Dev State -                      Device state of Endpoint
  • Hint Ext -                         List of hint extensions that this Endpoint is mapped to
  • AORs/Contacts -             List of contacts for each AOR associated with the Endpoint   (how to indicate static vs dynamic/registered)
  • Qualify -                          Response time for each contact, or N/A
  • Active Channels -            List of active channels associated to this endpoint


Ideas for future commands:
"pjsip show endpoints <comma-delimited list of endpoint names>"  (show specified endpoints only, rather than all endpoints, useful for systems with 100's of endpoints)

pjsip show endpoint


In the mock up below, you'll see:
  • Alphabetically sorted list of miscellaneous options and their current values
  • Separate sections below the misc option list for showing info related to other objects associated to the Endpoint. Such as:
    • transport
    • auth
    • aor
    • identify
  • Each separate section should contain a list of options and their related values.
  • Some sections should contain additional information, not represented as "<option> = <value>". This would primarily information that changes during run-time.
    • Examples would be:
    • Static and Registered Contacts for the associated AOR objects (static contacts shouldn't be changing, but it makes sense to display them consistently with a list of registered contacts)
  • "<option> = <value>"  Is used to demonstrate where additional options and values relevant to that section would go.

Mock Up Output

Endpoint Settings
Name                    Value
------                  -------
allowsubscribe        = yes   
allowtransfer         = yes
aors                  = 6002,7999
auth                  = auth1
callerid              = Rusty Newtron <123-456-7890>
callerid_privacy      = allowed
<option>              = <value>

Associated auth Settings
Auth Name             = auth1
username              = somename
password              = 123456789
<option>              = <value>

Associated aor Settings
AOR Name              = 6002
<option>              = <value>
Static Contacts:
Registered Contacts:

AOR Name              = 7999
<option>              = <value>
Static Contacts:
Registered Contacts:



pjsip show registrations


A tabulated listing of all registrations configured in pjsip.conf, where each row shows a single registration and various attributes about that registration.

  • Note that the list ends with a summary of how many total registrations exist, and how many are registered vs not registered.

Mock Up Output

Name       Auth Username   Host                Expiration(sec)   State         Reg.Time                 
mytrunk1   123456789     105               Registered    Wed, 18 Sep 2013 21:59:17
mytrunk2   123456789     105               Registered    Wed, 18 Sep 2013 21:59:16
2 SIP registrations [2 Registered, 0 Not Registered]


  • Name - Name of the registration type section in pjsip.conf
  • Host -  Host address, IP or Domain of the system we are registering to
  • Expiration -  Seconds configured for registration expiry
  • State - Registered, Registering, Not Registered
  • Reg.Time - When the last registration happened for this registration


pjsip show subscriptions


Mock Up Output:

Endpoint      AOR       User             Call ID          Extension        Last state     Type        Mailbox    Expiry
0 active SIP subscriptions



pjsip show settings

blah blah

  • No labels