presClients

Last Updated : Oct 28, 2020 |
Prolog information
This command is used to:
  • List all users or devices logged in to the Presence Services instance.
  • Display current presence document (PIDF) for online and offline users.
  • Take actions on the subscriptions for logged-in users.

Syntax

presClients [-h] [-u <login_name>] [-m {SIP|XMPP}] [-i <client_ip> ] [-n <ps_node>] [-t|-r|--resend-list[<list_name>]] [-p]
Options:
  • -u <login_name>: Avaya user login name.
  • -m {SIP|XMPP}: Device communication protocol.
  • -i <client_ip>: Device IP address.
  • -n <ps_node>: Presence Services address (IP or FQDN).
Actions (must specify a filter):
  • -r: Resend Notify(s) or stanza(s) with full PIDF to watcher for all active or non-list presence event subscriptions.
  • --resend-list [list_name]: Resend Notify(s) with full PIDF to watcher for each presentity in the active list subscription (SIP devices only).
  • -t [restart | disable]: Terminate active subscriptions or connections to the device. SIP devices receive a termination Notify to all active subscriptions.
    • restart: Client may resubscribe immediately
    • disable: Client must not resubscribe until logging out and logging in.
    XMPP endpoints receive a XMPP Stream closure stanza.
  • -p [tuples]: Display current presence document (PIDF) of the user. This action can be used only with the -u filter.

Sample output 1

# presClients
Active Presence Server Client Connections
Cluster :  cluster-185
Nodes : 32646=192.0.2.10,32648=198.51.100.10
Active Publish & Subscriptions(node/expires remaining)
         User              IP Address        Mode          User-Agent/Resource           Last Publish Time      Publish     Self         Winfo        Acl          list(s)
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  2600002@avaya.com | 192.0.10.111:60269 |   SIP |            Avaya one-X Communicator |  2015-09-30 17:49:17 |  32648/369 |  32648/1568 |  32648/1568 |  32648/1568 | default( 32648/1568)
  2600003@avaya.com | 192.0.10.155:60834 |   SIP |                  Avaya Flare Engine |  2015-09-30 18:42:58 |  32646/3589 |  32646/4788 |  32646/4788 |     -/-  |      -/-

Sample output 2

# presClients -u 2600002@avaya.com -p
Active Presence Server Client Connections
      userid       |      ipaddress      |   lastpublishtime
-------------------+---------------------+---------------------
2600002@avaya.com | 198.51.100.101:52308 | 2016-02-26 15:45:11
PIDF:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<presence entity="pres:2600002@yash.ps.avaya.com" xmlns="urn:ietf:params:xml:ns:pidf" xmlns:avav="urn:avaya:com:presence:rpid:availability" xmlns:avcl="urn:avaya:com:PS:rpid:vclass" xmlns:pscaps="urn:com:avaya:pidf:servcaps:ps" xmlns:d="urn:ietf:params:xml:ns:pidf:data-model" xmlns:caps="urn:ietf:params:xml:ns:pidf:caps" xmlns:r="urn:ietf:params:xml:ns:pidf:rpid" xmlns:apas="urn:com:avaya:pidf:rpid:extended" xmlns:cc="urn:com:avaya:presence:cc">
<tuple id="enterprise-im_b137287c-bdc2-5c3a-92a1-06d7628eea5d">
<status>
<basic>open</basic>
</status>
<r:class>Enterprise IM</r:class>
<avcl:vClass>Avaya.1XC</avcl:vClass>
<r:activities>
<avav:available/>
</r:activities>
<contact>2600002@yash.ps.avaya.com</contact>
<timestamp>2016-02-26T10:45:11.112-05:00</timestamp>
</tuple>
<tuple id="video_b137287c-bdc2-5c3a-92a1-06d7628eea5d">
<status>
<basic>closed</basic>
</status>
<r:class>Video</r:class>
<avcl:vClass>Avaya.1XC</avcl:vClass>
<r:activities>
<avav:offline/>
</r:activities>
<contact>sips:2600002@avaya.com</contact>
<timestamp>2016-02-26T10:45:11.111-05:00</timestamp>
</tuple>
<tuple id="phone_b137287c-bdc2-5c3a-92a1-06d7628eea5d">
<status>
<basic>open</basic>
</status>
<r:class>Phone</r:class>
<apas:extended-state>
<apas:phonestate>
<apas:onhook/>
</apas:phonestate>
</apas:extended-state>
<avcl:vClass>Avaya.1XC</avcl:vClass>
<r:activities>
<avav:available/>
</r:activities>
<contact>sips:2600002@avaya.com</contact>
<timestamp>2016-02-26T10:45:11.111-05:00</timestamp>
</tuple>
<d:person id="ps_generated">
<r:activities>
<avav:available/>
</r:activities>
<avav:availabilityDescription>
<avav:component type="overall-presence-state"/>
</avav:availabilityDescription>
</d:person>
</presence>