[svn-commits] russell: branch russell/LaTeX_docs r58918 - /team/russell/LaTeX_docs/doc/

svn-commits at lists.digium.com svn-commits at lists.digium.com
Wed Mar 14 17:08:23 MST 2007


Author: russell
Date: Wed Mar 14 19:08:23 2007
New Revision: 58918

URL: http://svn.digium.com/view/asterisk?view=rev&rev=58918
Log:
add manager docs

Added:
    team/russell/LaTeX_docs/doc/ajam.tex
      - copied, changed from r58903, team/russell/LaTeX_docs/doc/ajam.txt
    team/russell/LaTeX_docs/doc/manager.tex
      - copied, changed from r58903, team/russell/LaTeX_docs/doc/manager.txt
Removed:
    team/russell/LaTeX_docs/doc/ajam.txt
    team/russell/LaTeX_docs/doc/manager.txt
Modified:
    team/russell/LaTeX_docs/doc/asterisk.pdf
    team/russell/LaTeX_docs/doc/asterisk.tex

Copied: team/russell/LaTeX_docs/doc/ajam.tex (from r58903, team/russell/LaTeX_docs/doc/ajam.txt)
URL: http://svn.digium.com/view/asterisk/team/russell/LaTeX_docs/doc/ajam.tex?view=diff&rev=58918&p1=team/russell/LaTeX_docs/doc/ajam.txt&r1=58903&p2=team/russell/LaTeX_docs/doc/ajam.tex&r2=58918
==============================================================================
--- team/russell/LaTeX_docs/doc/ajam.txt (original)
+++ team/russell/LaTeX_docs/doc/ajam.tex Wed Mar 14 19:08:23 2007
@@ -1,37 +1,38 @@
-Asynchronous Javascript Asterisk Manger (AJAM)
-==============================================
+\subsection{Asynchronous Javascript Asterisk Manger (AJAM)}
 
 AJAM is a new technology which allows web browsers or other HTTP enabled 
 applications and web pages to directly access the Asterisk Manger 
 Interface (AMI) via HTTP.  Setting up your server to process AJAM 
 involves a few steps:
 
-Setup the Asterisk HTTP server
-------------------------------
+\subsubsection{Setup the Asterisk HTTP server}
 
-1) Uncomment the line "enabled=yes" in /etc/asterisk/http.conf to enable
+\begin{enumerate}
+\item Uncomment the line "enabled=yes" in /etc/asterisk/http.conf to enable
    Asterisk's builtin micro HTTP server.
 
-2) If you want Asterisk to actually deliver simple HTML pages, CSS, 
+\item If you want Asterisk to actually deliver simple HTML pages, CSS, 
    javascript, etc. you should uncomment "enablestatic=yes"
 
-3) Adjust your "bindaddr" and "bindport" settings as appropriate for 
+\item Adjust your "bindaddr" and "bindport" settings as appropriate for 
    your desired accessibility
 
-4) Adjust your "prefix" if appropriate, which must be the beginning of
+\item Adjust your "prefix" if appropriate, which must be the beginning of
    any URI on the server to match.  The default is "asterisk" and the 
    rest of these instructions assume that value.
+\end{enumerate}
 
-Allow Manager Access via HTTP
------------------------------
+\subsubsection{Allow Manager Access via HTTP}
 
-1) Make sure you have both "enabled = yes" and "webenabled = yes" setup 
+\begin{enumerate}
+\item Make sure you have both "enabled = yes" and "webenabled = yes" setup 
    in /etc/asterisk/manager.conf
 
-2) You may also use "httptimeout" to set a default timeout for HTTP 
+\item You may also use "httptimeout" to set a default timeout for HTTP 
    connections.
 
-3) Make sure you have a manager username/secret
+\item Make sure you have a manager username/secret
+\end{enumerate}
 
 Once those configurations are complete you can reload or restart 
 Asterisk and you should be able to point your web browser to specific 
@@ -40,7 +41,7 @@
 
 examples:
 
-http://localhost:8088/asterisk/manager?action=login&username=foo&secret=bar
+http://localhost:8088/asterisk/manager?action=login\&username=foo\&secret=bar
 
 This logs you into the manager interface's "HTML" view.  Once you're 
 logged in, Asterisk stores a cookie on your browser (valid for the 
@@ -70,8 +71,7 @@
 
 Note that for the demo, there is no need for *any* external web server.
 
-Integration with other web servers 
----------------------------------- 
+\subsubsection{Integration with other web servers}
 
 Asterisk's micro HTTP server is *not* designed to replace a general 
 purpose web server and it is intentionally created to provide only the 
@@ -83,9 +83,3 @@
 link in your Asterisk micro HTTP server with something like this:
 
 ProxyPass /asterisk http://localhost:8088/asterisk
-
-This is a fairly new technology so I'd love to hear if it's useful for 
-you!
-
-Mark
-

Modified: team/russell/LaTeX_docs/doc/asterisk.pdf
URL: http://svn.digium.com/view/asterisk/team/russell/LaTeX_docs/doc/asterisk.pdf?view=diff&rev=58918&r1=58917&r2=58918
==============================================================================
Binary files - no diff available.

Modified: team/russell/LaTeX_docs/doc/asterisk.tex
URL: http://svn.digium.com/view/asterisk/team/russell/LaTeX_docs/doc/asterisk.tex?view=diff&rev=58918&r1=58917&r2=58918
==============================================================================
--- team/russell/LaTeX_docs/doc/asterisk.tex (original)
+++ team/russell/LaTeX_docs/doc/asterisk.tex Wed Mar 14 19:08:23 2007
@@ -26,24 +26,18 @@
 \section{General Configuration Information}
   \subsection{Configuration Parser}
   \input{configuration.tex}
-
   \subsection{Asterisk.conf}
   \input{asterisk-conf.tex}
-
   \subsection{CLI Prompt}
   \input{cliprompt.tex}
-
   \subsection{Extensions}
   \input{extensions.tex}
-
   \subsection{IP Type of Service}
   \input{ip-tos.tex}
 
 \section{Database Support}
-
   \subsection{Realtime Database Configuration}
   \input{realtime.tex}
-
   \subsection{FreeTDS}
   \input{freetds.tex}
 
@@ -54,16 +48,20 @@
 \input{sla.tex}
 
 \section{Distributed Universal Number Discovery (DUNDi) (tm)}
-\subsection{Introduction}
-\input{dundi.tex}
-\subsection{Peering Agreement}
-\input{PEERING}
+  \subsection{Introduction}
+  \input{dundi.tex}
+  \subsection{Peering Agreement}
+  \input{PEERING}
+
+\section{AMI: Asterisk Manager Interface}
+  \input{manager.tex}
+  \input{ajam.tex}
+
 
 % This is a list of files not yet integrated into this document:
 %
 %Misc
 %----
-%ajam.txt		About the HTTP-based manager interface
 %app_sms.txt		How to configure the SMS application
 %callingpres.txt	Settings for Caller ID presentation
 %billing.txt		Call Data Record information
@@ -89,16 +87,10 @@
 %chaniax.txt		About the IAX2 protocol support in Asterisk
 %localchannel.txt	The local channel is a "gosub" in the dialplan
 %
-%Portability
-%-----------
-%cygwin.txt		Compiling Asterisk on CygWin platforms (Windows)
-%
 %For developers
 %--------------
 %See http://www.asterisk.org/developers for more information
 %
-%manager.txt		About the AMI - Asterisk Manager Interface
-%			for third party call control and PBX management
 %backtrace.txt		How to produce a backtrace when Asterisk crashes
 %CODING-GUIDELINES	Guidelines for developers
 %externalivr.txt	Documentation of the protocol used in externalivr()

Copied: team/russell/LaTeX_docs/doc/manager.tex (from r58903, team/russell/LaTeX_docs/doc/manager.txt)
URL: http://svn.digium.com/view/asterisk/team/russell/LaTeX_docs/doc/manager.tex?view=diff&rev=58918&p1=team/russell/LaTeX_docs/doc/manager.txt&r1=58903&p2=team/russell/LaTeX_docs/doc/manager.tex&r2=58918
==============================================================================
--- team/russell/LaTeX_docs/doc/manager.txt (original)
+++ team/russell/LaTeX_docs/doc/manager.tex Wed Mar 14 19:08:23 2007
@@ -1,5 +1,4 @@
-The Asterisk Manager TCP/IP API - AMI
-=====================================
+\subsection{The Asterisk Manager TCP/IP API}
 
 The manager is a client/server model over TCP. With the manager interface,
 you'll be able to control the PBX, originate calls, check mailbox status,
@@ -21,9 +20,7 @@
 to perform this class of "action", and read represents their ability to 
 receive this class of "event".
 
-The Asterisk manager interface in version 1.0.x of Asterisk is
-not very well standardized. Work is under way to change this 
-to Asterisk 1.2. If you develop AMI applications, treat the headers
+If you develop AMI applications, treat the headers
 in Actions, Events and Responses as local to that particular
 message. There is no cross-message standardization of headers.
 
@@ -31,8 +28,8 @@
 headers and their interpretation. If you are unsure, discuss on
 the asterisk-dev mailing list.
 
-Device status reports
----------------------
+\subsection{Device status reports}
+
 Manager subscribes to extension status reports from all channels,
 to be able to generate events when an extension or device changes
 state. The level of details in these events may depend on the channel
@@ -41,89 +38,30 @@
 subscriptions and call limits)
 
 
-Command Syntax
---------------
+\subsection{Command Syntax}
+
 Management communication consists of tags of the form "header: value", 
-terminated with an empty newline (\r\n) in the style of SMTP, HTTP, and
+terminated with an empty newline (\\r\\n) in the style of SMTP, HTTP, and
 other headers.
 
-
 The first tag MUST be one of the following:
 
-    * Action: An action requested by the CLIENT to the Asterisk SERVER. Only one "Action" may be outstanding at any time.
-    * Response: A response to an action from the Asterisk SERVER to the CLIENT.
-    * Event: An event reported by the Asterisk SERVER to the CLIENT 
-
-
-Manager commands
-----------------
-Output from the CLI command 'show manager' command:
-
-    * Ping: Ping
-    * Logoff: Logoff Manager
-    * Hangup: Hangup Channel
-    * Status: Status
-    * Redirect: Redirect
-    * Originate: Originate Call
-    * MailboxStatus: Check Mailbox
-    * Command: Execute Command
-    * ExtensionState: Check Extension Status
-    * AbsoluteTimeout: Set Absolute Timeout
-    * MailboxCount: Check Mailbox Message Count
-    * Monitor: Monitor a channel
-    * StopMonitor: Stop monitoring a channel
-    * ChangeMonitor: Change monitoring filename of a channel
-    * IAXpeers: List IAX Peers (Defaults to IAX2)
-    * SIPpeers: List SIP peers
-    * SIPshowpeer: Show data about one SIP peer
-    * Queues: Queues
-    * QueueStatus: Queue Status 
-
-This list depends on the version of Asterisk you are using, as
-well as which modules that are loaded.
-
-Command Summary
---------------
-
-Command: Command
-Parameters: Command
-
-Command: ExtensionState
-Parameters: Exten, Context, ActionID
-
-Command: Hangup
-Parameters: Channel
-
-Command: Logoff
-Parameters: None
-
-Command: MailboxCount
-Parameters: Mailbox, ActionID
-
-Command: MailboxStatus
-Parameters: Mailbox, ActionID
-
-Command: Originate
-Parameters: Channel, Exten, Context, Priority, Timeout, 
-   CallerID, Variable, Account, Application, Data, Async
-
-Command: Ping
-Parameters: None
-
-Command: PlayDTMF
-Parameters: Channel, Digit
-
-Command: Redirect
-Parameters: Channel, ExtraChannel, Exten, Context, Priority
-
-Command: Timeout
-Parameters: Channel, Timeout
-
-You can always get more information about a manager command
-with the "show manager command <command>" CLI command in Asterisk.
-
-Examples
---------
+\begin{itemize}
+    \item Action: An action requested by the CLIENT to the Asterisk SERVER. Only one "Action" may be outstanding at any time.
+    \item Response: A response to an action from the Asterisk SERVER to the CLIENT.
+    \item Event: An event reported by the Asterisk SERVER to the CLIENT 
+\end{itemize}
+
+\subsection{Manager commands}
+
+To see all of the available manager commands, use the "manager show commands"
+CLI command.
+
+You can get more information about a manager command
+with the "manager show command <command>" CLI command in Asterisk.
+
+\subsection{Examples}
+\begin{verbatim}
 Login - Log a user into the manager interface.
 
    Action: Login
@@ -159,15 +97,15 @@
   Priority: 1
 
 Where 680 is an extension that sends you to a MeetMe room.
+\end{verbatim}
 
 There are a number of GUI tools that use the manager interface, please search
 the mailing list archives and the documentation page on the 
 http://www.asterisk.org web site for more information.
 
 
-Some standard AMI headers:
---------------------------
-
+\subsection{Some standard AMI headers}
+\begin{verbatim}
  Account: 			-- Account Code (Status)
  AccountCode:			-- Account Code (cdr_manager)
  ACL: <Y | N>			-- Does ACL exist for object ?
@@ -305,6 +243,7 @@
  Value: <value>			-- Value to set
  VoiceMailbox:			-- VM Mailbox in SIPpeers
  Waiting:			-- Count of mailbox messages (mailboxstatus)
+\end{verbatim}
 
  ** Please try to re-use existing headers to simplify manager message parsing in clients.
 



More information about the svn-commits mailing list