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-45 getfrag 
12
getfrag
Get frag ment data 
Syntax 
getfrag
   -f frag ment id [-a announc ement set] [-r release] [-v
] [-w
] 
 [-V
] [
> ofile] 
Description 
This c ommand  retrieves the frag ment and  announc ement set you sp ec ify for 
the following  sc reens: 
nINTUITY AUDIX Disp lay Frag ment 
nDEFINITY AUDIX Disp lay Frag ment 
No inp ut is required . Retrieved  data is written to stand ard outp ut. 
-f
Frag ment identifier flag; must b e followed  b y 
fragment id. 
frag ment id Retrieves d ata for the spec ified frag ment id entifier. 
The frag ment identifier’s syntax is nnnn where nnnn 
is the frag ment numb er. 
-a
Announc ement set flag ; must b e followed  b y 
announc ement set. 
announc e-
ment setRetrieves d ata for the frag ment id  of the sp ec ified  
announc ement set. The d efault is the ad ministered  
announc ement set.  See the 
INTUITY AUDIX R3.3 
Ad ministration and Feature Op erations
 
585-310-552 for the p roc ed ure to find  a list of valid  
announc ement sets.
-r
Release flag; must b e followed  b y 
release. 
release Retrieves d ata for the spec ified release of the 
I
NTUITY or DEFINITY AUDIX software. The d efault 
for the DEFINITY AUDIX System is D-r3.2. The 
default 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.  
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-46 getfrag 
12
Errors 
If you use this c ommand  with the R1 AUDIX System, an error messag e ap pears 
on the sc reen. 
Output Format
Outp ut for the getfrag
 c ommand  is as follows.
Example 
The following c ommand retrieves the INTUITY or DEFINITY AUDIX Disp lay        
Frag ment sc reen data for frag ment 25 for the “ stand ard ”  announc ement set and  
writes outp ut to a file named  frag s. 
getfrag -f f25 -a standard >frags 
The following data is written to the file: 
standard,f25,19941121,0537  -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. 
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX
System 
DEFINITY
AUDIX
SystemI
NTUITYAUDIX
System
1 announc ement set C 14
D-r1.0+ I-r2.0+
2 fragment id C 5
D-r1.0+ I-r2.0+
3 voic e timestamp  d ate D 8
D-r1.0+ I-r2.0+
4 voic e timestamp  time T 4
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-47 getlimit 
12
getlimit
Get system p arameter limits 
Syntax 
getlimit
 [-r release] [-v
] [-w
] [-V
] [> ofile] 
Description 
This c ommand  retrieves the following  sc reens: 
nINTUITY AUDIX Disp lay System-Parameters Limits  
nDEFINITY AUDIX Disp lay System-Parameters Limits 
nR1 AUDIX system : limits 
No inp ut is required . Retrieved  data is written to stand ard outp ut. 
Errors 
No errors are assoc iated  with this c ommand . -r
Release flag; must be followed by 
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  sends 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. 
>
 ofileSpec ifies the name of the file to whic h d ata is 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-48 getlimit 
12
Output Format
Outp ut for the getlimit
 c ommand  is as follows.
NOTE:
Field  4, total list entries, is rep orted  as numeric  zero for AUDIX R1V2 .
Example 
The following c ommand retrieves the INTUITY or DEFINITY AUDIX Disp lay 
System-Parameters Limits sc reen d ata, writes a summary of the transfer statistic s 
to the sc reen, and  writes outp ut to a file named  limits. 
getlimit -v > limits 
The following data is written to the file: 
0,10,1000,50000,100,250,1,50000,5000,1200,0,0,0,1000, 
1000 
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX
System 
DEFINITY
AUDIX
SystemI
NTUITYAUDIX
System
1 rec ommend ed  names FS size N 9 r1v2+ D-r1.0+ I-r2.0+
2 min messag e leng th N 2 r1v2+ D-r1.0+ I-r2.0+
3 max loc al subsc rib ers N 6 r1v2+ D-r1.0+ I-r2.0+
4 total list entries N 6 r1v2+ D-r1.0+ I-r2.0+
5 lists p er sub sc rib er N 3 r1v2+ D-r1.0+ I-r2.0+
6 rec ip ients p er list N 3 r1v2+ D-r1.0+ I-r2.0+
7 max error log  entries N 5 r1v2+ D-r1.0+ I-r2.0+
8 total messag es in all mailboxes N 6 r1v2+ D-r1.0+ I-r2.0+
9 total messag es awaiting  delivery N 6 r1v2+ D-r1.0+ I-r2.0+
10 max messag e length N 4 r1v2+ D-r1.0+ I-r2.0+
11 rec ommend ed  system data FS size N 9 r1v2+ D-r1.0+ I-r2.0+
12 rec ommend ed  voic e d ata FS size N 9 r1v2+ D-r1.0+ I-r2.0+
13 rec ommend ed  system status FS size N 9 r1v3+ D-r1.0+ I-r2.0+
14 max ad min remote sub sc rib ers N 8 r1v3+ D-r1.0+ I-r2.0+
15 max ad min log entries N 5 r1v3+ D-r1.0+ I-r2.0+
16 max ac tivity log  entries N 5 r1v5+
RETU RN
NEWLINE 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-49 getlimit 
12
The following c ommand retrieves the AUDIX R1V8 system : limits sc reen d ata, 
writes a summary of the transfer statistic s to the sc reen, and  writes outp ut to a file 
named  limits. 
getlimit -v -r r1v8 > limits 
The following data is written to the file: 
4500,3,1000,20000,100,200,10000,2000,200,1200,488,128,
383,14000,1000,1000 
RETU RN
NEWLINE 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-50 getlist 
12
getlist
Syntax 
getlist
 [-r release] [-v
] [-w
] [-V
] [>ofile] 
Description 
This c ommand  retrieves all p ag es of the following sc reens: 
nINTUITY AU D I X L is t  Su b sc r i b e r s
nDEFINITY AUDIX List Sub sc rib ers 
nR1 AUDIX list : sub sc rib er 
No inp ut is required . Retrieved  data is written to stand ard outp ut. 
NOTE:
The outp ut of this c ommand  c an b e used as input for the loc al sub sc rib er 
modification commands described in Chap ter 13, Command  Line 
Datab ase Mod ific ation Command s, suc h as changmis. 
-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 R1AUDIX 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-51 getlist 
12
Errors 
No errors are assoc iated  with this c ommand . 
!CAUTION:
The following  c aution ap p lies only to the AUDIX System: 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. 
Output Format
Outp ut for the getlist
 c ommand  is formatted as follows, with one rec ord  for eac h 
sub sc rib er.
Example 
The following c ommand retrieves the List Subsc ribers 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  sub s. The outp ut is the same for 
the R1 AUDIX System, b ut the release must b e sp ec ified  on the c ommand  line. 
getlist -v > subs 
The following data is written to the file, one line for eac h sub sc rib er. 
Doe, John,1234,def,1111 
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX
System 
DEFINITY
AUDIX
SystemI
NTUITYAUDIX
System
1subsc riber nameC29r1v2+D-r1.0+I-r2.0+
2extensionK10r1v2+D-r1.0+I-r2.0+
3c lass of servic eC8r1v2+D-r1.0+I-r2.0+
4misc ellaneous 1C11r1v2+D-r1.0+I-r2.0+
5 misc ellaneous 2 C11I-r5.0+
6 misc ellaneous 3 C11I-r5.0+
7 misc ellaneous 4 C11I-r5.0+
RETU RN
NEWLINE 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-52 getload 
12
12
12getload
Get load  measurement lists 
Syntax 
getload -f day
 [-d
 mmd dyy] [-n 
nn]  [-r 
release]  [-v
] [-w
] [-V
] [> ofile]
or
getload -f hour
 [-d
 mmddyy] [-t
 hh]  [-n
 nn]  [-r
 release] [-v
] [-w
] [-V
] [> ofile]
Description 
This c ommand  retrieves the following  sc reens for the date you sp ec ify in the 
c ommand  op tions: 
nINTUITY AUDIX List Measurements Load  Day 
nDEFINITY AUDIX List Measurements Load  Day 
nR1 AUDIX traffic  : load  : day 
This c ommand  retrieves the following  sc reens for the date and  time you sp ec ify 
in the c ommand  op tions: 
nINTUITY AUDIX List Measurements Load  Hour 
nDEFINITY AUDIX List Measurements Load  Hour 
nR1 AUDIX traffic  : load  : hour 
No inp ut is required . Retrieved  data is written to stand ard outp ut. 
-f
Sc reen flag ; must b e followed  b y either day
 or hour
. 
day
Retrieves d ay version of the screen d ata.
hour
Retrieves hour version of the sc reen d ata.
-d
Date flag ; must b e followed  b y 
mmddyy. This flag  is req uired  when 
used  with the R1 AUDIX System. If this flag  is omitted , the most 
rec ent d ate’s d ata will b e returned . 
mmddyy Retrieves data for the month, day, and year indicated by 
mmddyy. 
For example, if you enter 072294
 without sub seq uently entering  the 
-n
 op tion, only the d ata for July 22, 1994, will b e retrieved .  
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Retrieval Commands 
12-53 getload 
12
-t
Time of the d ay; flag  must b e followed  b y hh. This flag  is req uired  
when used  with the R1 AUDIX System. If this flag  is omitted , the 
first hour (hour 0) of the sp ec ified  d ay or the c urrent hour (if no d ay 
is sp ec ified ) will b e returned . 
hh Retrieves d ata for the hour (
hh) of the day (mmddyy) that you have 
sp ec ified  alread y. For examp le, if you enter 15
 without 
sub seq uently entering the -n
 option, only the d ata from 3:00 p .m. 
to 4:00 p .m. will b e retrieved . 
-n
Numb er of rec ord s flag ; must b e followed  b y 
nn.  If you do not 
inc lud e this flag , only one rec ord  (hour or d ay) will b e returned . 
nn Retrieves the numb er (
nn) of hourly or d aily rec ords that you 
sp ec ify. For examp le, if you want to retrieve hourly d ata and  you 
enter 15
 for 
hh and  then enter 5
 for nn, the d ata for the hours 
b etween 3:00 p .m. and  8:00 p .m. (the d ata beg inning at 3:00 and  
c ontinuing  throug h the next five hours) will b e retrieved . 
The same is true for d aily rec ord s. If you enter 082294
 for 
mmddyy 
and  then enter 8
 for 
nn, the d ata from and inc luding  Aug ust 22, 
1994, and  c ontinuing  throug h Aug ust 29, 1994, will be retrieved. 
Fo r  t h e  I
NTUITY or DEFINITY AUDIX System, you may use the value 
all to retrieve all rec ords (hour or d ay) on or after any sp ec ified 
d ate and  time. 
-r
Ind ic ates that the arg ument following  is the name of the release. 
This arg ument must b e followed by 
release. 
release Retrieves d ata for the sp ec ified  release of the I
NTUITY AUDIX, 
DEFINITY AUDIX, or R1 AUDIX software. The default 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. 
Pre ss i n g  -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 by 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-54 getload 
12
Errors 
If either the d ate or time is invalid  when c ommunic ating with an R1 AUDIX       
System, the retrieval ab orts and  no rec ord s are written. 
If the sp ec ified  d ate and  time is b efore any valid  d ate and  time when 
c ommunic ating  with a I
NTUITY or DEFINITY AUDIX System, the retrieval starts at 
the first d ate and  time with d ata. If the sp ec ified  d ate and  time is after a valid  
d ate, an error messag e is returned  and  the retrieval aborts. 
Output Format
Outp ut for the getload
 c ommand  when c ommunic ating with an R1 AUDIX or an 
I
NTUITY AUDIX System using the -f day
 op tion is formatted  as follows, with one 
rec ord  for eac h d ay.
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX
System 
DEFINITY
AUDIX
SystemI
NTUITYAUDIX
System
1 starting date D 8 r1v2+
I-r2.0+
2 end ing  time T 4 r1v2+
I-r2.0+
3 sub sc rib er threshold list exc ep tions N 5 r1v2+
I-r2.0+
4 sub sc rib er threshold list sp ac e exc ep tions N 5 r1v2+
I-r2.0+
5 sub sc rib er lower msg  spac e exc eptions N 5 r1v2+
I-r2.0+
6 sub sc rib er upp er msg sp ac e exc ep tions N 5 r1v2+
I-r2.0+
7 total subsc ribers over threshold N 19 r1v2+
I-r2.0+
8 deliveries resc hed uled N 8 r1v2+
I-r2.0+
9 maximum simultaneous p orts N 3 r1v2+
I-r2.0+
10 maximum voic e text used N 9 r1v2+
I-r2.0+
11 minimum voic e text free sp ac e N 9 r1v2+
I-r2.0+
12 port 1 usage in sec ond s N 6 r1v2+
I-r2.0+
13 port 2 usage in sec ond s N 6 r1v2+
I-r2.0+
14 port 3 usage in sec ond s N 6 r1v2+
I-r2.0+
15 port 4 usage in sec ond s N 6 r1v2+
I-r2.0+
16 port 5 usage in sec ond s N 6 r1v2+
I-r2.0+
17 port 6 usage in sec ond s N 6 r1v2+
I-r2.0+
18 port 7 usage in sec ond s N 6 r1v2+
I-r2.0+
19 port 8 usage in sec ond s N 6 r1v2+
I-r2.0+
20 port 9 usage in sec ond s N 6 r1v2+
I-r2.0+
21 port 10 usag e in sec ond s N 6 r1v2+
I-r2.0+
22 port 11 usag e in sec ond s N 6 r1v2+
I-r2.0+
23 port 12 usag e in sec ond s N 6 r1v2+
I-r2.0+
24 port 13 usag e in sec ond s N 6 r1v2+
I-r2.0+
25 port 14 usag e in sec ond s N 6 r1v2+
I-r2.0+
26 port 15 usag e in sec ond s N 6 r1v2+
I-r2.0+