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-25 getcos 
12
getcos
Get classes of service d ata 
Syntax 
Description 
This c ommand  retrieves the following  sc reens: 
nINTUITY AUDIX Disp lay Cos
nDEFINITY AUDIX Disp lay Cos
nR1 AUDIX Class of Service 
No inp ut is required . Retrieved  data is written to stand ard outp ut. 
Errors 
No errors are assoc iated  with this c ommand . 
getcos
  [-r release] [-v
] [-w
] [-V
] [> ofile]
-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 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-26 getcos 
12
Output Format
Outp ut for the getcos
 c ommand  is formatted  as follows, with one rec ord per 
c lass-of-servic e.
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX 
System 
DEFINITY
AUDIX 
SystemI
NTUITYAUDIX 
System
1 c lass-of-servic e C 8 r1v2+ D-r1.0+ I-r2.0+
2 mod ified L 1 r1v2+ D-r1.0+ I-r2.0+
3 ad dressing  format C 9 r1v2+ D-r1.0+ I-r2.0+
4 CA p ermissions C 14 r1v2+ D-r1.0+ I-r2.0+
5 announc ement c ontrol C 1 r1v2+ D-r1.0+ I-r2.0+
6 inc oming  mailb ox LIFO/FIFO C 4 r1v2+ D-r1.0+ I-r2.0+
7 inc oming  mailb ox ord er C 3 r1v2+ D-r1.0+ I-r2.0+
8 new retention time N 3 r1v2+ D-r1.0+ I-r2.0+
9 old retention time N 3 r1v2+ D-r1.0+ I-r2.0+
10 unop ened retention time N 3 r1v2+ D-r1.0+ I-r2.0+
11 outg oing  mailb ox LIFO/FIFO C 4 r1v2+ D-r1.0+ I-r2.0+
12 outg oing  mailb ox ord er C 5 r1v2+ D-r1.0+ I-r2.0+
13 file c abinet retention time N 3 r1v2+ D-r1.0+ I-r2.0+
14 del/non del retention time N 3 r1v2+ D-r1.0+ I-r2.0+
15 max VM messag e leng th N 4 r1v2+ D-r1.0+ I-r2.0+
16 min VM spac e req uired N 4 r1v2+ D-r1.0+ I-r2.0+
17 max CA messag e length N 4 r1v2+ D-r1.0+ I-r2.0+
18 min CA sp ac e required N 4 r1v2+ D-r1.0+ I-r2.0+
19 max number of mailing  lists N 3 r1v2+ D-r1.0+ I-r2.0+
20 max total mailing list entries N 5 r1v2+ D-r1.0+ I-r2.0+
21 max mailb ox size N 5 r1v2+ D-r1.0+ I-r2.0+
22 guaranteed  sp ac e N 4 r1v2+ D-r1.0+ I-r2.0+
23 outc alling L 1 r1v3+ D-r1.0+ I-r2.0+
24 priority messag es L 1 r1v5+ D-r1.0+ I-r2.0+
25 broadc ast p ermissions C 5 r1v5+ D-r1.0+ I-r2.0+
26 end  of messag e warning  time N 2 r1v6+ D-r1.0+ I-r2.0+
27 c a lang uag e c hoic e L 1
D-r3.0+ I-r3.2+
28 login announc ement set C 14
D-r3.0+ I-r3.2+
29 c a p rimary announc ement set C 14
D-r3.0+ I-r3.2+
30 c a sec ond ary announc ement set C 14
D-r3.0+ I-r3.2+
31 IMAPI ac c ess L 1
D-r3.1+ I-r3.2+
32 IMAPI voic e file/messag e  transfer L 1
D-r3.1+ I-r3.2+
33 FAX  c reation L 1
I-r3.3+
34 trusted  server ac c ess L 1
I-r4.0+ 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-27 getcos 
12
Example 
The following c ommand retrieves all of the DEFINITY AUDIX Class of Servic e 
sc reens, writes a summary of the transfer statistics to the sc reen, and writes 
output to a file named  op tions. 
getcos -v > options 
The following data is written to the file, one line for eac h c lass of servic e:
class00,n,extension,call-answer,n,fifo, 
nuo,10,10,10,fifo,ufdan,10,5,300,32,120,8,25,250,
1200,0, n,n,none,10,y,standard,french-1, 
lat-span,n,n 
The following c ommand retrieves all of the AUDIX R1V8  Class of Servic e 
sc reens, writes a summary of the transfer statistics to the sc reen, and writes 
output to a file named  op tions. 
getcos -v -r r1v8 > options 
The following data is written to the file, one line for eac h c lass of servic e:
def,n,e,c,n,f,nuo,10,10,10,f,funda,
10,5,200,120,120,40,25,250,1200,0,,n,n,10 
RETU RN
NEWLINE
RETU RN
NEWLINE 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-28 getdir 
12
getdir
Get loc al extension list 
Syntax 
Description 
This c ommand  retrieves all p ag es of the following sc reens: 
nINTUITY AUDIX List Extensions 
nDEFINITY AUDIX List Extensions
nR1 AUDIX list : extension : loc al
No inp ut is required . Retrieved  data is written to stand ard outp ut. 
getdir
 [-r release] [-v
] [-w
] [-V
] [> ofile]
-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 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-29 getdir 
12
Errors 
No errors are assoc iated  with this c ommand . 
!CAUTION:
The following c aution only ap p lies when c onnec ted to an AUDIX System: 
If operators on the loc al maintenanc e terminal (LMT) and  the loc al      
ad ministration terminal (LAT) c onc urrently ac c ess the same sc reen 
information, outp ut on either terminal c ould  p rematurely terminate or reflec t 
other undesirable changes. 
Output Format
Outp ut for the getdir
 c ommand  is formatted  as follows, with one rec ord  for eac h 
local sub sc rib er.
Example 
The following  c ommand  retrieves the List Extensions sc reen d ata for all INTUITY or 
DEFINITY AUDIX System sub sc rib ers, writes a summary of the transfer statistic s 
to the sc reen, and  writes outp ut to a file named  extens. 
getdir -v > extens 
The following data is written to the first line of the file. 
67890,Doe, John 
One line for eac h sub sc rib er ap p ears in the file. 
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX 
System 
DEFINITY
AUDIX 
SystemI
NTUITYAUDIX 
System
1 extension K 10 r1v2+ D-r1.0+ I-r2.0+
2 name C 29 r1v2+ D-r1.0+ I-r2.0+
RETU RN
NEWLINE 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-30 geterror 
12
geterror
Get maintenanc e error d ata 
Syntax 
geterror
 [-d mmdd yy [-t
 hhmm]] [-c
 error c od e] [-f
 searc h string] 
  [-s
 
session] [-R
 rep orting -resourc e-typ e] [-T
 resourc e-typ e [-L loc ation]]
  [-n
 
nnnn] [-m module] [-D device] [-x y/n]
  [-p 
nn] [-r release] [-v
] [-w
] [-V
] [> ofile]  
Description 
This c ommand  retrieves all p ag es for the d ate, time, and  searc h information that 
you sp ec ify for the following  sc reens: 
nDEFINITY AUDIX Disp lay Errors 
nR1 AUDIX maintenanc e : error : disp lay 
ADAP up d ates the sp ec ific ation field s of the DEFINITY AUDIX Disp lay Errors 
sc reen while retrieving  the data, or up d ates the maintenanc e : error : 
sp ec ific ation  sc reen before retrieving the sc reen d ata, The voic e mail system 
retains the values you supp ly after the retrieval is c ompleted . 
If you omit the op tions and  their qualifiers (for examp le; 
session, module, device), 
then 
all errors from and  inc lud ing  the sp ec ified  d ate and  time are returned. 
For c omp lete lists of errors, sessions, mod ules, d evic es, rep orting  mod ule typ es, 
and  resourc e typ es, see the ap p rop riate voic e mail system maintenanc e manual. 
NOTE:
The g eterror c ommand  req uires the craft log in for DEFINITY AUDIX      
Sy st e m .  
No inp ut is required . All errors retrieved  are written to standard  outp ut. 
-d
Date flag ; must b e followed  b y 
mmddyy. This flag  is req uired  for 
AUDIX Systems. The default retrieves entries for all d ates. 
mmdd yy Retrieves d ata for the month, d ay, and  year ind ic ated  b y 
mmddyy. 
For examp le, if you enter 112294
, the d ata for Novemb er 22, 1994, 
is retrieved . 
-t
Time of the d ay flag; must b e followed  b y 
hhmm. This flag  is 
required  for AUDIX Systems. The d efault retrieves all entries 
starting  at the sp ec ified  date.  
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-31 geterror 
12
hhmm Retrieves errors from the sp ec ified  hour and  minute to the c urrent 
time. For examp le, if you enter 1512
 at 6:00 p.m. (for retrieval on the 
same d ay), the d ata from 3:12 p .m. to 6:00 p .m. will b e retrieved . 
Midnight is represented by 0000.
-c
Error c od e flag; must b e followed  b y 
error c od e. (This flag  was e in 
p revious ADAP versions.) 
error c od e Retrieves errors matc hing  the error c od e that you sp ec ify. See the 
ap p ropriate voic e mail system maintenanc e manual for a list of 
errors. 
-f
Searc h string  flag ; must b e followed  b y 
searc h string. 
searc h 
stringRetrieves errors c ontaining  the searc h string  you specify. The 
maximum string  leng th  is 50 c harac ters. 
-s
Software session numb er flag ; must b e followed b y 
session. 
session Retrieves errors log g ed  b y the software session numb er that you 
sp ec ify. See the ap p rop riate voic e mail system maintenanc e 
manual for a list of sessions. 
-m
Software mod ule numb er flag; must b e followed  with 
module. This 
argument is only valid  for R1 AUDIX  Systems. 
mod ule Retrieves errors log g ed  b y the software module that you sp ec ify. 
See the ap p rop riate voic e mail system maintenanc e manual for a 
list of mod ules. 
-R
Rep orting  resourc e mod ule typ e flag ; must b e followed  with 
reporting-resource-type. This arg ument is valid  only for the 
DEFINITY AUDIX system. 
rep orting - 
resource- 
typeRetrieves errors log g ed  b y the resourc e type (mod ule) that you 
sp ec ify. See the ap p rop riate voic e mail system maintenanc e 
manual for a list of resourc e typ es. 
-T
Resourc e typ e flag ; must b e followed  with 
resource-typ e. This 
argument is valid  only for the DEFINITY AUDIX System. 
resource- 
typeRetrieves errors log g ed  ag ainst the resourc e typ e that you sp ec ify. 
See the ap p rop riate voic e mail system maintenanc e manual for a 
list of resourc e typ es. 
-L
Location flag; must be followed with 
location. This arg ument is only 
valid  for the DEFINITY AUDIX system. 
location Retrieves errors logg ed  ag ainst resourc es at the sp ec ified  location. 
The T
 
resourc e-typ e arg ument must also b e sp ec ified . 
-n
Numb er of rec ord s flag ; must b e followed  b y 
nnnn. This arg ument 
is only valid for the DEFINITY AUDIX System.  
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-32 geterror 
12
Errors 
If no errors matc h the sp ec ified  searc h, no outp ut is written. 
!CAUTION:
The following c aution ap p lies only to AUDIX Systems: If op erators on the 
loc al maintenanc e terminal (LMT) and the loc al ad ministration terminal 
(LAT) c onc urrently ac c ess the same sc reen information, outp ut on either 
terminal c ould  p rematurely terminate or reflec t other und esirab le c hang es. 
nnnn Retrieves the numb er (nnnn) of rec ord s that you sp ec ify. If this flag  
is not sp ecified , all record s that meet the sp ecification criteria are 
returned . 
-D
Devic e numb er flag ; must b e followed  b y 
device. This arg ument is 
valid  only for R1 AUDIX Systems. (This flag  was n in p revious ADAP 
versions.) 
d evic e Retrieves errors log g ed  ag ainst the devic e numb er that you 
sp ec ify. See the ap p rop riate voic e mail system maintenanc e 
manual for a list of d evic es. 
-r
Release flag ; must b e followed  b y 
release. 
release Retrieves d ata for the spec ified  release of the DEFINITY AUDIX or 
R1 AUDIX software. The d efault is D-r3.2.  
-x
Enhanc ed  error log g ing  flag . Enhanc ed error log g ing  is off b y 
d efault. This arg ument is valid  only for R1 AUDIX Systems. 
y/n Retrieves errors in enhanc ed error display mod e if on (
y). 
-p
Numb er of p ag es flag ; must b e followed by 
nn. If this flag  is 
omitted , all p ag es up  to the c urrent time are retrieved . This 
argument is valid  only for AUDIX Systems. 
nn Retrieves the numb er (
nn) of error p ag es that you sp ec ify. 
-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 data is written. The filename 
must b e p rec ed ed  b y the symbol > . 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-33 geterror 
12
Output Format
Outp ut for the geterror
 c ommand  when c ommunic ating  with a DEFINITY AUDIX 
System is formatted  as follows, with one rec ord  p er error.
Outp ut for the geterror
 c ommand  when c ommunic ating  with an R1 AUDIX 
System is formatted  as follows, with one rec ord  p er error.
 
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX 
System 
DEFINITY
AUDIX 
SystemI
NTUITYAUDIX 
System
1 date rec ord ed D 8
D-r1.0+
2 time rec orded T 4D-r1.0+
3 resourc e typ e C 10D-r1.0+
4 loc ation C 7D-r1.0+
5 event typ e C 7D-r1.0+
6code N 4D-r1.0+
7 c ount N 2D-r1.0+
8 auxiliary data 1 N 10D-r1.0+
9 auxiliary data 2 N 10D-r1.0+
10 session number N 3D-r1.0+
11 reporting resource data, type C 10D-r1.0+
12 rep orting  resourc e d ata, instanc e C 8D-r1.0+
13 rep orting  resourc e d ata, sourc e N 6D-r1.0+
14 error text C 50D-r1.0+
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX
System 
DEFINITY
AUDIX
SystemI
NTUITYAUDIX
System
1 date of oc c urrenc e D 8 r1v2+
2 time of oc c urrenc e T 4 r1v2+
3 c ount N 4 r1v2+
4 error N 4 r1v2+
5 c lass N 1 r1v2+
6 session/unit N 4 r1v2+
7 mod ule N 2 r1v2+
8 devic e N 5 r1v2+
9 enhanc ed  error text C 50 r1v2+ 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-34 geterror 
12
Example
The following c ommand retrieves the DEFINITY AUDIX Disp lay Errors d ata from 
12:25 p .m. on Dec emb er 14, 1994, to the hour and  minute the c ommand  was 
entered , writes a summary of the transfer statistic s to the sc reen, and writes 
output to a file named  errors. 
geterror -d 121494 -t 1225 -v > errors 
The following data is written to the file: 
19941214,1225,ER,01B08,IN_LINE,51,1,2,0,92,ER, 
1,0,CHRONO LOG FILE RECREATED DURING INIT 
The following c ommand retrieves the R1 AUDIX R1V8 maintenanc e : error : 
d isp lay d ata from 8:05 a.m. on January 26, 1995, to the hour and  minute the 
c ommand  was entered , writes a summary of the transfer statistic s to the sc reen, 
and  writes outp ut to a file named  errors. 
geterror -r r1v8 -d 012695 -t 0805 -v > errors 
The following data is written to the file: 
19950126,0805,1,327,2,35,20,28191, 
RETU RN
NEWLINE
RETU RN
NEWLINE