Asterisk
Asterisk Device Driver allows Iotellect Server to monitor health, performance and operability of Asterisk VoIP server. The driver sends commands to Asterisk server and receives responses, the responses are converted to Iotellect's Data Tables.
Driver Information
Driver Plugin ID: | com.tibbo.linkserver.plugin.device.asterisk |
Global Settings
None defined.
User Level Settings
None defined.
Device Account Properties
Connection Properties
Connection settings define how Iotellect Server communicates with a certain Asterisk server. These settings can be accessed using Edit Device Properties action of the Device Context. Here is a list of available connection properties:
Setting | Description |
Address | IP address or host name of the Asterisk server. |
Port | Port of the Asterisk server is running on. |
Login | Login to be used for authorization. |
Password | Password for authorization. |
Timeout | Asterisk server operations timeout. How long driver waits for server answer in milliseconds. |
Asterisk Actions
This property contains a list of actions that will be periodically sent to the Asterisk on every synchronization cycle.
Field | Type | Description |
Send Command | Boolean | Enable/disable sending command on synchronization. |
Asterisk Action | String | List of available to send commands. |
Custom Command | String | Enabled when the "Custom Command" in "Asterisk Action" field is selected. Body of command which will be sent to the Asterisk server. |
Variable Name | String | Enabled when the "Custom Command" in "Asterisk Action" field is selected. Name of "Custom Command" result variable. |
List of available commands:
Action Type | Action Description |
AgentsAction | Requests the state of all agents. |
AgiAction | Adds a new AGI command to execute by the Async AGI application. It will append the application to the specified channel's queue. If the channel is not inside Async AGI application it will return an error. |
CoreShowChannelsAction | Requests the state of all active channels. It is similar to StatusAction but with more information about that channel. |
DbGetAction | Retrieves an entry in the Asterisk database for a given family and key. If an entry is found a DBGetResponseEvent is sent by Asterisk containing the value, otherwise a ManagerError indicates that no entry matches. |
IaxPeerListAction | Retrieves a list of all defined IAX peers. |
ParkedCallsAction | Requests a list of all currently parked calls. |
QueueStatusAction | Requests the state of all defined queues, their members (agents) and entries (callers). |
QueueSummaryAction | Retrieves the summary for one or all queues. |
ShowDialplanAction | Retrieves a list of all priorities defined in the dialplan. |
SipPeersAction | Retrieves a list of all defined SIP peers. |
SipShowRegistryAction | Retrieves a list with the details about the SIP registrations. |
StatusAction | Requests the state of all active channels. Alternatively (in Asterisk 1.6) you can also pass a channel name to retrieve the status of specific channel. |
VoicemailUsersListAction | Retrieves a list of all defined voicemail users. |
ZapShowChannelsAction | Requests the state of all zap channels. |
Custom Command | The CommandAction sends a command line interface (CLI) command to the asterisk server. For a list of supported commands type help on Asterisk's command line. In response to a CommandAction you will receive a CommandResponse that contains the CLI output. |
Device Assets
Assets are not supported by the driver.
Device Settings
This driver creates a separate Device setting variable for each action added to Asterisk Actions table. This variable provides action result.
Device Operations
No operations provided by the driver.
Device Events
No events provided by the driver.
Synchronization Details
Asterisk driver connects to the Asterisk server, sends actions provided by configuration, process response and log off from Asterisk server.
Was this page helpful?