Lucent Technologies Audix Administration And Data Acquisition Guide

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-135 getspfea 
12
Outp ut for the getspfea
 c ommand  with the -f hour
 op tion when c ommunic ating  
with an R1 AUDIX (using  SL1 switc h integration) system is formatted  as follows, 
with one rec ord for eac h hour.
14 outc alls attempted N 8 r1v4+
15 outc alls c ompleted N 8 r1v4+
16 outc alls resc heduled N 8 r1v4+
FIELD       VOICE MAIL VERSIONS
Seq. 
No.Field Name TypeMax.
WidthR1
AUDIX
System 
DEFINITY
AUDIX
SystemI
NTUITYAUDIX
System
1 starting date D 8 r1v4+
2 starting  hour N 2 r1v4+
3 end ing  time T 4 r1v4+
4 avg  numb er of integ rated  ports in use N 2.1 r1v4+
5 maximum simultaneous integ rated  p orts N 2 r1v4+
6 avg  numb er of AA 1 ports in use N 2.1 r1v4+
7 maximum simultaneous AA 1 p orts N 2 r1v4+
8 avg  numb er of AA 2 ports in use N 2.1 r1v4+
9 maximum simultaneous AA 2 p orts N 2 r1v4+
10 avg  numb er of AA 3 ports in use N 2.1 r1v4+
11 maximum simultaneous AA 3 p orts N 2 r1v4+
12 avg  numb er of non-integ rated  p orts in use N 2.1 r1v4+
13 max simultaneous non-integ rated  ports N 2 r1v4+
14 maximum simultaneous outc alls N 2 r1v4+
15 outc alls attempted N 8 r1v4+
16 outc alls c ompleted N 8 r1v4+
17 outc alls resc heduled N 8 r1v4+
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX
SystemDEFINITY
AUDIX
System I
NTUITY 
AUDIX
System 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-136 getspfea 
12
Example 
The following c ommand retrieves the INTUITY and  DEFINITY AUDIX List Measure-
ments Sp ec ial-Features Day sc reen d ata for Dec emb er 12, 1994, writes a 
summary of the transfer statistic s to the sc reen, and writes outp ut to a file named  
daylds. 
getspfea -f day -d 121294 -v > daylds 
The following data is written to the file: 
19941212,2359,0.0,0,0.0,0,0.0,0,0,0,0,0,0 
The following c ommand retrieves the R1 AUDIX R1V8 traffic  : sp ec ial features : 
d ay sc reen d ata for Dec emb er 12, 1994, writes a summary of the transfer 
statistic s to the sc reen, and  writes outp ut to a file named  d ayld s when the switc h 
c onnec tion is DCIU. 
getspfea -f day -d 121294 -s dciu-sci -r r1v8 v > daylds 
The following data is written to the file: 
19941212,2359,0.0,0,0.0,0,0.0,0,0,0,0,0,0 
RETURN
NEWLINE
RETURN
NEWLINE 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-137 getsub 
12
getsub
Get loc al sub sc rib er d ata 
Syntax 
getsub
 [-r release] [-v
] [-w
] [-V
] [-i
] [< ifile] [> ofile] 
Description 
This c ommand  retrieves the following  sc reens for the sp ec ified  sub sc rib er(s): 
nINTUITY AUDIX Disp lay Sub sc rib er 
nDEFINITY AUDIX Disp lay Sub sc rib er 
nR1 AUDIX sub sc rib er : loc al
Use sub sc rib er extensions as inp ut. Retrieved d ata is written to stand ard outp ut. 
-r
Release flag : must b e followed  b y 
release. 
release Retrieves d ata for the sp ec ified  release of the I
NTUITY AUDIX, 
DEFINITY AUDIX, or R1 AUDIX System software. The d efault for the 
DEFINITY AUDIX System is D-r3.2. The d efault for the I
NTUITY 
AUDIX System is I-r5.0.
-v
Writes transfer statistic s to the sc reen at the end  of the transfer. 
Unless -i
 is sp ec ified , p ressing  v
 while the c ommand  is exec uting  
send s the up d ated transfer status to the sc reen. 
-w
Writes a one-line summary of the exit status of this c ommand  into 
the file, form_req.rc
. 
-V
Writes the ADAP version numb er for this c ommand  and  exits 
without transferring  any sc reens data. 
-i
Turns off the searc h for p ossib le sub seq uent entry of the v
 and  q
 
(quit) options. Otherwise, if you typ e ahead , you may lose 
characters. 
If you d on’t sp ec ify -i
, you must sp ec ify an inp ut file (
<  ifile) from 
whic h the extensions will b e read .  
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-138 getsub 
12
Errors 
If the extension does not b elong  to a valid  voic e mail system subsc riber, an error 
messag e ap p ears, g iving  the rec ord  numb er c ontaining  the invalid  extension. If 
more rec ord s exist, retrieval c ontinues. 
Input Format 
The inp ut format for getsub
 c onsists of one rec ord  for eac h sub sc rib er:  <  ifile Sp ec ifies the name of an inp ut file you have c reated . The filename 
must be preceded by the symbol   ofile Sp ec ifies the name of the file to whic h d ata will b e written. The 
filename must b e p rec ed ed  by the symb ol > . If no outp ut file is 
sp ec ified , data is written to the sc reen. 
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX
System 
DEFINITY
AUDIX
SystemI
NTUITY
AUDIX
System
1 extension K 10 r1v2+ D-r1.0+ I-r2.0+ 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-139 getsub 
12
Output Format
Outp ut for getsub
 for INTUITY AUDIX, DEFINITY AUDIX, and  AUDIX (R1V4 and  
b eyond ) Systems is formatted  as follows, one rec ord  for eac h sub sc rib er
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX
System 
DEFINITY
AUDIX
SystemI
NTUITYAUDIX
System
1 name C 29 r1v4+ D-r1.0+ I-r2.0+
2 extension K 10 r1v4+ D-r1.0+ I-r2.0+
3 c lass of servic e C 8 r1v4+ D-r1.0+ I-r2.0+
4 password K 15 r1v4+ D-r1.0+ I-r2.0+
5 switc h number N 2 r1v4+ D-r1.0+ I-r2.0+
6 misc ellaneous 1 C 11 r1v4+ D-r1.0+ I-r2.0+
7 c overing  extension K 10 r1v4+ D-r1.0+ I-r2.0+
8 ad dressing  format C 9 r1v4+ D-r1.0+ I-r2.0+
9 CA p ermissions C 14 r1v4+ D-r1.0+ I-r2.0+
10 announc ement c ontrol C 1 r1v4+ D-r1.0+ I-r2.0+
11 outc alling L 1 r1v4+ D-r1.0+ I-r2.0+
12 text servic e mac hine C 10 r1v4+ D-r1.0+ I-r2.0+
13 user id C 30 r1v4+ D-r1.0+ I-r2.0+
14 inc oming  mailb ox LIFO/FIFO C 4 r1v4+ D-r1.0+ I-r2.0+
15 inc oming  mailb ox ord er C 3 r1v4+ D-r1.0+ I-r2.0+
16 new retention time N 3 r1v4+ D-r1.0+ I-r2.0+
17 old retention time N 3 r1v4+ D-r1.0+ I-r2.0+
18 unop ened retention time N 3 r1v4+ D-r1.0+ I-r2.0+
19 outg oing  mailb ox LIFO/FIFO C 4 r1v4+ D-r1.0+ I-r2.0+
20 outg oing  mailb ox ord er C 5 r1v4+ D-r1.0+ I-r2.0+
21 file c abinet retention time N 3 r1v4+ D-r1.0+ I-r2.0+
22 del/non del retention time N 3 r1v4+ D-r1.0+ I-r2.0+
23 max VM messag e leng th N 4 r1v4+ D-r1.0+ I-r2.0+
24 min VM spac e req uired N 4 r1v4+ D-r1.0+ I-r2.0+
25 max CA messag e length N 4 r1v4+ D-r1.0+ I-r2.0+
26 min CA sp ac e required N 4 r1v4+ D-r1.0+ I-r2.0+
27 max number of mailing  lists N 3 r1v4+ D-r1.0+ I-r2.0+
28 max total mailing list entries N 5 r1v4+ D-r1.0+ I-r2.0+
29 max mailb ox size N 5 r1v4+ D-r1.0+ I-r2.0+
30 guaranteed  sp ac e N 4 r1v4+ D-r1.0+ I-r2.0+
31 new sub sc rib er name C 29 r1v4+ D-r1.0+ I-r2.0+
32 new extension K 10 r1v4+ D-r1.0+ I-r2.0+
33 loc ked C 1 r1v4+ D-r1.0+ I-r2.0+
34 c ommunity id N 2 r1v5+ D-r1.0+ I-r2.0+
35 broadc ast mailb ox L 1 r1v5+ D-r1.0+ I-r2.0+ 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-140 getsub 
12
Outp ut for the getsub
 c ommand  when c ommunic ating  with R1 AUDIX systems 
p rior to R1V4 is formatted  as follows, one rec ord  for eac h sub sc riber.
36 priority messag es L 1 r1v5+ D-r1.0+ I-r2.0+
37 broadc ast p ermissions C 5 r1v5+ D-r1.0+ I-r2.0+
38 end  of messag e warning  time N 2 r1v6+ D-r1.0+ I-r2.0+
39 CA language c hoic e L 1
D-r3.0+ I-r3.2+
40 login announc ement set C 14
D-r3.0+ I-r3.2+
41 CA p rimary announc ement set C 14
D-r3.0+ I-r3.2+
42 CA sec ond ary announc ement set C 14
D-r3.0+ I-r3.2+
43 IMAPI ac c ess L 1
D-r3.1+ I-r3.2+
44 IMAPI voic e file/ messag e transfer L 1
D-r3.1+ I-r3.2+
45 sec ond ary extension K 10
I-r3.3+
46 FAX c reation L 1
I-r3.3+
47 trusted  server ac c ess L 1
I-r4.0+
48 ac c ount c od e C 16
I-r5.0+
49 email add ress C 64
I-r5.0+
50 misc ellaneous 2 C 11
I-r5.0+
51 misc ellaneous 3 C 11
I-r5.0+
52 misc ellaneous 4 C 11
I-r5.0+
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX
System 
DEFINITY
AUDIX
SystemI
NTUITYAUDIX
System
1 name C 29 r1v2-r1v3
2 extension K 5 r1v2-r1v3
3 c lass of servic e C 8 r1v2-r1v3
4 switc h number N 2 r1v2-r1v3
5 misc ellaneous C 9 r1v2-r1v3
6 c overing  extension C 5 r1v2-r1v3
7 ad dressing  format C 1 r1v2-r1v3
8 CA p ermissions C 1 r1v2-r1v3
9 announc ement c ontrol C 1 r1v2-r1v3
10 inc oming  mailb ox LIFO/FIFO C 1 r1v2-r1v3
11 inc oming  mailb ox ord er C 3 r1v2-r1v3
12 new retention time N 3 r1v2-r1v3
13 old retention time N 3 r1v2-r1v3
14 unop ened retention time N 3 r1v2-r1v3
15 outg oing  mailb ox LIFO/FIFO C 1 r1v2-r1v3
16 outg oing  mailb ox ord er C 5 r1v2-r1v3
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX
System 
DEFINITY
AUDIX
SystemI
NTUITY
AUDIX
System 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-141 getsub 
12
Example 
The following c ommand retrieves the DEFINITY AUDIX Disp lay Sub sc rib er 
sc reen d ata for sub sc rib er(s) from the inp ut file c alled  sub , writes a summary of 
the transfer statistic s to the sc reen, and  writes outp ut to a file c alled johnd oe. 
getsub  -v  < sub > johndoe 
The following data is written to the file: 
Doe, John,73102,class00,,1,,,extension, 
call-answer,n,n,,,fifo,nuo,10,10,10, 
fifo,ufdan,10,5,300,32,120,8,25,250,1200,0,,, 
n,1,n,n,none,0,y,standard,french-c, 
lat-span,n,n 
The following  c ommand  retrieves the R1 AUDIX subsc rib er : loc al sc reen d ata for 
one sub sc rib er from the inp ut file c alled  sub , writes a summary of the transfer 
statistic s to the sc reen, and writes outp ut to a file named  johnd oe. 
getsub  -r r1v8 -v  < sub > johndoe 
The following data is written to the file: 
Doe, John,67890,def,,2,,,e,c,n, 
y,,,f,nuo,30,20,30,f,undfa,30,5,240,32,
240,8,25,500,1200,0,,,n,1,n,y,n,10  
17 file c abinet retention time N 3 r1v2-r1v3
18 del/non del retention time N 3 r1v2-r1v3
19 max VM messag e leng th N 4 r1v2-r1v3
20 min VM spac e req uired N 4 r1v2-r1v3
21 max CA messag e length N 4 r1v2-r1v3
22 min CA sp ac e required N 4 r1v2-r1v3
23 max number of mailing  lists N 3 r1v2-r1v3
24 max total mailing list entries N 5 r1v2-r1v3
25 max mailb ox size N 4 r1v2-r1v3
26 guaranteed  sp ac e N 4 r1v2-r1v3
27 loc ked L 1 r1v2-r1v3
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX
System 
DEFINITY
AUDIX
SystemI
NTUITY
AUDIX
System
RETURN
NEWLINE
RETURN
NEWLINE 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-142 getswitc 
12
getswitc
Get system switc h c onnec tion data 
Syntax 
getswitc
 [-r
 release] [-v
] [-w
] [-V
] [> ofile] 
Description 
This c ommand  retrieves the switc h typ e from the following  sc reens: 
nINTUITY AUDIX Disp lay System-Parameters Customer-op tions
nDEFINITY AUDIX Disp lay System-Parameters Features (D-r1.0 only)
nDEFINITY AUDIX Disp lay System-Parameters Customer-op tions (D-r2.0+ )
nR1 AUDIX (R1V4_5 and  b eyond ) system : translation : switc h c onnec tion 
No inp ut is required . Retrieved  data is written to stand ard outp ut. 
Errors 
If you try to use this c ommand  with an R1 AUDIX R1V4, R1V3, or R1V2 System, 
an error messag e ap p ears. -r
Release flag ; must b e followed  b y 
release. 
release Retrieves d ata for the release of the I
NTUITY AUDIX, DEFINITY 
AUDIX or R1 AUDIX (R1V4_5 and  b eyond ) System software. The 
d efault for the DEFINITY AUDIX System is D-r3.2. The d efault for the 
I
NTUITY AUDIX System is I-r5.0. 
-v
Writes transfer statistic s to the sc reen at the end  of the transfer. 
Pressing  v
 while the c ommand  is exec uting  send s the up d ated  
transfer status to the sc reen. 
-w
Writes a one-line summary of the exit status of this c ommand  into 
the file, form_req.rc
. 
-V
Writes the ADAP version numb er for this c ommand  and exits 
without transferring  any sc reens d ata. 
>  ofile Sp ec ifies the name of the file to whic h d ata will b e written. The 
filename must b e p rec ed ed  b y the symb ol > . If no outp ut file is 
sp ec ified , d ata is written to the sc reen.  
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-143 getswitc 
12
Output Format
Outp ut for the getswitc
 c ommand  is formatted as follows.
Example 
The following c ommand retrieves the DEFINITY AUDIX Disp lay 
System-Parameters Customer-op tions sc reen d ata, writes a summary of the 
transfer statistic s to the sc reen, and  writes outp ut to a file named  switc htyp e. 
getswitc -v > switchtype 
The following data is written to the file: 
dciu-sci,tn746 
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX
System 
DEFINITY
AUDIX 
SystemI
NTUITYAUDIX
System
1switc h c onnec tion typ eC11r1v4_5+D-r1.0+I-r2.0+
2port emulation typ eC5D-r2.0+
RETURN
NEWLINE 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-144 getsys 
12
getsys
Get ad ministration log  d ata 
Syntax 
getsys
    [-d mmdd yy] [-h hhmm]] [-t error typ e] [-n nn] [-r release] [-v
] [-w
] 
[-V
] [
> ofile] 
Description 
This c ommand  retrieves all p ag es of the following sc reens for the searc h informa-
tion that you sp ec ify: 
nINTUITY AUDIX Disp lay Ad ministrator’s Log 
nDEFINITY AUDIX Disp lay Ad ministration-Log 
nR1 AUDIX (R1V3 and  b eyond ) system : log  : d isp lay
Fo r  I
NTUITY AUDIX and  DEFINITY AUDIX Systems, ADAP upd ates the 
sp ec ific ation fields of the AUDIX Disp lay Ad ministration-Log  sc reen 
while 
retrieving  the sc reen data. For the R1 AUDIX System, ADAP upd ates the system : 
log : spec ific ation sc reen 
before retrieving the sc reen d ata. The voic e mail 
system retains the values you sup p ly after the retrieval is c omp leted. 
If you omit the op tion and its q ualifier (for examp le, error typ e), then all log  entries 
are returned. 
For a complete description of error log types, see the appropriate voice mail 
ad ministration or maintenanc e manual (listed  in the 
DEFINITY AUDIX System 
Doc umentation Guid e
, 585-300-011, or the AUDIX Doc umentation Guid e, 
585-300-010). 
No inp ut is required . All errors retrieved  are written to standard  outp ut. 
-d
Date flag ; must b e followed  b y 
mmddyy. Required  for AUDIX 
systems. The d efault is to retrieve entries from all d ates. 
mmdd yy Retrieves d ata for the month, d ay, and  year ind ic ated  b y 
mmdd yy. 
For example, if you enter 012294
, the data for January 22, 1994, is 
retrieved . 
-h
Time of the day flag ; must b e followed  b y 
hhmm. 
This flag  is required  for AUDIX systems. The default retrieves all 
entries starting  at the sp ec ified  d ate.