[asterisk-dev] RFC: pjsip show endpoints output format

[Joshua Colp]

George Joseph wrote:
> On Thu, Nov 7, 2013 at 8:23 AM, Joshua Colp <jcolp at digium.com
> <mailto:jcolp at digium.com>> wrote:
>
>     George Joseph wrote:
>
>         Comments please...
>
>         I tried to balance readability, usefullness, and the fact that the
>         output is a flat representation of a relational model.
>
>         Here's a pastebin if you can't read the output below.
>         http://pastebin.com/JiPKLY3A
>
>
>     My worry about this is that we're giving *too much* information in
>     one command and overloading the person looking at it. Given a large
>     number of endpoints it's now potentially using, well, a lot of lines
>     per endpoint. I think a simplified command that simply gives a list
>     of the endpoints would be nice (in addition to this), and then if
>     more granular info is required by the user they can get the specific
>     endpoint.
>
>     Thoughts?
>
> Yeah, it's a tough call.  From an AMI or ARI perspective, sure I can get
> a list of endpoints, iterate over the list and get each endpoint.  You
> can't ask a human to do that however.  As an administrator, I'm looking
> for a snapshot of the health of the pbx with a minimum of keystrokes,
> not just a list of endpoints.
>
> Maybe it is 2 commands. 'pjsip show endpoints' produces a list, 1 line
> per endpoint with a few choice fields directly related to the endpoint
> object and another command that shows the complex list.
>
> How about 'pjsip list' that does just flat, 1 line lists and 'pjsip
> show' that does complex output?  For example, 'pjsip show endpoint'
> would show detail for a single endpoint and 'pjsip show endpoints' would
> show the complex list?

I think that's even better than the verbose suggestion. "show" implies 
you are showing details about the endpoints as well and "list" implies 
you are listing the endpoints.

-- 
Joshua Colp
Digium, Inc. | Senior Software Developer
445 Jan Davis Drive NW - Huntsville, AL 35806 - USA
Check us out at:  www.digium.com  & www.asterisk.org