For each of the following commands, this topic provides the
syntax, a description, errors, output format, and an example.
getaalar
Get active alarm list
Syntax
getaalar
[-d mmddyy] [-t hhmm] [-M y/n] [-m y/n]
[-W y/n] [-T resource-type] [-L location] [-n
nnnn] [-u unit] [-l level] [-p nn] [-c
fault/alarm code] [-A application] [-r release] [-v]
[-w] [-V > ofile] |
Description
This command retrieves all pages of the
following screens, for the search information that you specify:
- INTUITY AUDIX Display Alarms
ADAP updates the specification fields
of the Display Alarms screen while retrieving the data. The voice mail system
retains the values you supply after the retrieval is completed.
If you omit the options and their qualifiers
(for example, unit, level, and fault and or alarm code), then all active
alarms are returned.
For complete lists of units, resource
types and fault and or alarm codes, see the appropriate voice mail system
maintenance manual.
No input is required. All active alarms
retrieved are written to standard output.
|
Date flag; must be followed by mmddyy. The default
is to retrieve data for all dates.
|
mmddyy
|
Retrieves data starting at the month, day, and
year indicated by mmddyy. For example, 112201 retrieves data starting
on November 22, 2001.
|
-t
|
Day flag: must be followed by hhmm. This flag
is only available if the d flag also is specified. The default is
to retrieve all data starting at the current date.
|
hhmm
|
Retrieves errors from the specified hour and minute
to the current time. For example, if you enter 1512 at 6:00 p.m. (for
retrieval on the same day), the data from 3:12 p.m. to 6:00 p.m. is
then retrieved. Midnight is represented by 0000.
|
-T
|
Resource type flag; must be followed with resource-type.
The default is to retrieve entries for all resource-types.
|
resource-type
|
Retrieves alarms logged against the resource type
that you specify. See the appropriate voice mail system maintenance
manual for a list of resource types.
|
-L
|
Location flag; must be followed with location.
The default is to retrieve entries for all locations.
|
location
|
Retrieves errors logged against resources at the
specified location. See the appropriate voice mail system forms reference
manual for the format of location.
|
-M
|
Major alarm flag; must be followed by either a
y or n, indicating whether or not to retrieve major alarms. The default
is y.
|
y/n
|
Retrieves or does not retrieve major alarms.
|
-m
|
Minor alarm flag; must be followed by either a
y or n, indicating whether or not to retrieve minor alarms. The default
is y.
|
y/n
|
Retrieves or does not retrieve minor alarms.
|
-W
|
Warning alarm flag; must be followed by either
a y or n, indicating whether or not to retrieve warning alarms. The
default is y.
|
y/n
|
Retrieves or does not retrieve warning alarms.
|
-n
|
Number flag; must be followed by nnnn.
|
nnnn
|
Retrieves the number (nnnn) of alarm entries that
you specify. The default is to retrieve all entries that match the
specifications.
|
-u
|
Hardware unit flag: must be followed by the unit.
|
unit
|
Retrieves alarms logged against the hardware unit
that you specify. See the appropriate voice mail system maintenance
manual for a list of units.
|
level
|
Retrieves alarms logged with the severity level
you specify (0 = major, 1 = minor, and 2 = warning).
|
-c
|
Fault/alarm code number flag: must be followed
by fault/alarm code.
|
fault/alarm code
|
Retrieves alarms logged with the specific fault/alarm
code.
|
-A
|
Application flag; must be followed by the application.
|
application
|
Retrieves only records logged against this application
(module), i.e. VM.
|
-r
|
Release flag; must be followed by the release.
|
release
|
Retrieves data for the specified release of the
software.
|
nn
|
Retrieves the number (nn) of alarm pages that
you specify.
|
-v
|
Writes transfer statistics to the screen at the
end of the transfer.
|
|
Pressing v while the command is executing sends
the updated transfer status to the screen.
|
-w
|
Writes a one-line summary of the exit status of
this command into the file, form_req.rc.
|
-V
|
Writes the ADAP version number for this command
and exits without transferring any screens data.
|
> ofile
|
Specifies the name of the file to which data is
written. The file name must be preceded by the symbol > . If no
output file is specified, data is written to the screen.
|
Errors
If no active alarms exist that fit the
specified search, no output is written.
Output Format
Output for the getaalar command when
communicating with a INTUITY AUDIX System is as follows, with one record
for each alarm.
FIELD
|
Seq. No.
|
Field Name
|
Type
|
Max.
Width
|
1
|
resource type
|
C
|
10
|
2
|
location
|
C
|
11
|
3
|
alarm level
|
C
|
3
|
4
|
fault/alarm code
|
N
|
4
|
5
|
acknowledge
|
C
|
1
|
6
|
data alarmed
|
D
|
8
|
7
|
time alarmed
|
T
|
4
|
8
|
date resolved
|
D
|
8
|
9
|
time resolved
|
T
|
4
|
10
|
resolve reason
|
C
|
6
|
11
|
application
|
C
|
2
|
Example
The following command retrieves the Display
Alarms screen data, writes a summary of the transfer statistics to the screen,
and writes output to a file named alarms.
getaalar -v > aalarms <RETURN>
The following data is written to the
file:
"ALARM_BD","01B07"","MIN",0,"n",19941128,1436,,,""
NEWLINE
This example shows one line of output.
However, the command can return many lines of data.
getalogp
Get activity log data
Syntax
getalogp
[-r release]
[-v] [-w]
[-V] [>
ofile] |
Description
This command retrieves the following
main screens:
- Display System-Parameters Activity-Log
No input is required. Retrieved data
is written to standard output.
-r
|
Release flag; must be followed by the release.
|
release
|
Retrieves data for the specified release of the
software.
|
-v
|
Writes transfer statistics to the screen at the
end of the transfer.
|
|
Pressing v while the
command is executing sends the updated transfer status to the screen.
|
-w
|
Writes a one-line summary of the exit status of
this command into the file, form_req.rc.
|
-V
|
Writes the ADAP version number for this command
and exits without transferring any screen's data.
|
> ofile
|
Specifies the name of the file to which data is
to be written. The filename must be preceded by the symbol > .
If no output file is specified, data is written to the screen.
|
Output Format
Output for the getalogp
command when communicating with an INTUITY AUDIX System is formatted as
follows, with one record for each activity log entry.
FIELD |
Seq. No.
|
Field Name
|
Type
|
Max.
Width
|
1
|
activity log enabled
|
L
|
1
|
2
|
recording MWI updates
|
L
|
1
|
3
|
max number of activity log entries
|
N
|
5
|
Example
The following command retrieves the Display
System-Parameters Activity-Log data, writes a summary of the transfer statistics
to the screen, and writes output to a file named activity.
getalogp -v > activity <RETURN>
The following data is written to the
file:
"y","n",10000 NEWLINE
This example shows one line of output.
This command always returns only a single line of data.
getatt
Get attendant list
Syntax
getatt
[-r release]
[-v] [-w]
[-V] [>
ofile] |
Description
This command retrieves all pages for
the following screen:
- INTUITY AUDIX List Attendants
No input is required. Retrieved data
is written to standard output.
-r
|
Release flag; must be followed by the release.
|
release
|
Retrieves data for the specified release of the
software.
|
-v
|
Writes transfer statistics to the screen at the
end of the transfer.
|
|
Pressing v while the command is executing sends
the updated transfer status to the screen.
|
-w
|
Writes a one-line summary of the exit status of
this command into the file, form_req.rc.
|
-V
|
Writes the ADAP version number for this command
and exists without transferring any screens data.
|
> ofile
|
Specifies the name of the file to which data is
written. The filename must be preceded by the symbol >. If no output
file is specified, data is written to the screen.
|
Output format
Output for the getatt command is formatted
as follows with one record for each attendant.
FIELD
|
Seq. No.
|
Field Name
|
Type
|
Max.
Width
|
1
|
attendant extension
|
K
|
10
|
2
|
name
|
C
|
29
|
Example
The following command retrieves the INTUITY
AUDIX System List Attendants screen data for all the system attendants,
writes a summary of the transfer statistics to the screen, and writes output
to a file named attend.
getatt -v > attend <RETURN>
The following data is written to the
file, one line for each attendant:
"60099","Main Attendant" NEWLINE
getcomm
Get community measurement data
Syntax
getcomm -f day
[-d mmddyy] [-n nn] [-r release] [-v]
[-w] [-V] [> ofile]
or
getcomm -f hour
[-d mmddyy] [-t hh] [-n nn] [-r release]
[-v] [-w] [-V] [> ofile]
|
Description
This command retrieves the following
screen for the date that you specify:
- INTUITY AUDIX List Measurements
Community Day
This command retrieves the following
screen for the date and time that you specify:
- INTUITY AUDIX List Measurements
Community Hour
-f
|
Indicates that the argument following is
a screen. This flag must be followed by either the day or the
hour.
|
day
|
Retrieves the day version of the screen.
|
hour
|
Retrieves the hour version of the screen.
|
-d
|
Date flag; must be followed by mmddyy. Date
is required when used with the R1 AUDIX System. If this flag
is omitted, the most recent date's data will be returned.
|
mmddyy
|
Retrieves data for the month, day, and year
indicated by mmddyy. For example, if you enter 112201 without
subsequently entering the n option, only the data for November
22, 2001, is then retrieved.
|
hh
|
Retrieves data for the hour of the day that
you have specified already by mmddyy. For example, if you enter
15 without subsequently entering the n option, the system retrieves
only the data from 3:00 p.m. to 4:00 p.m.
|
-n
|
Number of records flag; must be followed
by nn.
|
nn
|
Retrieves the number (nn) of hourly or daily
records that you specify. If you don't include this flag, only
one record (hour or day) is returned.
|
|
For example, if you want to retrieve hourly
data and you enter 15 for hh and then enter 5 for nn, the system
retrieves the data for the hours between 3:00 p.m. and 8:00
p.m. (the data beginning at 3:00 and continuing through the
next five hours). The same is true for daily records. If you
enter 112201 for mmddyy and then enter 8 for nn, the system
retrieves the data from and including November 22, 1994, and
continuing through November 29, 2001.
|
-r
|
Release flag; must be followed by release.
|
release
|
Retrieves data for the specified release
of the software.
|
-v
|
Writes transfer statistics to the screen
at the end of the transfer.
|
|
Pressing v while the command is executing
sends the updated transfer status to the screen.
|
-w
|
Writes a one-line summary of the exit status
of this command into the file, form_req.rc.
|
-V
|
Writes the ADAP version number for this
command and exits without transferring any screens data.
|
> ofile
|
Specifies the name of the file to which
data is to be written. The filename must be preceded by the
symbol > . If no output file is specified, data is written
to the screen.
|
Errors
If the specified date is earlier than
any valid date on an INTUITY AUDIX System, the retrieval starts at the first
date with data. If the specified date is after a valid date, an error message
appears and the retrieval aborts.
Output Format
Output for the getcomm command
when using the -f day option is formatted as follows, with one record
for each day.
FIELD |
Seq. No.
|
Field Name
|
Type
|
Max.
Width
|
1
|
starting date
|
D
|
8
|
2
|
ending time
|
T
|
4
|
3
|
VM msgs sent by comm 1
|
N
|
7
|
4
|
VM msgs received by comm 1
|
N
|
7
|
5
|
VM msgs not sent by comm 1
|
N
|
7
|
6
|
VM msgs not received by comm 1
|
N
|
7
|
7
|
VM msgs sent by comm 2
|
N
|
7
|
8
|
VM msgs received by comm 2
|
N
|
7
|
9
|
VM msgs not sent by comm 2
|
N
|
7
|
10
|
VM msgs not received by comm 2
|
N
|
7
|
11
|
VM msgs sent by comm 3
|
N
|
7
|
12
|
VM msgs received by comm 3
|
N
|
7
|
13
|
VM msgs not sent by comm 3
|
N
|
7
|
14
|
VM msgs not received by comm 3
|
N
|
7
|
15
|
VM msgs sent by comm 4
|
N
|
7
|
16
|
VM msgs received by comm 4
|
N
|
7
|
17
|
VM msgs not sent by comm 4
|
N
|
7
|
18
|
VM msgs not received by comm 4
|
N
|
7
|
19
|
VM msgs sent by comm 5
|
N
|
7
|
20
|
VM msgs received by comm 5
|
N
|
7
|
21
|
VM msgs not sent by comm 5
|
N
|
7
|
22
|
VM msgs not received by comm 5
|
N
|
7
|
23
|
VM msgs sent by comm 6
|
N
|
7
|
24
|
VM msgs received by comm 6
|
N
|
7
|
25
|
VM msgs not sent by comm 6
|
N
|
7
|
26
|
VM msgs not received by comm 6
|
N
|
7
|
27
|
VM msgs sent by comm 7
|
N
|
7
|
28
|
VM msgs received by comm 7
|
N
|
7
|
29
|
VM msgs not sent by comm 7
|
N
|
7
|
30
|
VM msgs not received by comm 7
|
N
|
7
|
31
|
VM msgs sent by comm 8
|
N
|
7
|
32
|
VM msgs received by comm 8
|
N
|
7
|
33
|
VM msgs not sent by comm 8
|
N
|
7
|
34
|
VM msgs not received by comm 8
|
N
|
7
|
35
|
VM msgs sent by comm 9
|
N
|
7
|
36
|
VM msgs received by comm 9
|
N
|
7
|
37
|
VM msgs not sent by comm 9
|
N
|
7
|
38
|
VM msgs not received by comm 9
|
N
|
7
|
39
|
VM msgs sent by comm 10
|
N
|
7
|
40
|
VM msgs received by comm 10
|
N
|
7
|
41
|
VM msgs not sent by comm 10
|
N
|
7
|
42
|
VM msgs not received by comm 10
|
N
|
7
|
43
|
VM msgs sent by comm 11
|
N
|
7
|
44
|
VM msgs received by comm 11
|
N
|
7
|
45
|
VM msgs not sent by comm 11
|
N
|
7
|
46
|
VM msgs not received by comm 11
|
N
|
7
|
47
|
VM msgs sent by comm 12
|
N
|
7
|
48
|
VM msgs received by comm 12
|
N
|
7
|
49
|
VM msgs not sent by comm 12
|
N
|
7
|
50
|
VM msgs not received by comm 12
|
N
|
7
|
51
|
VM msgs sent by comm 13
|
N
|
7
|
52
|
VM msgs received by comm 13
|
N
|
7
|
53
|
VM msgs not sent by comm 13
|
N
|
7
|
54
|
VM msgs not received by comm 13
|
N
|
7
|
55
|
VM msgs sent by comm 14
|
N
|
7
|
56
|
VM msgs received by comm 14
|
N
|
7
|
57
|
VM msgs not sent by comm 14
|
N
|
7
|
58
|
VM msgs not received by comm 14
|
N
|
7
|
59
|
VM msgs sent by comm 15
|
N
|
7
|
60
|
VM msgs received by comm 15
|
N
|
7
|
61
|
VM msgs not sent by comm 15
|
N
|
7
|
62
|
VM msgs not received by comm 15
|
N
|
7
|
Output for the getcomm command
when using the -f hour option is formatted as follows, with one record
for each hour.
FIELD |
Seq. No.
|
Field Name
|
Type
|
Max.
Width
|
1
|
starting date
|
D
|
8
|
2
|
starting hour
|
N
|
2
|
3
|
ending time
|
T
|
4
|
4
|
VM msgs sent by comm 1
|
N
|
7
|
5
|
VM msgs received by comm 1
|
N
|
7
|
6
|
VM msgs not sent by comm 1
|
N
|
7
|
7
|
VM msgs not received by comm 1
|
N
|
7
|
8
|
VM msgs sent by comm 2
|
N
|
7
|
9
|
VM msgs received by comm 2
|
N
|
7
|
10
|
VM msgs not sent by comm 2
|
N
|
7
|
11
|
VM msgs not received by comm 2
|
N
|
7
|
12
|
VM msgs sent by comm 3
|
N
|
7
|
13
|
VM msgs received by comm 3
|
N
|
7
|
14
|
VM msgs not sent by comm 3
|
N
|
7
|
15
|
VM msgs not received by comm 3
|
N
|
7
|
16
|
VM msgs sent by comm 4
|
N
|
7
|
17
|
VM msgs received by comm 4
|
N
|
7
|
18
|
VM msgs not sent by comm 4
|
N
|
7
|
19
|
VM msgs not received by comm 4
|
N
|
7
|
20
|
VM msgs sent by comm 5
|
N
|
7
|
21
|
VM msgs received by comm 5
|
N
|
7
|
22
|
VM msgs not sent by comm 5
|
N
|
7
|
23
|
VM msgs not received by comm 5
|
N
|
7
|
24
|
VM msgs sent by comm 6
|
N
|
7
|
25
|
VM msgs received by comm 6
|
N
|
7
|
26
|
VM msgs not sent by comm 6
|
N
|
7
|
27
|
VM msgs not received by comm 6
|
N
|
7
|
28
|
VM msgs sent by comm 7
|
N
|
7
|
29
|
VM msgs received by comm 7
|
N
|
7
|
30
|
VM msgs not sent by comm 7
|
N
|
7
|
31
|
VM msgs not received by comm 7
|
N
|
7
|
32
|
VM msgs sent by comm 8
|
N
|
7
|
33
|
VM msgs received by comm 8
|
N
|
7
|
34
|
VM msgs not sent by comm 8
|
N
|
7
|
35
|
VM msgs not received by comm 8
|
N
|
7
|
36
|
VM msgs sent by comm 9
|
N
|
7
|
37
|
VM msgs received by comm 9
|
N
|
7
|
38
|
VM msgs not sent by comm 9
|
N
|
7
|
39
|
VM msgs not received by comm 9
|
N
|
7
|
40
|
VM msgs sent by comm 10
|
N
|
7
|
41
|
VM msgs received by comm 10
|
N
|
7
|
42
|
VM msgs not sent by comm 10
|
N
|
7
|
43
|
VM msgs not received by comm 10
|
N
|
7
|
44
|
VM msgs sent by comm 11
|
N
|
7
|
45
|
VM msgs received by comm 11
|
N
|
7
|
46
|
VM msgs not sent by comm 11
|
N
|
7
|
47
|
VM msgs not received by comm 11
|
N
|
7
|
48
|
VM msgs sent by comm 12
|
N
|
7
|
49
|
VM msgs received by comm 12
|
N
|
7
|
50
|
VM msgs not sent by comm 12
|
N
|
7
|
51
|
VM msgs not received by comm 12
|
N
|
7
|
52
|
VM msgs sent by comm 13
|
N
|
7
|
53
|
VM msgs received by comm 13
|
N
|
7
|
54
|
VM msgs not sent by comm 13
|
N
|
7
|
55
|
VM msgs not received by comm 13
|
N
|
7
|
56
|
VM msgs sent by comm 14
|
N
|
7
|
57
|
VM msgs received by comm 14
|
N
|
7
|
58
|
VM msgs not sent by comm 14
|
N
|
7
|
59
|
VM msgs not received by comm 14
|
N
|
7
|
60
|
VM msgs sent by comm 15
|
N
|
7
|
61
|
VM msgs received by comm 15
|
N
|
7
|
62
|
VM msgs not sent by comm 15
|
N
|
7
|
63
|
VM msgs not received by comm 15
|
N
|
7
|
Example
The following command retrieves the INTUITY
AUDIX List Measurements Community Day screen data for January 19, 2001,
writes a summary of the transfer statistics to the screen, and writes output
to a file named commtraf.
getcomm -f day -d
011901 -v > commtraf <RETURN>
getcos
Get classes of service data
Syntax
getcos [-r
release] [-v] [-w]
[-V] [> ofile] |
Description
This command retrieves the following
screen:
- INTUITY AUDIX Display Cos
No input is required. Retrieved data
is written to standard output.
-r
|
Release flag; must be followed by the release.
|
release
|
Retrieves data for the specified release of the
software.
|
-v
|
Writes transfer statistics to the screen at the
end of the transfer.
|
|
Pressing v while the command is executing sends
the updated transfer status to the screen.
|
-w
|
Writes a one-line summary of the exit status of
this command into the file, form_req.rc.
|
-V
|
Writes the ADAP version number for this command
and exits without transferring any screens data.
|
> ofile
|
Specifies the name of the file to which data is
to be written. The filename must be preceded by the symbol >. If
no output file is specified, data is written to the screen.
|
Errors
No errors are associated with this command.
Output format
Output for the getcos command is formatted
as follows, with one record per class of service.
FIELD |
Seq. No.
|
Field Name
|
Type
|
Max.
Width
|
-
|
class of service
|
C
|
8
|
-
|
modified
|
L
|
1
|
-
|
addressing format
|
C
|
9
|
-
|
CA permissions
|
C
|
14
|
-
|
announcement control
|
C
|
1
|
-
|
incoming mailbox LIFO/FIFO
|
C
|
4
|
-
|
incoming mailbox order
|
C
|
3
|
-
|
new retention time
|
N
|
3
|
-
|
old retention time
|
N
|
3
|
-
|
unopened retention time
|
N
|
3
|
-
|
outgoing mailbox LIFO/FIFO
|
C
|
4
|
-
|
outgoing mailbox order
|
C
|
5
|
-
|
file cabinet retention time
|
N
|
3
|
-
|
del/non del retention time
|
N
|
3
|
-
|
max VM message length
|
N
|
4
|
-
|
min VM space required
|
N
|
4
|
-
|
max CA message length
|
N
|
4
|
-
|
min CA space required
|
N
|
4
|
-
|
max number of mailing lists
|
N
|
3
|
-
|
max total mailing list entries
|
N
|
5
|
-
|
max mailbox size
|
N
|
5
|
-
|
guaranteed space
|
N
|
4
|
-
|
outcalling
|
L
|
1
|
-
|
priority messages
|
L
|
1
|
-
|
broadcast permissions
|
C
|
5
|
-
|
end of message warning time
|
N
|
2
|
-
|
ca language choice
|
L
|
1
|
-
|
login announcement set
|
C
|
14
|
-
|
ca primary announcement set
|
C
|
14
|
-
|
ca secondary announcement set
|
C
|
14
|
-
|
IMAPI access
|
L
|
1
|
-
|
IMAPI voice file/message transfer
|
L
|
1
|
-
|
FAX creation
|
L
|
1
|
-
|
trusted server access
|
L
|
1
|
getdir
Get local extension list
Syntax
getdir [-r
release] [-v] [-w]
[-V] [> ofile]
|
Description
This command retrieves all pages of the
INTUITY AUDIX List Extensions screen.
No input is required. Retrieved data
is written to standard output.
-r
|
Release flag; must be followed by the release.
|
release
|
Retrieves data for the specified release of the
software.
|
-v
|
Writes transfer statistics to the screen at the
end of the transfer.
|
|
Pressing v while the command is executing sends
the updated transfer status to the screen.
|
-w
|
Writes a one-line summary of the exit status of
this command into the file, form_req.rc.
|
-V
|
Writes the ADAP version number for this command
and exits without transferring any screens data.
|
> ofile
|
Specifies the name of the file to which data is
to be written. The filename must be preceded by the symbol >. If
no output file is specified, data is written to the screen.
|
Errors
No errors are associated with this command.
The following caution only applies when connected to an AUDIX System:
If operators on the local maintenance terminal (LMT) and the local administration
terminal (LAT) concurrently access the same screen information, output on
either terminal could prematurely terminate or reflect other undesirable
changes.
Output format
Output for the getdir command is formatted
as follows, with one record for each local subscriber.
FIELD |
Seq. No.
|
Field Name
|
Type
|
Max.
Width
|
1
|
extension
|
K
|
10
|
2
|
name
|
C
|
29
|
Example
The following command retrieves the List
Extensions screen data for all INTUITY or AUDIX System subscribers, writes
a summary of the transfer statistics to the screen, and writes output to
a file named extens.
getdir -v > extens <RETURN>
The following data is written to the
first line of the file.
"67890","Doe, John" <NEWLINE>
One line for each subscriber appears
in the file.
getfeat
Get traffic measurement data
Syntax
getfeat
-f day [-d mmddyy] [-n nn] [-r release]
[-v] [-w] [-V] [> ofile]
or
getfeat
-f hour [-d mmddyy] [-t hh] [-n nn] [-r
release] [-v] [-w] [-V] [> ofile]
|
Description
This command retrieves data for the date
specified for the INTUITY AUDIX List Measurements Feature Day screen and
for the date and time specified for the INTUITY AUDIX List Measurements
Feature Hour screen
No input is required. Retrieved data
is written to standard output.
-f
|
Screen version flag; must be followed by either
day or hour.
|
day
|
Retrieves day version of the screen.
|
hour
|
Retrieves hour version of the screen.
|
-d
|
Date flag must be followed by mmddyy. Flag is
required when used with the AUDIX System. If this flag is omitted,
the most recent date's data will be returned.
|
mmddyy
|
Retrieves data for the month, day, and year indicated
by mmddyy. For example, if you enter 012201 without subsequently entering
the n option, only the data for January 22, 2001, will be retrieved.
|
-t
|
Time of the day flag; must be followed by hh.
is required when used with the AUDIX System. If this flag is omitted,
the first hour (hour 0) of the specified day or the current hour (if
no day is specified) will be returned.
|
hh
|
Retrieves data for the hour of the day that you
have specified already by mmddyy. For example, if you enter 15 without
subsequently entering the n option, the data from 3:00 p.m. to 4:00
p.m. will be retrieved.
|
-n
|
Number of records flag; must be followed by nn.
If you don't include this option, only one record (hour or day) will
be returned.
|
nn
|
Retrieves the number (nn) of hourly or daily records
that you specify. For example, if you want to retrieve hourly data
and you enter 15 for hh and then enter 5 for nn, the data for the
hours between 3:00 p.m. and 8:00 p.m. (the data beginning at 3:00
and continuing through the next five hours) will be retrieved.
|
|
The same is true for daily records. If you enter
012201 for mmddyy and then enter 8 for nn, the data from and including
January 22, 2001, and continuing through January 29, 2001, will be
retrieved.
|
|
For the INTUITY AUDIX System, you may use the
value all to retrieve all records (hour or day) on or after any specified
date and time.
|
-r
|
Release flag; must be followed by release.
|
release
|
Retrieves data for the specified release of the
software.
|
-v
|
Writes transfer statistics to the screen at the
end of the transfer.
|
|
Pressing v while the command is executing sends
the updated transfer status to the screen.
|
-w
|
Writes a one-line summary of the exit status of
this command into the file, form_req.rc.
|
-V
|
Writes the ADAP version number for this command
and exits without transferring any screens data.
|
> ofile
|
Specifies the name of the file to which data is
to be written. The filename must be preceded by the symbol >. If
no output file is specified, data is written to the screen.
|
Output Format
Output format for the getfeat command
with the -f hour option is formatted as follows, with one record per hour.
FIELD |
Seq. No.
|
Field Name
|
Type
|
Max.
Width
|
-
|
starting date
|
D
|
8
|
-
|
starting hour
|
N
|
2
|
-
|
ending time
|
T
|
4
|
-
|
average number of ports in use
|
N
|
2.1
|
-
|
VM successful logins, external
|
N
|
8
|
-
|
VM successful logins, internal
|
N
|
8
|
-
|
VM failed logins, external
|
N
|
8
|
-
|
VM failed logins, internal
|
N
|
8
|
-
|
VM session usage (seconds)
|
N
|
8
|
-
|
VM total messages, sent
|
N
|
10
|
-
|
VM total messages, deleted
|
N
|
5
|
-
|
VM total messages, current
|
N
|
19
|
-
|
VM average storage time
|
N
|
8
|
-
|
VM average connect time
|
N
|
6
|
-
|
CA completed calls, external
|
N
|
8
|
-
|
CA completed calls, internal
|
N
|
8
|
-
|
CA abandoned calls, external
|
N
|
8
|
-
|
CA abandoned calls, internal
|
N
|
8
|
-
|
CA session usage (seconds)
|
N
|
8
|
-
|
CA messages, received
|
N
|
10
|
-
|
CA messages, deleted
|
N
|
5
|
-
|
CA messages, current
|
N
|
19
|
-
|
CA average storage time
|
N
|
8
|
-
|
CA average connect time
|
N
|
6
|
-
|
VM broadcast messages, sent
|
N
|
10
|
-
|
VM broadcast messages, current
|
N
|
19
|
-
|
VM login announcements, sent
|
N
|
10
|
-
|
VM login announcements, current
|
N
|
19
|
-
|
VM priority messages, sent
|
N
|
10
|
-
|
VM priority messages, current
|
N
|
19
|
-
|
VM private messages, sent
|
N
|
10
|
-
|
VM private messages, current
|
N
|
19
|
-
|
local subscribers
|
N
|
6
|
-
|
remote subscribers
|
N
|
8
|
-
|
non-administered remote subscribers
|
N
|
8
|
-
|
average IMAPI sessions in use
|
N
|
5
|
-
|
successful client logins
|
N
|
8
|
-
|
failed client logins
|
N
|
8
|
-
|
client voice mail session usage
|
N
|
8
|
-
|
completed network call answer calls
|
N
|
8
|
-
|
call answer voice components external
|
N
|
8
|
-
|
call answer voice components internal
|
N
|
8
|
-
|
call answer voice components network
|
N
|
8
|
-
|
call answer FAX components external
|
N
|
8
|
-
|
call answer FAX components internal
|
N
|
8
|
-
|
call answer FAX components network
|
N
|
8
|
-
|
abandoned network calls
|
N
|
8
|
-
|
call answer session usage
|
N
|
8
|
-
|
voice mail voice components sent
|
N
|
10
|
-
|
voice mail voice components current
|
N
|
19
|
-
|
voice mail FAX components sent
|
N
|
10
|
-
|
voice mail FAX components current
|
N
|
19
|
-
|
voice mail binary attachments sent
|
N
|
10
|
-
|
voice mail binary attachments current
|
N
|
19
|
-
|
voice mail text components sent
|
N
|
10
|
-
|
voice mail text components current
|
N
|
19
|
-
|
call answer voice components received
|
N
|
10
|
-
|
call answer voice components current
|
N
|
19
|
-
|
call answer FAX components received
|
N
|
10
|
-
|
call answer FAX components current
|
N
|
19
|
Errors
For the INTUITY AUDIX System, if the
specified date and time is before any valid date and time, the retrieval
starts at the first date and time with data. If the specified date and time
is following a valid date, an error message is returned and the retrieval
aborts.
Example
The following command retrieves the INTUITY
AUDIX List Measurements Features Day screen data for December 22, 2001,
writes a summary of the transfer statistics to the screen, and writes output
to a file named daylds.
getfeat -f day
-d 122201 -v > daylds <RETURN>
getfrag
Get fragment data
Syntax
getfrag -f
fragment id [-a announcement set] [-r
release] [-v] [-w]
[-V] [> ofile] |
Description
This command retrieves the fragment and
announcement set you specify for the INTUITY AUDIX Display Fragment screen.
No input is required. Retrieved data
is written to standard output.
-f
|
Fragment identifier flag; must be followed the
by fragment id.
|
fragment id
|
Retrieves data for the specified fragment identifier.
The fragment identifier's syntax is nnnn, where nnnn is the fragment
number.
|
-a
|
Announcement set flag; must be followed by the
announcement set.
|
announce-ment set
|
Retrieves data for the fragment id of the specified
announcement set. The default is the administered announcement set.
|
-r
|
Release flag; must be followed by release.
|
release
|
Retrieves data for the specified release of the
software.
|
-v
|
Writes transfer statistics to the screen at the
end of the transfer.
|
|
Pressing -v while the command is executing sends
the updated transfer status to the screen.
|
-w
|
Writes a one-line summary of the exit status of
this command into the file, form_req.rc.
|
-V
|
Writes the ADAP version number for this command
and exits without transferring any screens data.
|
> ofile
|
Specifies the name of the file to which data is
to be written. The filename must be preceded by the symbol > .
If no output file is specified, data is written to the screen.
|
Output Format
Output for the getfrag command is as
follows.
FIELD |
Seq. No.
|
Field Name
|
Type
|
Max.
Width
|
1
|
announcement set
|
C
|
14
|
2
|
fragment id
|
C
|
5
|
3
|
voice timestamp date
|
D
|
8
|
4
|
voice timestamp time
|
T
|
4
|
Example
The following command retrieves the INTUITY
AUDIX Display Fragment screen data for fragment 25 for the "standard" announcement
set and writes output to a file named frags.
getfrag -f f25 -a standard >frags
<RETURN>
The following data is written to the
file:
"standard","f25",19941121,0537
NEWLINE
getlimit
Get system parameter limits
Syntax
getlimit [-r
release] [-v] [-w]
[-V] [> ofile] |
Description
This command retrieves the following
screen:
- INTUITY AUDIX Display System-Parameters
Limits
No input is required. Retrieved data
is written to standard output.
-r
|
Release flag; must be followed by the release.
|
release
|
Retrieves data for the specified release of the
software.
|
-v
|
Writes transfer statistics to the screen at the
end of the transfer.
|
|
Pressing v while the command is executing sends
the updated transfer status to the screen.
|
-w
|
Writes a one-line summary of the exit status of
this command into the file, form_req.rc.
|
-V
|
Writes the ADAP version number for this command
and exits without transferring any screens data.
|
> ofile
|
Specifies the name of the file to which data is
written. The filename must be preceded by the symbol >. If no output
file is specified, data is written to the screen.
|
Errors
No errors are associated with this command.
Output Format
Output for the getlimit command is as
follows.
FIELD |
Seq. No.
|
Field Name
|
Type
|
Max.
Width
|
1
|
recommended names FS size
|
N
|
9
|
2
|
min message length
|
N
|
2
|
3
|
max local subscribers
|
N
|
6
|
4
|
total list entries
|
N
|
6
|
5
|
lists per subscriber
|
N
|
3
|
6
|
recipients per list
|
N
|
3
|
7
|
max error log entries
|
N
|
5
|
8
|
total messages in all mailboxes
|
N
|
6
|
9
|
total messages awaiting delivery
|
N
|
6
|
10
|
max message length
|
N
|
4
|
11
|
recommended system data FS size
|
N
|
9
|
12
|
recommended voice data FS size
|
N
|
9
|
13
|
recommended system status FS size
|
N
|
9
|
14
|
max admin remote subscribers
|
N
|
8
|
15
|
max admin log entries
|
N
|
5
|
16
|
max activity log entries
|
N
|
5
|
Example
The following command retrieves the INTUITY
AUDIX Display System-Parameters Limits screen data, writes a summary of
the transfer statistics to the screen, and writes output to a file named
limits.
getlimit -v > limits <RETURN>
The following data is written to the
file:
0,10,1000,50000,100,250,1,50000,5000,1200,0,0,0,1000,
1000 <NEWLINE>
getlist
Syntax
getlist [-r
release] [-v] [-w]
[-V] [>ofile] |
Description
This command retrieves all pages of the
following screen:
- INTUITY AUDIX List Subscribers
No input is required. Retrieved data
is written to standard output.
Note: The output of this command
can be used as input for the local subscriber modification commands described
in Using the ADAP Database Modification Commands,
such as changmis.
-r
|
Release flag: must be followed by the release.
|
release
|
Retrieves data for the specified release of the
software.
|
-v
|
Writes transfer statistics to the screen at the
end of the transfer.
|
|
Pressing -v while the command is executing sends
the updated transfer status to the screen.
|
-w
|
Writes a one-line summary of the exit status of
this command into the file, form_req.rc.
|
-V
|
Writes the ADAP version number for this command
and exits without transferring any screens data.
|
>ofile
|
Specifies the name of the file to which data is
to be written. The filename must be preceded by the symbol >. If
no output file is specified, data is written to the screen.
|
Errors
No errors are associated with this command.

The following caution applies only to the AUDIX System: If operators on
the local maintenance terminal (LMT) and the local administration terminal
(LAT) concurrently access the same screen information, output on either
terminal could prematurely terminate or reflect other undesirable changes.
|
Output Format
Output for the getlist command is formatted
as follows, with one record for each subscriber.
FIELD |
Seq. No.
|
Field Name
|
Type
|
Max.
Width
|
-
|
subscriber name
|
C
|
29
|
-
|
extension
|
K
|
10
|
-
|
class of service
|
C
|
8
|
-
|
miscellaneous 1
|
C
|
11
|
-
|
miscellaneous 2
|
C
|
11
|
-
|
miscellaneous 3
|
C
|
11
|
-
|
miscellaneous 4
|
C
|
11
|
Example
The following command retrieves the
List Subscribers data for all INTUITY AUDIX System subscribers, writes a
summary of the transfer statistics to the screen, and writes output to a
file named subs.
getlist -v > subs <RETURN>
The following data is written to the
file, one line for each subscriber.
"Doe, John","1234","def","1111"
NEWLINE