voip command

Avaya Logo

voip command

The command line command voip is created for Voice over IP (VoIP) administration. This command allows users to assign, change, display, and unassign values to the VoIP configuration file.

Synopsis

Valid options for voip are:

`assign`	`card=6-15 ip=<card ip address>`
	`gkip=<gatekeeper ip address> [gkpt=0-65535]`
	`[name=<card name>] [en=y\|n]`
	`[lrtp=0-65535][hrtp=0-65535]`
	`[rtcp=y\|n] [rip=<rtcp` `monitor ip address>]`
	`[rpt=0-65535]`
	`[pkt=10\|20\|30\|40\|50\|60] [auth=y\|n]`
	`[cmName=CM name] [maxChans=max chans]`
	`[cmVersion=2.0\|3.0] [MediaEncryption=0\|1]`

`change`	`card=6-15 ip=<card ip address>`
	`[gkip=<gatekeeper ip address>][gkpt=0-65535]`
	`[name=<card name>] [en=y\|n]`
	`[lrtp=0-65535] [hrtp=0-65535]`
	`[rtcp=y[n][rip=<rtcp monitor ip address>]`
	`[rpt=0-65535]`
	`[pkt=10\|20\|30\|40\|50\|60][auth=y\|n]`
	`[cmName=CM name] [maxChans=max chans]`
	`[cmVersion=2.0\|3.0] [MediaEncryption=0\|1]`

`display`	`assignments`
	`card=6-15`

`unassign`	`card=6-15`

Description

The voip assign command creates a configuration file for the specified card. The required parameters are card, ip, and gkip. All parameter values are validated against the allowable parameter values. After a successful validation, all parameters are saved in a configuration file, which is associated with the administered card.

The voip assign command exits with an error message and the usage statement under the following circumstances:

Any required parameter is missing
Any parameter value failed validation
The configuration file for the specified card already exists
A VoIP card is already administered
The parameter rtcp is set to y without specifying a valid rip parameter

The voip change command changes the specified configuration file parameter values for the specified card and creates a backup configuration file. If the configuration file does not exist, or any parameter value failed the field validation, the change command exits with an error message and the usage statement.

The voip display command with the card parameter displays the associated configuration file parameters for the specified card. If the configuration file does not exist, the display command exits with an error message and the usage statement.

The voip unassign command deletes the configuration file, and the backup configuration file, if any, for the specified card.

The voip display assignments command displays all the administered cards.

After the successful execution of voip assign, voip change, and voip unassign commands, an informational message is displayed telling you to stop and restart the voice system to activate the configuration file change.

Arguments and options for voip are described in the following table:

Argument	Description	Comments
card	A number corresponding to a virtual "card" used for VoIP	A number between 6 and 15.
ip	IP address of the IR system	This parameter identifies the network interface card (NIC) that should be used to connect to the packet network. If the Avaya IR system interfaces with a DEFINITY or MultiVantage system, the IP address you enter here should be the same as the one you specify for the IR system on the IP Node Names form.
gkip	The IP address of the MultiVantage C-LAN card	If a DEFINITY or MultiVantage system is functioning as the Gatekeeper, the IP address you enter here should be IP address assigned to the Node Name that represents the C-LAN card on the IP Node Names form.
name	A unique name for the card	Up to 9 characters
en	Indicates whether the card associated with the configuration file is set to handle calls	The default value is y (yes).
hrtp	The highest UDP port to be used for RTP communication	This can be a value between 0 and 65535.
lrtp	The lowest UDP port to be used for RTP communication	This can be a value between 0 and 65535. Look for a range of free ports. The 9000 -10000 range is usually free.
pkt	The RTP packet payload size in milliseconds for outgoing calls	This can be 10, 20, 30, 40, 50, or 60.
rtcp	Enables sending copies of RTCP packets to a VoIP Monitoring Manager for monitoring of audio quality	If set to n (no), copies of RTCP packets are not generated by the VoIP card.
rip	The IP address of the RTCP monitor to which copies of RTCP packets should be sent	—
rpt	The port used by the RTCP monitor to receive copies of the RTCP packets	This can be a value between 0 and 65535.
auth	This field controls VoIP station authentication with the Gatekeeper.	This value can be set to yes or no.
cmName	A unique name upto 20 characters long.	The default name is in the CM# format, where # represents the card number that is being configured.
maxChans	The number of ports that you want to assign to the card that is being configured.	This field can accept 1 to 3 digit values. The default value is 93.
cmVersion	The version of Avaya Communication Manager that you are currently using.	Select the correct version number (2.0 or 3.0) from the drop-down list.
MediaEncryption	This field controls the encryption of VoIP media signaling streams.	This value can be set to Disabled or Enabled (0 or 1). The default value should be 0