nms command

Avaya Logo

nms command

The commands nms assign, nms change, nms display, and nms unassign let you administer digital protocols on the NMS telephony cards.

Synopsis

`nms assign`	`card=<card #> protocol=prit1\|prie1\|loopt1\|loope1\|winkt1\|r2mfce1`
	`trunks=1[,2][,3][,4]enabledchannels=<0 to 128>`
	`priside=USER[NETWORK]`
	`[frametype=D4\|ESF\|CEPT] [linecode=AMI\|AMI_ZCS\|B8ZS\|HDB3] [crc=0-15]`
	`[idlecode=01010100\|01010101\|11111111] [length=0-655] [fax=y\|n]`
	`[isdntype=4ess\|5ess\|nortel\|national\|ntt\|etsi\|qsig]`
	`[clktrunk=1\|2\|3\|4] [clkfallback=1\|2\|3\|4\|none]`
	`[clksrc=NETWORK\|OSC] [clkmode=STANDALONE]`
	`[country=arg\|bra\|can\|chl\|chn\|col\|deu\|fra\|gbr\|hkg\|idn\|ind\|irl\|ita\|jpn\|kor\|mex\|mys\|phl\|sel\|sgp\|tha\|usa]`
	`[dchannel1=y\|n] [dchannel2=y\|n] [dchannel3=y\|n] [dchannel4=y\|n]`
	`[overlap_rcv_to=0-14] [overlap_rcv_dnis=0-30]`
	`[mfc_did_digs=0-30] [mfc_ani_digs=0-30]`
	`[wnk_num_digs=0-30]`
	`[blockwaittime=millisecs]`
	`[ccb_method=none\|doubleanswer\|groupIIsig8]`
	`[wink_delay=500-1500] [wink_duration=500-2500]`
	`[impedance=120\|75]`

`nms change`	`card=<card #>`
	`trunks=1[,2][,3][,4]` `protocol=prit1\|prie1\|loopt1\|loope1\|winkt1\|r2mfce1`
	`[frametype=D4\|ESF\|CEPT] [linecode=AMI\|AMI_ZCS\|B8ZS\|HDB3] [crc=0-15]`
	`[idlecode=01010100\|01010101\|11111111] [length=0-655] [fax=y\|n]`
	`[isdntype=5ess\|nortel\|national\|ntt\|etsi\|qsig]`
	`[clktrunk=1\|2\|3\|4] [clkfallback=1\|2\|3\|4\|none]`
	`[clksrc=NETWORK\|OSC] [clkmode=STANDALONE]`
	`[country=arg\|bra\|can\|chl\|chn\|col\|deu\|fra\|gbr\|hkg\|idn\|ind\|irl\|ita\|jpn\|kor\|mex\|mys\|phl\|sel\|sgp\|tha\|usa]`
	`[dchannel1=y\|n] [dchannel2=y\|n] [dchannel3=y\|n] [dchannel4=y\|n]`
	`[overlap_rcv_to=0-14] [overlap_rcv_dnis=0-30]`
	`[mfc_did_digs=0-30] [mfc_ani_digs=0-30]`
	`[wnk_num_digs=0-30]`
	`[blockwaittime=millisecs]`
	`[ccb_method=doubleanswer\|groupIIsig8\|none]`
	`[wink_delay=500-1500] [wink_duration=500-2500]`
	`[impedance=120\|75]`

`nms display`	`assignments`
	`card=<card #>`

`nms unassign`	`card=<card #>`

Description

The following table describes the arguments for these commands:

Argument	Description	Comments
`card`	A number that identifies a telephony card	—
`protocol`	The digital protocol used on the card	Options include: prit1 (ISDN-PRI T1), prie1 (ISDN-PRI E1), loopt1 (Loop Start T1), loope1 (Loop Start E1), and winkt1 (Wink Start T1), and r2mfce1 (R2MFC) For DID and ANI, R2MFC options include: mfc_did_digs (anticipated number of DID digits), mfc_ani_digs (anticipated number of DID digits). Up to 30 digits may be specified. Note: Whenever possible, match the number of digits specified to the number that will actually be received. If fewer digits are received that what is specified, long pauses may occur before the call receives a response.
`trunks`	The number of trunks present on the telephony card.	—
`enabledchannels`	The number of channels that have been enabled.	Values from 0-128
`priside`	The side from which you want the PRI protocol to function.	Set it to user if you want your Avaya DEFINITY or MultiVantage system to behave as the network. Set it to network if you want your Avaya DEFINITY or MultiVantage system to behave as the user.
`frametype`	The frame format	—
`linecode`	A replacement for strings of consecutive zeros in data transmission using pulse code modulation (PCM)	Options include AMI, AMI_ZCS, and B8ZS for ISDN-PRI T1
`idlecode`	The code used in digital communications that represents an absence of data	Options include 11111111, 01010100, and 01010101
`crc`	Cyclical Redundancy Checking (CRC) is an error checking technique that is used to ensure the accuracy of digital transmissions over a communications link.	Values from 0 to 15. Applies only to ISDN-PRI E1, Loop Start E1, and R2 MFC E1. See the following table for the binary equivalent for each decimal value. The binary equivalents represent the sixteen possible values of CRC enabled or disabled for as many as four E1 trunks.
`length`	The length of the cable between the telephony board and the telephone network	This value should only be changed if the length is more than 200 feet or if there are transmission problems. Applies only to T1.
`fax`	Whether or not fax is enabled	—
`isdntype`	The type of the ISDN service	Applies only to ISDN-PRI T1 and E1. Options include 4ess, 5ess, nortel, national, ntt, etsi, and qsig.
`clktrunk`	The trunk that the card uses to set its internal clock	Options include 1, 2 (for dual port cards); 1, 2, 3, 4 (for quad port cards).
`clkfallback`	The trunk that the system uses to set its internal clock if the timing source on clktrunk stops working	At least 2 trunks must be connected to the card, with one being the clktrunk. The card uses the clktrunk source again when that source starts working. Options include none, 1, 2 (for dual port cards); none, 1, 2, 3, 4 (for quad port cards).
`clksrc`	The origin of the telephony board's clock reference	OSC refers to the telephony board's oscillator, and NETWORK refers to the clock extracted from the telephony trunk.
`clkmode`	If the telephony board only controls its own clock, then the mode is STANDALONE.	STANDALONE is the only option
`country`	Country where the system is located	Argentina (arg)`,` Brazil (bra), Canada (can), Chile (chl), China (chn), Colombia Telecom (col), Germany (deu), France (fra), Great Britain (gbr), Hong Kong (hkg), Indonesia (idn), India (ind), Ireland (irl), Italy (ita), Japan (jpn), Korea (kor), Mexico (mex), Malaysia (mys), Philippines (phl), Colombia Comsel (sel), Singapore (sgp), Thailand (tha), United States (usa)
`dchannel1`	Whether or not a data channel is available on Trunk 1	Applies only to ISDN-PRI T1 and E1.
`dchannel2`	Whether or not a data channel is available on Trunk 2	Applies only to ISDN-PRI T1 and E1.
`dchannel3`	Whether or not a data channel is available on Trunk 3	Applies only to ISDN-PRI T1 and E1.
`dchannel4`	Whether or not a data channel is available on Trunk 4	Applies only to ISDN-PRI T1 and E1.
`overlap_rcv_to`	Number of milliseconds that the system waits to answer an incoming call	Values from 0 to 14. Applies only to ISDN-PRI E1.
`overlap_rcv_dnis`	Expected number of DNIS digits	Values from 0 to 30. Applies only to ISDN-PRI E1.
`mfc_did_digs`	Number of allowable DID digits	Values from 1 to 30. Applies only to R2 MFC E1.
`mfc_ani_digs`	Number of allowable ANI digits	Values from 0 to 30. Applies only to R2 MFC E1.
`wnk_num_digs`	Number of digits for ANI/DNIS	Values from 0 to 30. Applies only to Wink Start T1.
`blockwaittime`		Values are expressed in millisecs.
`ccb_method`	Collect call blocking method	Options include: none, doubleanswer (double answer), groupIIsig8 (group II signal 8). The ccb_method argument can be used only if the country argument is set to bra (Brazil).
`wink_delay`	Double answer wink delay. Number of milliseconds from when the incoming call was answered until the start of the wink (hang up or on-hook).	Values are expressed in millisecs within the range 500 to 1500. The wink_delay argument can be used only if the ccb_method argument is set to doubleanswer.
`wink_duration`	Double answer wink duration (in milliseconds).	Values are expressed in millisecs within the range 500 to 2500. The wink_duration argument can be used only if the ccb_method argument is set to doubleanswer.
`impedance`	Specifies the termination impedance for E1 lines. The value that you specify should match the impedance of the E1 trunk interface cables that are connected to the AG4040 board.	Values 120, 75. Applies only to the NMS AG4040 T1/E1 telephony card administered as ISDN-PRI E1 the with isdntype argument set to qsig.

The following table lists the binary equivalent and description for each decimal CRC value.

Decimal value	Binary value	Description
0	0000	CRC disabled for trunks 1, 2, 3, and 4.
1	0001	CRC enabled for trunk 1, disabled for trunks 2, 3, and 4.
2	0010	CRC enabled for trunk 2, disabled for trunks 1, 3, and 4.
3	0011	CRC enabled for trunks 1 and 2, disabled for trunks 3 and 4.
4	0100	CRC enabled for trunk 3, disabled for trunks 1, 2, and 4.
5	0101	CRC enabled for trunks 1 and 3, disabled for trunks 2 and 4.
6	0110	CRC enabled for trunk 2 and 3, disabled for trunks 1 and 4.
7	0111	CRC enabled for trunk 1, 2, and 3, disabled for trunk 4.
8	1000	CRC enabled for trunk 4, disabled for trunks 2, 3, and 4.
9	1001	CRC enabled for trunks 1 and 4, disabled for trunks 2 and 3.
10	1010	CRC enabled for trunks 2 and 4, disabled for trunks 1 and 3.
11	1011	CRC enabled for trunks 1, 2, and 4, disabled for trunk 3.
12	1100	CRC enabled for trunks 3 and 4, disabled for trunks 1 and 2.
13	1101	CRC enabled for trunks 1, 3, and 4, disabled for trunk 2.
14	1110	CRC enabled for trunks 2, 3, and 4, disabled for trunk 1.
15	1111	CRC enabled for trunks 1, 2, 3, and 4.

The nms assign command creates a configuration file, which is created by copying default parameters for the specified protocol to the configuration file, except for any parameters that have been entered on the command line. Any command-line parameters are copied to the configuration file. The nms assign command exits with a usage error if an assign is attempted for a card that already has a configuration file. If the card does not exist, the command exits with a usage error.

The nms change command changes configuration file parameters for the card. The protocol associated with the change command is determined from the existing configuration file for that card. If the configuration file does not exist, the change command exits with a usage error.

Note:
The nms assign and nms change commands issue an error message if you enter y for any of the dchannel arguments when using the protocol prie1, since NFAS is not supported for the prie1 protocol.

The nms display command, with a card parameter, displays the protocol and all of the administrable fields for that protocol for the card.

The nms unassign command deletes the configuration file, and the backup configuration file, if any, for the specified card. (The backup configuration file, that adds .bak to the configuration file name, is created if one or more nms change commands are executed for the card after it has been assigned.)

The nms display assignments command displays the cards and associated protocols for every card that has a configuration file.

Files

The following file is associated with the nms command:

/vs/data/NMS_Bx.cfg (where x is the card number)