New actions should go under "New Actions", not "new events"
[asterisk/asterisk.git] / doc / manager_1_1.txt
index 6feede7..5a674e5 100644 (file)
@@ -1,6 +1,12 @@
 Changes to manager version 1.1:
 -------------------------------
 
 Changes to manager version 1.1:
 -------------------------------
 
+- Action: IAXregistry
+       Modules: chan_iax2
+       Purpose:
+               To list all IAX2 peers in the IAX registry with their registration status.
+       Variables:
+         ActionID: <id>                Action ID for this transaction. Will be returned.
 
 * SYNTAX CLEANUPS
 -----------------
 
 * SYNTAX CLEANUPS
 -----------------
@@ -119,6 +125,14 @@ Changes to manager version 1.1:
        If you call out to a subshell in Originate with the Application parameter,
                you now also need the System privilege.
 
        If you call out to a subshell in Originate with the Application parameter,
                you now also need the System privilege.
 
+- Event QueueEntry now also returns the Uniqueid field like other events from app_queue.
+
+- Action IAXpeerlist
+       Now includes if the IAX link is a trunk or not
+
+- Action IAXpeers
+       Now includes if the IAX link is a trunk or not
+
 * NEW ACTIONS
 -------------
 - Action: ModuleLoad
 * NEW ACTIONS
 -------------
 - Action: ModuleLoad
@@ -187,7 +201,87 @@ Changes to manager version 1.1:
                Priority: The priority to transfer to
                Context: The context to transfer to
 
                Priority: The priority to transfer to
                Context: The context to transfer to
 
+- Action: SipShowRegistry
+       Modules: chan_sip
+       Purpose:
+               To request that the manager send a list of RegistryEntry events.
+       Variables:
+         ActionId: <id>                Action ID for this transaction. Will be returned.
+
+- Action: QueueReload
+       Modules: app_queue
+       Purpose:
+               To reload queue rules, a queue's members, a queue's parameters, or all of the aforementioned
+       Variable:
+               Queuename: <name> The name of the queue to take action on. If no queue name is specified, then all queues are affected
+               Rules: <yes or no> Whether to reload queue_rules.conf
+               Members: <yes or no> Whether to reload the queue's members
+               Parameters: <yes or no> Whether to reload the other queue options
+
+- Action: QueueReset
+       Modules: app_queue
+       Purpose:
+               Reset the statistics for a queue
+       Variables:
+               Queuename: <name> The name of the queue on which to reset statistics
+
+- Action: SKINNYdevices
+       Modules: chan_skinny
+       Purpose:
+               To list all SKINNY devices configured.
+       Variables:
+               ActionId: <id> Action ID for this transaction. Will be returned.
+
+- Action: SKINNYlines
+       Modules: chan_skinny
+       Purpose:
+               To list all SKINNY lines configured.
+       Variables:
+               ActionId: <id> Action ID for this transaction. Will be returned.
+
+- Action SKINNYshowdevice
+       Modules: chan_skinny
+       Purpose:
+               To list the information about a specific SKINNY device.
+       Variables:
+               Device: <device> Device to show information about.
+
+- Action SKINNYshowline
+       Modules: chan_skinny
+       Purpose:
+               To list the information about a specific SKINNY line.
+       Variables:
+               Line: <line> Line to show information about.
+
+- Action: CoreSettings
+       Modules: manager.c
+       Purpose: To report core settings, like AMI and Asterisk version,
+               maxcalls and maxload settings.
+               * Integrated in SVN trunk as of May 4th, 2007
+       Example:
+               Response: Success
+               ActionID: 1681692777
+               AMIversion: 1.1
+               AsteriskVersion: SVN-oej-moremanager-r61756M
+               SystemName: EDVINA-node-a
+               CoreMaxCalls: 120
+               CoreMaxLoadAvg: 0.000000
+               CoreRunUser: edvina
+               CoreRunGroup: edvina
+
+- Action: CoreStatus
+       Modules: manager.c
+       Purpose: To report current PBX core status flags, like
+               number of concurrent calls, startup and reload time.
+               * Integrated in SVN trunk as of May 4th, 2007
+       Example:
+               Response: Success
+               ActionID: 1649760492
+               CoreStartupTime: 22:35:17
+               CoreReloadTime: 22:35:17
+               CoreCurrentCalls: 20
 
 
+               
 * NEW EVENTS
 ------------
 
 * NEW EVENTS
 ------------
 
@@ -229,34 +323,6 @@ Changes to manager version 1.1:
                SIPcallid: NTQzYWFiOWM4NmE0MWRkZjExMzU2YzQ3OWQwNzg3ZmI.
                SIPfullcontact: sip:olle@127.0.0.1:49054
 
                SIPcallid: NTQzYWFiOWM4NmE0MWRkZjExMzU2YzQ3OWQwNzg3ZmI.
                SIPfullcontact: sip:olle@127.0.0.1:49054
 
-- Action: CoreSettings
-       Modules: manager.c
-       Purpose: To report core settings, like AMI and Asterisk version,
-               maxcalls and maxload settings.
-               * Integrated in SVN trunk as of May 4th, 2007
-       Example:
-               Response: Success
-               ActionID: 1681692777
-               AMIversion: 1.1
-               AsteriskVersion: SVN-oej-moremanager-r61756M
-               SystemName: EDVINA-node-a
-               CoreMaxCalls: 120
-               CoreMaxLoadAvg: 0.000000
-               CoreRunUser: edvina
-               CoreRunGroup: edvina
-
-- Action: CoreStatus
-       Modules: manager.c
-       Purpose: To report current PBX core status flags, like
-               number of concurrent calls, startup and reload time.
-               * Integrated in SVN trunk as of May 4th, 2007
-       Example:
-               Response: Success
-               ActionID: 1649760492
-               CoreStartupTime: 22:35:17
-               CoreReloadTime: 22:35:17
-               CoreCurrentCalls: 20
-
 - Event: NewAccountCode
        Modules: cdr.c
        Purpose: To report a change in account code for a live channel
 - Event: NewAccountCode
        Modules: cdr.c
        Purpose: To report a change in account code for a live channel
@@ -307,6 +373,37 @@ Changes to manager version 1.1:
                MemberName: Thaddeus McClintock
                Ringtime: 10
 
                MemberName: Thaddeus McClintock
                Ringtime: 10
 
+- Event: RegistryEntry
+       Modules: chan_sip
+       Purpose: Reports the state of the SIP registrations. This event is generated by
+                issuing a QueueSummary AMI action.
+               The RegistrationTime header is expressed as epoch.
+       Example:
+               Event: RegistryEntry
+               Host: sip.myvoipprovider.com
+               Port: 5060
+               Username: guestuser
+               Refresh: 105
+               State: Registered
+               RegistrationTime: 1219161830
+       If an actionID was specified for the SipShowRegistry action, it will be appended as the
+       last line of the RegistrationsComplete event.
+
+- Event: ChanSpyStart
+       Modules: app_chanspy
+       Purpose: Reports when an active channel starts to be monitored by someone.
+       Example:
+               Event: ChanSpyStart
+               SpyerChannel: SIP/4321-13bba124
+               SpyeeChannel: SIP/1234-56ecc098
+
+- Event: ChanSpyStop
+       Modules: app_chanspy
+       Purpose: Reports when an active channel stops to be monitored by someone.
+       Example:
+               Event: ChanSpyStop
+               SpyeeChannel: SIP/1234-56ecc098
+
 * TODO
 ------
 
 * TODO
 ------