Channels

From Taridium

Revision as of 16:13, 9 December 2008 (view source) Webmaster (Talk | contribs) (→Peer Information Icon) ← Older edit		Revision as of 16:15, 9 December 2008 (view source) Webmaster (Talk | contribs) (→Adding a SIP Channel) Newer edit →
Line 27:		Line 27:
	Click on '''load template''' to load the template settings and change the other settings accordingly.		Click on '''load template''' to load the template settings and change the other settings accordingly.
-	In order to create the appropriate text configuration file four auto-provisioning you will need to either select the MAC address of the phone or select it from your DHCP server. Unused MAC addresses will show up in 'green'.	+	In order to create the appropriate text configuration file four auto-provisioning you will need to either select the MAC address of the phone or select it from your [[wikipedia:DHCP|DHCP]] server. Unused MAC addresses will show up in 'green'.
-	Note that the MAC address needs to be entered when the channel is created and cannot be applied retroactively!	+	Note that the [[wikipedia:MAC_address|MAC]] address needs to be entered when the channel is created and cannot be applied retroactively!
	==== Accountcode ====		==== Accountcode ====

---

Revision as of 16:15, 9 December 2008

Channels specify how an end-point communicates with ipbx.

Contents 1 SIP Channels 1.1 Channel List 1.1.1 Peer Information Icon 1.1.2 Peer Details 1.2 Adding a SIP Channel 1.2.1 Accountcode 1.2.2 Allow Codec 1.2.3 Amaflags 1.2.4 Caller ID Name & Caller ID Number 1.2.5 Callgroup 1.2.6 Can Re-invite 1.2.7 Context 1.2.8 Default IP 1.2.9 DTMF Mode 1.2.10 From User 1.2.11 From Domain 1.2.12 Host 1.2.13 Call Limit 1.2.14 Insecure 1.2.15 Language 1.2.16 Mailbox 1.2.17 MD5 secret 1.2.18 Nat 1.2.19 Permit and Deny 1.2.20 Pickup Group 1.2.21 Port 1.2.22 Qualify 1.2.23 Restrict CID 1.2.24 RTP Timeout 1.2.25 RTP holdtimeout 1.2.26 Secret 1.2.27 Type 1.2.28 Username 1.3 Templates 1.3.1 Device Template Variables 2 IAX Channels 2.1 Channel List 2.1.1 Peer Information Icon 2.1.2 Peer Details 2.2 Adding IAX Channels 2.2.1 Accountcode 2.2.2 Allow Codec 2.2.3 Amaflags 2.2.4 Callgroup 2.2.5 Context 2.2.6 Default IP 2.2.7 Host 2.2.8 Call Limit 2.2.9 Insecure 2.2.10 Language 2.2.11 Mailbox 2.2.12 Permit and Deny 2.2.13 Pickup Group 2.2.14 Port 2.2.15 Qualify 2.2.16 Restrict CID 2.2.17 Secret 2.2.18 Type 2.2.19 Username 2.2.20 Authentication Method 2.2.21 Outkeys 2.2.22 Inkeys 2.3 Templates 2.3.1 Device Template Variables

SIP Channels

The SIP Channel Module enables ipbx to communicate via VOIP with SIP telephones and exchanges. These are usually SIP clients. Trunks and other static end-points are usually configured separately.

Channel List

The SIP channels interface lists all SIP channels that are configured on the system. The system will automatically update the IP address and the expiry time on dynamically registered channels. Move your mouse pointer over the status icon to see more details about the registration.

Peer Information Icon

• Channel registration is ok
• Channel registration has been lost (time-out)
• Channel registration is unknown
• Channel has been setup for NAT

Peer Details

Peer information will display further realtime information on the status of the configured channel.

Adding a SIP Channel

In order to add a SIP channel click on the add channel button at the bottom of the page. Taridium's ipbx supports a powerful templating engine that comes pre-loaded with common SIP phones.

Click on load template to load the template settings and change the other settings accordingly.

In order to create the appropriate text configuration file four auto-provisioning you will need to either select the MAC address of the phone or select it from your DHCP server. Unused MAC addresses will show up in 'green'.

Note that the MAC address needs to be entered when the channel is created and cannot be applied retroactively!

Accountcode

Users may be associated with an accountcode. Keep ‘default’ selected if you are not sure. This must be of the format [mailbox number]@[mailbox context] for complete end-user panel functionality.

Allow Codec

Allow codecs in order of preference (Use Disallow = all first, before allowing other codecs) disallow Disallow all codecs for this peer or user definition.

Amaflags

Categorization for CDR records. Choices are default, omit, billing, documentation.

Caller ID Name & Caller ID Number

Caller ID information used when nothing else is available.

Callgroup

num1,num2-num3 : Defines call groups for calls to this device.

Can Re-invite

If the client is able to support SIP re-invites. Default yes.

Context

If type=user, the Context for the inbound call from this SIP user definition. If type=peer, the Context in the dialplan for outbound calls from this SIP peer definition. If type=friend the context used for both inbound and outbound calls through the SIP entities definition. If no type=user entry matches an inbound call, then a type=peer or type=friend will match if the hostname or IP address defined in host= matches. This is usually set to inside.

Default IP

Dotted.Quad.IP.Addr : Default IP address of client host= is specified as DYNAMIC. Used if client has not been registered at any other IP address. Valid only for type=peer.

DTMF Mode

inband|info|rfc2833|auto : How the client handles DTMF signalling. Default rfc2833.

From User

Specify user to put in "from" instead of callerid (overrides the callerid) when placing calls _to_ peer (another SIP proxy). Valid only for type=peer.

From Domain

Sets default From: domain in SIP messages when placing calls _to_ peer. Valid only when in [general] section or type=peer.

Host

dynamic|hostname|IPAddr : How to find the client - IP # or host name. If you want the phone to register itself, use the keyword dynamic instead of Host IP.

Call Limit

Number : Number of simultaneous calls through this user/peer.

Insecure

very|yes|no|invite|port : Specifies how to handle connections with peers. Default no (authenticate all connections).

Language

A language code defined in Indications - defines language for prompts

Mailbox

Voicemail extension (for message waiting indications). Valid only for type=peer.

MD5 secret

MD5-Hash of "<user>:ipbx:<secret>" (can be used instead of secret)

Nat

yes|no : This variable changes the behaviour of ipbx for clients behind a firewall. This does not solve the problem if ipbx is behind the firewall and the client on the outside.

Permit and Deny

IP address and network restriction

Pickup Group

Group that can pickup fellow workers' calls using *8 and the Pickup() application on the *8 extension

Port

SIP port of the client

Qualify

yes|no|milliseconds : Check if client is reachable. If yes, the checks occur every 2000 milliseconds (2 seconds). Valid only in [general] section and type=peer.

Restrict CID

(yes/no) To have the callerid restricted -> sent as ANI; use this to hide the caller ID.

RTP Timeout

(seconds) Terminate call if x seconds of no RTP activity when we're not on hold. Valid only in [general] section and type=peer.

RTP holdtimeout

(seconds) Terminate call if x seconds of no RTP activity when we're on hold (must be larger than rtptimeout). Valid only in [general] section and type=peer.

Secret

If ipbx is acting as a SIP Server, then this SIP client must login with this Password (A shared secret). If ipbx is acting as a SIP client to a remote SIP server that requires SIP INVITE authentication, then this field is used to authenticate SIP INVITEs that ipbx sends to the remote SIP server.

Type

user|peer|friend: Relationship to client - outbound provider or full client?

Username

<username[@realm]> : If ipbx is acting as a SIP client to a remote SIP server that requires SIP INVITE authentication, then this field is used to authenticate SIP INVITEs that ipbx sends to the remote SIP server. Also, for peers that register with ipbx, this username is used in INVITEs until we have a registration.

Templates

SIP templates are created like channels and have the same parameters. Additionally they feature the Device Configuration section which optionally creates text based device configuration files. The templating engine can create up to two files at two destinations based on files that can uploaded. Your files can contain a number of variables that will be replaced during the channel creation.

Device Template Variables

The Device template can contain the following variables:

•  %%mac%% lower case MAC address
•  %%MAC%% upper case MAC address
•  %%username%%
•  %%secret%%
•  %%accountcode%%
•  %%mailbox%%
•  %%nat%%
•  %%host%%
•  %%callerid%% (caller ID "{name}" <{number}>)
•  %%calleridnum%% (caller ID number only)
•  %%calleridname%% (caller ID name only)
•  %%eth[0-3]%% IP Addresses of eth[0-3] (this server)

IAX Channels

The IAX Channel Module enables ipbx to communicate via VOIP with IAX telephones and exchanges. Only IAX2 communication is supported at this point. Trunks and other static end-points are usually configured separately.

Channel List

The IAX channels interface lists all IAX channels that are configured on the system. The system will automatically update the IP address and the expiry time on dynamically registered channels. Move your mouse pointer over the expiry time to see more details about the registration.

Peer Information Icon

• Channel registration is ok
• Channel registration has been lost (time-out)
• Channel registration is unknown
• Channel has been setup for NAT

Peer Details

Peer information will display further realtime information on the status of the configured channel.

Adding IAX Channels

In order to add a IAXC channel click on the add channel button at the bottom of the page. Taridium's ipbx supports a powerful templating engine that comes pre-loaded with common IAX phones.

Click on load template to load the template settings and change the other settings accordingly.

In order to create the appropriate text configuration file four auto-provisioning you will need to either select the MAC address of the phone or select it from your DHCP server. Unused MAC addresses will show up in 'green'.

Note that the MAC address needs to be entered when the channel is created and cannot be applied retroactively!

Accountcode

Users may be associated with an accountcode. Keep ‘default’ selected if you are not sure. This must be of the format [mailbox number]@[mailbox context] for complete end-user panel functionality.

Allow Codec

Allow codecs in order of preference (Use Disallow = all first, before allowing other codecs) disallow Disallow all codecs for this peer or user definition.

Amaflags

Categorization for CDR records. Choices are default, omit, billing, documentation. Caller ID Name & Caller ID Number Caller ID information used when nothing else is available.

Callgroup

num1,num2-num3 : Defines call groups for calls to this device.

Context

If type=user, the Context for the inbound call from this IAX user definition. If type=peer, the Context in the dialplan for outbound calls from this IAX peer definition. If type=friend the context used for both inbound and outbound calls through the IAX entities definition. If no type=user entry matches an inbound call, then a type=peer or type=friend will match if the hostname or IP address defined in host= matches. This is usually set to inside.

Default IP

Dotted.Quad.IP.Addr : Default IP address of client host= is specified as DYNAMIC. Used if client has not been registered at any other IP address. Valid only for type=peer.

Host

dynamic|hostname|IPAddr : How to find the client - IP # or host name. If you want the phone to register itself, use the keyword dynamic instead of Host IP.

Call Limit

Number : Number of simultaneous calls through this user/peer.

Insecure

yes|no: Specifies how to handle connections with peers. Default no (authenticate all connections).

Language

A language code defined in Indications - defines language for prompts

Mailbox

Voicemail extension (for message waiting indications). Valid only for type=peer.

Permit and Deny

IP address and network restriction

Pickup Group

Group that can pickup fellow workers' calls using *8 and the Pickup() application on the *8 extension

Port

IAX port of the client

Qualify

yes|no|milliseconds : Check if client is reachable. If yes, the checks occur every 2000 milliseconds (2 seconds). Valid only in [general] section and type=peer.

Restrict CID

(yes/no) To have the callerid restricted -> sent as ANI; use this to hide the caller ID.

Secret

If ipbx is acting as an IAX Server, then this IAX client must login with this Password (A shared secret). See also Authentication Method below.

Type

user|peer|friend: Relationship to client – outbound only, provider or full client?

Username

<username> : Username to authenticate IAX clients.

Authentication Method

MD5|RSA|Plaintext : Which method to use for authentication. Default is MD5; Plaintext is not recommended. For RSA usage, see also Outkeys and Inkeys.

Outkeys

The Outkey is a single, private key to use to authenticate to the other side.

Inkeys

If RSA authentication is used, "inkeys" is a list of acceptable public keys on the local system that can be used to authenticate the remote peer, separated by the ":" character.

Templates

IAX templates are created like channels and have the same parameters. Additionally they feature the ‘Device Configuration’ section which optionally creates text based device configuration files. The templating engine can create up to two files at two destinations based on files that can uploaded. Your files can contain a number of variables that will be replaced during the channel creation.

Device Template Variables

The Device template can contain the following variables:

•  %%mac%% lower case MAC address
•  %%MAC%% upper case MAC address
•  %%username%%
•  %%secret%%
•  %%accountcode%%
•  %%mailbox%%
•  %%nat%%
•  %%host%%
•  %%callerid%% (caller ID "{name}" <{number}>)
•  %%calleridnum%% (caller ID number only)
•  %%calleridname%% (caller ID name only)
•  %%eth[0-3]%% IP Addresses of eth[0-3] (this server)