getralar

getralar

Get resolved alarm data.

Syntax

getralar [-d mmddyy [-t hhmm]] [-c fault/alarm code] [-M y/n] [-m y/n] [-W y/n] [-T resource-type [-L location]] [-n nnnn] [-u unit] [-l level] [-p nn] [-r release] [-A application] [-v] [-w] [-V] [> ofile]

Description

This command retrieves all pages of the following screen 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/alarm code), then all resolved alarms from and including the specified date are returned.

For complete lists of units, resource types and fault/alarm codes, see the appropriate voice mail system maintenance manual.

No input is required. All resolved alarms retrieved are written to standard output.

-d	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, if you enter 072201, the data starting on July 22, 2001, is retrieved.
-t	Time of day flag; must be followed by hhmm. This flag is available only if the -d flag is also specified. This flag is required for AUDIX systems. The default is to retrieve all data starting at the specified 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 retrieved. Midnight is represented by 0000.
-T	Resource type; flag must be followed with resource-type.
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.
location	Retrieves errors logged against resources at the specified location. The -T resource-type argument also must be specified. See the appropriate voice mail system forms reference manual for the format of location.
-M	Major alarms; must be followed by either y or n. The default is y.
y/n	Retrieves or does not retrieve major alarms.
-m	Minor alarms flag; must be followed by either a y or n. 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. The default is y.
y/n	Retrieves or does not retrieve warning alarms.
-n	Number of alarm entries flag; must be followed by nnnn.
nnnn	Retrieves the number (nnnn) of alarm entries that you specify. If you don't specify this flag or you use the word all, all alarm entries that meet the specification criteria are returned.
-u	Hardware unit; flag must be followed by 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.
-l	Severity level number; flag must be followed by level.
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 code.
-A	Application flag; must be followed by application.
application	Retrieves only records logged against this application (module), i.e. VM.
-r	Release flag; must be followed by release.
release	Retrieves data for the specified release of the software.
-p	Number of alarm pages flag; must be followed by nn. This flag is available only for AUDIX systems.
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 filename must be preceded by the symbol >. If no output file is specified, data is written to the screen.

Errors

If no resolved alarms exist that fit the specified search, no output is written.

Output format

Output for the getralar command when communicating with INTUITY AUDIX systems is formatted as follows, with one record for each alarm.
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	resource type	C	10
	location	C	11
	alarm level	C	3
	fault/alarm code	N	4
	acknowledge	C	1
	data alarmed	D	8
	time alarmed	T	4
	date resolved	D	8
	time resolved	T	4
	resolve reason	C	6
	application	C	2

getrem

Get remote message measurements

Syntax

 

getrem -f day [-d mmddyy] -m machine [-n nn] [-r release] [-v] [-w] [-V] [> ofile] or getrem -f month [-d mmyy] -m machine [-n nn] [-r release] [-v] [-w] [-V] [> ofile]

Description

This command retrieves the following screen by the date you specify in the command options:

• INTUITY AUDIX List Measurements Remote-Messages Day

This command retrieves the following screens by the month you specify in the command options:

• INTUITY AUDIX Measurements Remote-Messages Month

No input is required. Retrieved data is written to standard output.
 

-f	Screen flag; must be followed by either day or month.
day	Retrieves the day version of the screen.
month	Retrieves the month version of the screen.
-d	Date flag; must be followed by mmddyy for the day screen or mmyy for the month screen. Required for with AUDIX systems. If this flag is omitted, the most recent date's data is returned.
mmddyy	Retrieves data for the month, day, and year indicated by mmddyy. For example, if you enter 072201, the data for July 22, 2001, is retrieved.
mmyy	Retrieves data for the month and year indicated by mmyy. For example, if you enter 0101 the data for January 2001 is retrieved.
-m	Remote machine flag; must be followed by machine.
machine	Retrieves data for the specified remote machine. For machine, use the machine name that was entered on the administrator's INTUITY or AUDIX system : translation: machine : audix screen when the remote machine was added to the network. If the machine name is more than one word (such as "new york"), the name must be enclosed in quotation marks.
-n	Number of records flag; must be followed by nn. If you don't include this flag, only one record (hour or day) is returned. 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.
nn	Retrieves the number (nn) of daily or monthly records that you specify. For example, if you want to retrieve daily data and you enter 072201 for mmddyy and then enter 5 for nn, the data from and including July 22, 2001, and continuing through July 26, 2001, (the data for July 22 and continuing through the next 5 days) is retrieved.
	The same is true for monthly records. If you enter 0101 for mmyy and then enter 8 for nn, the data from and including January 2001 and continuing through August 2001 is retrieved.
-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 written. The filename must be preceded by the symbol >. If no output file is specified, data is written to the screen.

Errors

When communicating with an INTUITY AUDIX system, if the specified date is before any valid date, the retrieval starts at the first date with data. If the specified date is after a valid date, an error message is returned and the retrieval is aborted.

Output format

Output for the getrem command with the -f day option is formatted as follows, with one record for each day.
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	machine name	C	10
	starting date	D	8
	ending time	T	4
	local orig prime transfer sessions	N	5
	local orig non-prime transfer sessions	N	5
	remote orig prime transfer sessions	N	5
	remote orig non-prime transfer sessions	N	5
	local orig prime usage in seconds	N	7
	local orig non-prime usage in seconds	N	7
	remote orig prime usage in seconds	N	7
	remote orig non-prime usage in seconds	N	7
	local orig prime average usage	N	7
	local orig non-prime average usage	N	7
	remote orig prime average usage	N	7
	remote orig non-prime average usage	N	7
	local orig prime messages sent	N	6
	local orig non-prime messages sent	N	6
	remote orig prime messages sent	N	6
	local orig prime admin updates	N	6
	local orig non-prime admin updates	N	6
	remote orig prime admin updates	N	6
	remote orig non-prime admin updates	N	6
	local voice components - prime	N	6
	local voice components - non-prime	N	6
	remote voice components - prime	N	6
	remote voice components - non-prime	N	6
	local FAX components - prime	N	6
	local FAX components - non-prime	N	6
	remote FAX components - prime	N	6
	remote FAX components - non-prime	N	6
	local binary attachments - prime	N	6
	local binary attachments - non-prime	N	6
	remote binary attachments - prime	N	6
	remote binary attachments - non-prime	N	6
	local text components - prime	N	6
	local text components - non-prime	N	6
	remote text components - prime	N	6
	remote text components - non-prime	N	6

Output for the getrem command with the -f month argument is formatted as
follows, with one record for each month.
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	machine name	C	10
	starting date	D	8
	ending date	D	8
	local orig prime transfer sessions	N	5
	local orig non-prime transfer sessions	N	5
	remote orig prime transfer sessions	N	5
	remote orig non-prime transfer sessions	N	5
	local orig prime usage in seconds	N	7
	local orig non-prime usage in seconds	N	7
	remote orig prime usage in seconds	N	7
	remote orig non-prime usage in seconds	N	7
	local orig prime average usage	N	7
	local orig non-prime average usage	N	7
	remote orig prime average usage	N	7
	remote orig non-prime average usage	N	7
	local orig prime messages sent	N	6
	local orig non-prime messages sent	N	6
	remote orig prime messages sent	N	6
	remote orig non-prime messages sent	N	6
	local orig prime messages rejected	N	6
	local orig non-prime messages rejected	N	6
	remote orig prime messages rejected	N	6
	remote orig non-prime messages rejected	N	6
	local orig prime status sent	N	6
	local orig non-prime status sent	N	6
	remote orig prime status sent	C	3
	remote orig non-prime status sent	C	3
	local orig prime status received	C	3
	local orig non-prime status received	C	3
	remote orig prime status received	N	6
	remote orig non-prime status received	N	6
	message transmission threshold exceptions	N	7
	session failures on far end no answer	N	5
	local orig prime headers sent	N	6
	local orig non-prime headers sent	N	6
	machine type	C	12
	local orig prime admin updates	N	6
	local orig non-prime admin updates	N	6
	remote orig prime admin updates	N	6
	remote orig non-prime admin updates	N	6
	local voice components - prime	N	6
	local voice components - non-prime	N	6
	remote voice components - prime	N	6
	remote voice components - non-prime	N	6
	local FAX components - prime	N	6
	local FAX components - non-prime	N	6
	remote FAX components - prime	N	6
	remote FAX components - non-prime	N	6
	local binary attachments - prime	N	6
	local binary attachments - non-prime	N	6
	remote binary attachments - prime	N	6
	remote binary attachments - non-prime	N	6
	local text components - prime	N	6
	local text components - non-prime	N	6
	remote text components - prime	N	6
	remote text components - non-prime	N	6

getrlist

Get remote extension list

Syntax

getrlist -m machine [-r release] [-v] [-w] [-V] [> ofile]

Description

This command retrieves all pages of the following screens for the specified machine:

• INTUITY AUDIX List Remote-Extensions

No input is required. Retrieved data is written to standard output.
 

-m	Remote machine flag; must be followed by machine.
machine	Retrieves data for the specified remote machine. For machine, use the machine name that was entered on the administrator's INTUITY AUDIX : translation : machine : audix screen when the remote machine was added to the network. If the machine name is more than one word (such as "new york"), the name must be enclosed in quotation marks.
-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 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 getrlist command is formatted as follow, with one record for each remote subscriber.
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	extension	K	10
	name	C	29
	type	C	12
	usage date	D	8

Example

The following command retrieves the INTUITY AUDIX List Extension Remote screen data for all INTUITY AUDIX System Remote Subscribers for the specified remote machine (in this case seattle), writes a summary of the transfer statistics to the screen, and writes output to a file named rextens.

getrlist -m seattle -v > rextens <RETURN>

The following data is written to the file, one line for each remote subscriber:

"74101","Jones, Sam","administered",19940328 <NEWLINE>

getrsub

Get remote subscriber data

Syntax

getrsub -m machine/trusted server [-r release] [-v] [-w] [-V] [-i] [< ifile] [> ofile]

Description

This command retrieves data for the subscribers and machine that you specify for the following screen:

• INTUITY AUDIX Display Remote-Subscriber

Use subscriber extension or text address as input. Retrieved data is written to standard output.
 

-m	Remote machine flag; must be followed by machine or trusted server name.
machine/trusted server	Retrieves data for the specified remote machine or trusted server. For machine, use the machine name that was entered on the administrator's INTUITY AUDIX Machine : translation : machine : audix screen when the remote machine was added to the network. If the machine name is more than one word (such as "new york"), the name must be enclosed in quotation marks.
	For trusted server, use the trusted server name that was entered on the INTUITY AUDIX Trusted Server Profile screen when the server was added to that system.
-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.
	Unless i is specified, 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.
-i	Turns off the search for possible subsequent entry of the v and q (quit) options. Otherwise, if you type ahead, you may lose characters. If you don't specify i, you must specify an input file (< ifile) from which the extensions are read.
< ifile	Specifies the name of an input file you have created. The filename must be preceded by the symbol <.
	This file contains one or more extensions (or text addresses) of the remote subscribers whose traffic data this command retrieves. If you don't specify an input file, you must specify the i option, which allows you to type the individual extensions (or text addresses) directly from your keyboard after entering this command. (The output from the getrlist command or the gettlist command could be the input for this command.)
> 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.

Input format

The Input format for the getrsub command when the -m machine option refers to a remote voice mail system consists of one record for each remote subscriber.
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	extension	K	10

The Input format for the getrsub command when the -m machine option refers to a trusted server consists of one record for each remote subscriber.

 

FIELD				VOICE MAIL VERSIONS
	text address	C	64			I-r4.0+

Output format

Output format for the getrsub command for a remote subscriber on a remote voice mail system is formatted as follows.
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	name	C	29
	extension	K	10
	address	C	31
	administered indicator	L	1
	machine name 1	C	10
	machine name 2	C	10
	machine name 3	C	10
	machine name 4	C	10
	machine name 5	C	10
	machine name 6	C	10
	machine name 7	C	10
	machine name 8	C	10
	voiced name	L	1
	non-administered type	C	10
	last usage date	D	8
	new name	C	29
	new extension	K	10
	community id	N	2
	machine name 9	C	10
	machine name 10	C	10
	machine name 11	C	10
	machine name 12	C	10
	machine name 13	C	10
	machine name 14	C	10
	machine name 15	C	10
	machine name 16	C	10
	machine name 17	C	10

Output for the getrsub command for a remote subscriber served by a trusted server is formatted as follows.

 

FIELD
Seq. No.	Field Name	Type	Max. Width
	name	C	29
	text address	C	64
	administered indicator	L	1
	trusted server name	C	10
	voiced name	L	1
	non-administered type	C	10
	last usage date	D	8
	community id	N	2

Example

The following command retrieves the INTUITY AUDIX Display Remote-Subscriber screen data for one or more remote subscribers from the input file called allsubs, writes a summary of the transfer statistics to the screen, and writes output to a file named johndoe.

getrsub -m seattle -v < allsubs > johndoe <RETURN>

The following data is written to the file:

"Doe, John","74101","74101","n","seattle","","", "","","","","","n","administered",19940328,"","",3, "","","","","","","","" NEWLINE

The following command retrieves the INTUITY AUDIX Display Remote-Subscriber screen data when the -m machine option refers to a trusted server. The input file, trsub, contains the text address ("[email protected]"), and the output is written to the output file, jdoe.

getrsub -r I-r4.0 -m internet < trsub > jdoe <RETURN>

The following data is written to the file:

"Doe, John","[email protected]","n","internet","n",
"verified",19990226,1 NEWLINE

getserve

Get trusted server list

Syntax

 

getserve [-r release] [-v] [-w] [-V] [> ofile]

Description

This command retrieves all pages for the following screen:

• INTUITY AUDIX List Trusted-servers

No input is required. Retrieved data is written to standard output.
 

-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 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 getserve command is as follows, one record for each trusted server.
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	trusted server name	C	10
	access to cross domain delivery	L	1
	IP address	C	15
	trusted server ID	N	2
	service name	C	64

Example

The following command retrieves the INTUITY AUDIX List trusted-servers screen data for all servers, writes a summary of the transfer statistics to the screen, and writes output to a file named servers.

getserve -v > servers <RETURN>

The following data is written to the file, one line for each server:

"drnote11","y","135.9.181.42",14,"drmid10" NEWLINE

getspfea

Get special features measurements

Syntax

 

getspfea -f day [-d mmddyy] [-n nn] [-r release] [-s switch type] [-v] [-w] [-V] [> ofile] or getspfea -f hour [-d mmddyy [-h hh][-n nn]] [-r release] [-s switch type] [-v] [-w] [-V] [> ofile]

Description

This command retrieves the following screen for the date that you specify:

• INTUITY AUDIX List Measurements Special-Features Day

This command retrieves the following screen for the hour that you specify:

• INTUITY AUDIX List Measurements Special-Features Hour

No input is required. Retrieved data is written to standard output.
 

-f	Screen flag; must be followed by either day or hour.
day	Retrieves the day version of the screen data.
hour	Retrieves the hour version of the screen data.
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, is retrieved.
-h	Time of the day flag; must be followed by hh. Required when used with 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) is returned.
hh	Retrieves data for the hour (hh) of the day (mmddyy) that you have specified already. For example, if you enter 15 without subsequently entering the n option, only the data from 3:00 p.m. to 4:00 p.m. is retrieved.
-n	Number of records flag; must be followed by nn. If you don't include this flag, only one record (hour or day) is 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) is 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, is retrieved.
	For the INTUITY AUDIX systems, 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.
-s	Switch connection type flag; must be followed by switch type.
switch type	Retrieves data for the specified switch connection type.
-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

With the INTUITY AUDIX systems, if the specified date is before any valid date, the retrieval starts at the first date with data. If the specified date is after a valid date, an error message is returned and the retrieval aborts.

Output format

Output for the getspfea command with the -f day option is formatted as follows when communicating with INTUITY AUDIX, (with a switch integration other than SL-1) Systems, with one record for each day
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	starting date	D	8
	ending time	T	4
	average number of CA ports in use	N	2.1
	maximum simultaneous CA ports	N	2
	average number of VM ports in use	N	2.1
	maximum simultaneous VM ports	N	2
	average number of AA ports in use	N	2.1
	maximum simultaneous AA ports	N	2
	maximum simultaneous outcalls	N	3
	outcalls attempted	N	8
	outcalls completed	N	8
	outcalls rescheduled	N	8
	calls answered without connect	N	8

Output for the getspfea command with the -f hour option is formatted as follows when communicating with INTUITY AUDIX with switch integration other than SL-1) Systems, with one record for each hour.
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	starting date	D	8
	starting hour	N	2
	ending time	T	4
	average number of CA ports in use	N	2.1
	maximum simultaneous CA ports	N	2
	average number of VM ports in use	N	2.1
	maximum simultaneous VM ports	N	2
	average number of AA ports in use	N	2.1
	maximum simultaneous AA ports	N	2
	maximum simultaneous outcalls	N	3
	outcalls attempted	N	8
	outcalls completed	N	8
	outcalls rescheduled	N	8
	calls answered without connect	N	8

Example

The following command retrieves the INTUITY AUDIX List Measurements Special-Features Day screen data for December 12, 1994, writes a
summary of the transfer statistics to the screen, and writes output to a file named daylds.

getspfea -f day -d 121294 -v > daylds <RETURN>

The following data is written to the file:

19941212,2359,0.0,0,0.0,0,0.0,0,0,0,0,0,0 NEWLINE

getsub

Get local subscriber data

Syntax

getsub [-r release] [-v] [-w] [-V] [-i] [< ifile] [> ofile]

Description

This command retrieves the following screen for the specified subscriber(s):

• INTUITY AUDIX Display Subscriber

Use subscriber extensions as input. Retrieved data is written to standard output.
 

-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.
	Unless -i is specified, 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.
-i	Turns off the search for possible subsequent entry of the v and q (quit) options. Otherwise, if you type ahead, you may lose characters.
	If you don't specify -i, you must specify an input file (< ifile) from which the extensions will be read.
< ifile	Specifies the name of an input file you have created. The filename must be preceded by the symbol <.
	This file contains one or more extensions of the subscribers whose traffic data this command retrieves. If you don't specify an input file, you must specify the -i option, which allows you to type the individual extensions directly from your keyboard after entering this command.
> ofile	Specifies the name of the file to which data will 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 extension does not belong to a valid voice mail system subscriber, an error message appears, giving the record number containing the invalid extension. If more records exist, retrieval continues.

Input format

The Input format for getsub consists of one record for each subscriber:
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	extension	K	10

Output format

Output for getsub for INTUITY AUDIX, is formatted as follows, one record for each subscriber
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	name	C	29
	extension	K	10
	class of service	C	8
	password	K	15
	switch number	N	2
	miscellaneous 1	C	11
	covering extension	K	10
	addressing format	C	9
	CA permissions	C	14
	announcement control	C	1
	outcalling	L	1
	text service machine	C	10
	user id	C	30
	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
	new subscriber name	C	29
	new extension	K	10
	locked	C	1
	community id	N	2
	broadcast mailbox	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
	secondary extension	K	10
	FAX creation	L	1
	trusted server access	L	1
	account code	C	16
	email address	C	64
	miscellaneous 2	C	11
	miscellaneous 3	C	11
	miscellaneous 4	C	11

getswitc

Get system switch connection data

Syntax

 

getswitc [-r release] [-v] [-w] [-V] [> ofile]

Description

This command retrieves the switch type from the following screen:

• INTUITY AUDIX Display System-Parameters Customer-options

No input is required. Retrieved data is written to standard output.
 

-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 will 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 getswitc command is formatted as follows.
 

FIELD				Voice Mail Versions
Seq. No.	Field Name	Type	Max. Width	INTUITY AUDIX System
	switch connection type	C	11	I-r2.0+
	port emulation type	C	5

getsys

Get administration log data

Syntax

 

getsys [-d mmddyy] [-h hhmm]] [-t error type] [-n nn] [-r release] [-v] [-w] [-V] [> ofile]

Description

This command retrieves all pages of the following screen for the search information that you specify:

• INTUITY AUDIX Display Administrator's Log

ADAP updates the specification fields of the AUDIX Display Administration-Log screen while retrieving the screen data. The voice mail system retains the values you supply after the retrieval is completed.

If you omit the option and its qualifier (for example, error type), then all log entries are returned.

No input is required. All errors retrieved are written to standard output.
 

-d	Date flag; must be followed by mmddyy. Required for AUDIX systems. The default is to retrieve entries from all dates.
mmddyy	Retrieves data for the month, day, and year indicated by mmddyy.
-h	Time of the day flag; must be followed by hhmm.
	This flag is required for AUDIX systems. The default retrieves all entries starting at the specified date.
hhmm	Retrieves data from the hour (hhmm) of the day (mmddyy) that you have specified already, to the time that you enter this command. For example, if you enter 1500 at 6:00 p.m., the data from 3:00 p.m. to 6:00 p.m. is retrieved. Midnight is represented by 0000.
-t	Error type flag; must be followed with error type.
error type	Retrieves log entries for the specified error type. See the appropriate voice mail system administration or maintenance manual for a list of error types.
-n	Number of log entries flag; must be followed by nn.
nn	Retrieves the number (nn) of log entries that you specify. If you don't specify this flag or you use the word all, all alarm entries that meet the specification criteria are returned.
-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 will 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 getsys is formatted as follows, with one record for each log entry.
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	date	D	8
	time	T	4
	type/event id	C	14
	error/message/alarm	C	118
	count	C	3
	application	C	2

getsysat

Get system attendant data

Syntax

 

getsysat [-r release] [-v] [-w] [-V] [-i] [< ifile] [> ofile]

Description

This command retrieves the following screen:

• INTUITY AUDIX Display Subscriber

Use subscriber extensions as input. Retrieved data is written to standard output. (The output of the getatt command is good input for this command.)
 

-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. Unless -i is specified, 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.
	This file contains one or more extensions of the system attendants. If you ran the getatt command and redirected its output to a file, you could use this file as input to the getsysat command. If you don't specify an input file, you must specify the -i option, which allows you to type the individual extensions directly from your keyboard after entering this command.
> ofile	Specifies the name of the file to which data are written. The filename must be preceded by the symbol >. If no output file is specified, data is written to the screen.

Input format

The Input format for the getsysat command consists of one record for each automated attendant:
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	extension	K	10

Output format

Output for the getsysat command is formatted as follows, with one record for each system attendant.
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	name	C	29
	extension	K	10
	allow call transfer	L	1
	button 1 extension	C	10
	button 1 comment	C	29
	button 2 extension	C	10
	button 2 comment	C	29
	button 3 extension	C	10
	button 3 comment	C	29
	button 4 extension	C	10
	button 4 comment	C	29
	button 5 extension	C	10
	button 5 comment	C	29
	button 6 extension	C	10
	button 6 comment	C	29
	button 7 extension	C	10
	button 7 comment	C	29
	button 8 extension	C	10
	button 8 comment	C	29
	button 9 extension	C	10
	button 9 comment	C	29
	button 0 extension	C	10
	button 0 comment	C	29
	default timeout extension	K	10
	length of timeout in seconds	C	1
	button 1 treatment	C	14
	button 2 treatment	C	14
	button 3 treatment	C	14
	button 4 treatment	C	14
	button 5 treatment	C	14
	button 6 treatment	C	14
	button 7 treatment	C	14
	button 8 treatment	C	14
	button 9 treatment	C	14
	button 0 treatment	C	14
	timeout treatment	C	14
	timeout comment	C	29

Example

The following command retrieves the INTUITY AUDIX Display Subscriber screen data for one subscriber from the input file called attend, writes a summary of the transfer statistics to the screen, and writes output to a file named attfile.

getsysat -v < attend > attfile <RETURN>

The following data is written to the file:

"Main Attendant","60099","n","60001","Sales","60002", "Personnel","60003","Purchasing","60004","Accounting", "60005","Engineering","","","","","","","","","","", "60010","5","call-answer","call-answer","call-answer", "call-answer","call-answer","","","","","", "call-answer","" NEWLINE

getsysfe

Get system parameters features data

Syntax

 

getsysfe [-r release] [-v] [-w] [-V] [> ofile]

 

Description

This command retrieves the following screen:

• INTUITY AUDIX Display System-Parameters Features

No input is required. Retrieved data is written to standard output.
 

-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 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 getsysfe command when communicating with an INTUITY AUDIX system is formatted as follows.

 

FIELD
	switch connection type	C	11
	login retries	N	1
	consecutive invalid login attempts	N	3
	system guest password	K	15
	minimum password length	N	2
	input time limit, normal	N	2
	input time limit, full mailbox timeout	N	1
	input time limit, wait	N	3
	broadcast mailbox extension	K	10
	system prime time, start hour	N	2
	system prime time, start minute	N	2
	system prime time, end hour	N	2
	system prime time, end minute	N	2
	traffic collection activation	L	1
	name recording by subscriber activation	L	1
	multiple personal greetings activation	L	1
	call transfer out of AUDIX activation	L	1
	enhanced call transfer activation	L	1
	covering ext for call transfer out of AUDIX	K	10
	call transfer restriction out of AUDIX	C	11
	end of message warning feature activation	L	1
	end of message warning time	N	2
	weekly backup enabled	L	1
	active announcement set	C	14
	administrative announcement set	C	14
	rescheduling increment 1, days	N	2
	rescheduling increment 1, hours	N	2
	rescheduling increment 1, minutes	N	2
	rescheduling increment 2, days	N	2
	rescheduling increment 2, hour	N	2
	rescheduling increment 2, minutes	N	2
	rescheduling increment 3, days	N	2
	rescheduling increment 3, hours	N	2
	rescheduling increment 3, minutes	N	2
	rescheduling increment 4, days	N	2
	rescheduling increment 4, hours	N	2
	rescheduling increment 4, minutes	N	2
	rescheduling increment 5, days	N	2
	rescheduling increment 5, hours	N	2
	rescheduling increment 5, minutes	N	2
	rescheduling increment 6, days	N	2
	rescheduling increment 6, hours	N	2
	rescheduling increment 6, minutes	N	2
	rescheduling increment 7, days	N	2
	rescheduling increment 7, hours	N	2
	rescheduling increment 7, minutes	N	2
	rescheduling increment 8, days	N	2
	rescheduling increment 8, hours	N	2
	rescheduling increment 8, minutes	N	2
	rescheduling increment 9, days	N	2
	rescheduling increment 9, hours	N	2
	rescheduling increment 9, minutes	N	2
	rescheduling increment 10, days	N	2
	rescheduling increment 10, hours	N	2
	rescheduling increment 10, minutes	N	2
	call transfer type	C	19
	rewind increment	C	1
	advance increment	C	1
	quick silence disconnect	L	1
	silence limit	N	2
	tone based disconnect	L	1
	password expiration interval	N	3
	minimum age before changes	N	2
	expiration warning	N	2
	auto attendant between digits	N	2
	priority on call answer	L	1
	call answer disable	L	1
	address before record	L	1
	called subscriber id	C	20
	FAX print destination prefix	N	21
	text to speech conversion	C	18

Example

The following command retrieves the INTUITY AUDIX Display System-Parameters Features screen data, writes a summary of the transfer statistics to the screen, and writes output to a file named sysfeat.

getsysfe -v > sysfeat <RETURN>

The following data is written to the file:

"embedded",3,18,"",0,50,180,5,"",11,00,02,00,"y","y", "y","y","n","1000","subscribers","y",15,"y","standard", "standard",0,0,5,0,0,15,0,0,30,0,1,0,0,2,0,0,6,0,1,0,0,0, 0,0,0,0,0,0,0,0,"enhanced","l","l","n",1,"y",50,6,5, 3,"y","y",50,6,5 NEWLINE

gettlist

Get remote text address list

Syntax

 

gettlist -m trusted server [-r release] [-v] [-w] [-V] [> ofile]

Description

This command retrieves all pages of the following screens for the specified machine:

• INTUITY AUDIX List Remote-text-addresses

No input is required. Retrieved data is written to standard output.
 

-m	Remote trusted server flag; must be followed by trusted server.
trusted server	Retrieves data for the specified remote trusted server. Use the trusted server name that was entered on the administrator's INTUITY AUDIX System trusted server profile screen when the remote trusted server was added to the network. If the trusted server name is more than one word (such as "new york"), the name must be enclosed in quotation marks.
-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 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 gettlist command is formatted as follow, with one record for each remote subscriber.
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	text address	C	64
	name	C	29
	type	C	12
	last usage date	D	8

Example

The following command retrieves the INTUITY AUDIX List remote-text-addresses screen data for all INTUITY AUDIX System Remote Subscribers for the specified remote trusted server (in this case seattle), writes a summary of the transfer statistics to the screen, and writes output to a file named rtext.

gettlist -m seattle -v > rtext <RETURN>

The following data is written to the file, one line for each remote subscriber:

"drnote11.dr.att.com@drnote11","drnote11.dr.att.com",
"verified",19951129 NEWLINE

gettraf

Get subscriber measurements

Syntax

gettraf -f day [-d mmddyy] [-n nn] [-r release] [-v] [-w] [-V] [-i] [< ifile] [> ofile]

or

gettraf -f month [-d mmyy] [-n nn] [-r release] [-v] [-w] [-V] [-i] [< ifile] [> ofile]

Description

This command retrieves the following screen for the month and subscriber that you specify:

• INTUITY AUDIX List Measurements Subscriber Month

This command retrieves the following screen for the date and subscriber that you specify:

• INTUITY AUDIX List Measurements Subscriber Day

Use subscriber extensions as input. Retrieved data is written to standard output.
 

-f	Screen flag; must be followed by either month or day.
month	Specifies month screen data.
day	Specifies day screen data.
-d	Date flag; must be followed by mmddyy for the day screen or mmyy for the month screen. This flag is required for AUDIX systems. If this flag is omitted, the most recent date's data is returned.
mmyy	Retrieves data for the month and year indicated by mmyy. For example, if you enter 0701, the data for July 2001 is retrieved.
mmddyy	Retrieves data for the month, day, and year indicated by mmddyy. For example, if you enter 072201, the data for July 22, 2001, is retrieved.
-n	Record number flag; must be followed by nn. If you don't include this flag, only one record (month or day) is returned.
nn	Retrieves the number (nn) of daily or monthly records that you specify. For example, if you want to retrieve monthly data and you enter 0301 for mmyy and then enter 3 for nn, the data for the months between March and May 2001 (the data beginning on March, 2001 and continuing through the next 3 months) will be retrieved.
	The same is true for daily records. If you enter 112201 for mmddyy and then enter 8 for nn, the data from and including November 22, 2001, and continuing through November 29, 2001, is retrieved.
	For the INTUITY AUDIX System, you may use the value all to retrieve all records (month 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.
	Unless -i is specified, 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.
-i	Turns off the search for possible subsequent entry of the v and q (quit) options. Otherwise, if you type ahead, you may lose characters.
	If you don't specify -i, you must specify an input file (< ifile) from which the extensions will be read.
< ifile	Specifies the name of an input file you have created. The filename must be preceded by the symbol <. This file contains one or more extensions of the subscribers whose traffic data this command retrieves. If you don't specify an input file, you must specify the -i option, which allows you to type the individual extensions directly from your keyboard after entering this command.
> ofile	Specifies the name of the file to which data will 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 extension or subscriber name doesn't represent a valid voice mail system subscriber, an error message appears, giving the record number containing the invalid extension and, if more records exist, retrieval continues.

If the specified date is before any valid date for a INTUITY AUDIX System, the retrieval starts at the first date with data. If the specified date is after a valid date, an error message is returned and the retrieval aborts.

Input format

The Input format consists of one record for each subscriber:
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	extension	K	10

Output format

Output for the gettraf command with the -f month option when communicating with INTUITY AUDIX System is formatted as follows, with one record for each subscriber specified by the input file (or on the keyboard, if you use the -i option).
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	name	C	29
	extension	K	10
	mailbox space used in seconds	N	10
	space allowed in seconds	N	10
	maximum space used in seconds	N	10
	space guaranteed in seconds	N	10
	prime CA sessions	N	10
	non-prime CA sessions	N	10
	prime VM sessions	N	10
	non-prime VM sessions	N	10
	prime CA session usage in seconds	N	10
	non-prime CA session usage in seconds	N	10
	prime VM session usage in seconds	N	10
	non-prime VM session usage in seconds	N	10
	prime CA messages received	N	10
	non-prime CA messages received	N	10
	prime local VM messages received	N	10
	non-prime local VM messages received	N	10
	prime remote VM messages received	N	10
	non-prime remote VM messages received	N	10
	prime local VM messages sent	N	10
	non-prime local VM messages sent	N	10
	prime remote VM messages sent	N	10
	non-prime remote VM messages sent	N	10
	prime CA text service headers created	N	10
	non-prime CA text service headers created	N	10
	prime VM text service headers created	N	10
	non-prime VM text service headers created	N	10
	community id	N	2
	prime VM undeliverable notifications	N	10
	non-prime VM undeliverable notifications	N	10
	prime total VM messages created	N	10
	non-prime total VM messages created	N	10
	prime broadcast messages created	N	10
	non-prime broadcast messages created	N	10
	prime log-in announcements created	N	10
	non-prime log-in announcements created	N	10
	prime priority messages created	N	10
	non-prime priority messages created	N	10
	prime private messages created	N	10
	non-prime private messages created	N	10
	starting date	D	8
	ending date	D	8
	local voice components received - prime	N	10
	local voice components received - non-prime	N	10
	local FAX components received - prime	N	10
	local FAX components received - non-prime	N	10
	local binary attachments received - prime	N	10
	local binary attachments received - non-prime	N	10
	local text components received - prime	N	10
	local text components received - non-prime	N	10
	remote voice components received - prime	N	10
	remote voice components received - non-prime	N	10
	remote FAX components received - prime	N	10
	remote FAX components received - non-prime	N	10
	remote binary attachments received - prime	N	10
	remote binary attachments received - non-prime	N	10
	remote text components received - prime	N	10
	remote text components received - non-prime	N	10
	call answer voice components - prime	N	10
	call answer voice components - non-prime	N	10
	call answer FAX components - prime	N	10
	call answer FAX components - non-prime	N	10
	voice components created - prime	N	10
	voice components created - non-prime	N	10
	FAX components created - prime	N	10
	FAX components created - non-prime	N	10
	binary attachments created - prime	N	10
	binary attachments created - non-prime	N	10
	text components created - prime	N	10
	text components created - non-prime	N	10
	local voice components sent - prime	N	10
	local voice components sent - non-prime	N	10
	local FAX components sent - prime	N	10
	local FAX components sent - non-prime	N	10
	local binary attachments sent - prime	N	10
	local binary attachments sent - non-prime	N	10
	local text components sent - prime	N	10
	local text components sent - non-prime	N	10
	remote voice components sent - prime	N	10
	remote voice components sent - non-prime	N	10
	remote FAX components sent - prime	N	10
	remote FAX components sent - non-prime	N	10
	remote binary attachments sent - prime	N	10
	remote binary attachments sent - non-prime	N	10
	remote text components sent - prime	N	10
	remote text components sent - non-prime	N	10

Output for the gettraf command with the -f day option when communicating with INTUITY AUDIX system is formatted as follows, with one record for each subscriber specified by the input file (or on the keyboard, if you use the -i option).
 

FIELD
Seq. No.	Field Name	Type	Max. Width
	name	C	29
	extension	K	10
	mailbox space used in seconds	N	10
	space allowed in seconds	N	10
	maximum space used in seconds	N	10
	space guaranteed in seconds	N	10
	prime CA sessions	N	10
	non-prime CA sessions	N	10
	prime VM sessions	N	10
	non-prime VM sessions	N	10
	prime CA session usage in seconds	N	10
	non-prime CA session usage in seconds	N	10
	prime VM session usage in seconds	N	10
	non-prime VM session usage in seconds	N	10
	prime CA messages received	N	10
	non-prime CA messages received	N	10
	prime local VM messages received	N	10
	non-prime local VM messages received	N	10
	prime remote VM messages received	N	10
	non-prime remote VM messages received	N	10
	prime local VM messages sent	N	10
	non-prime local VM messages sent	N	10
	prime remote VM messages sent	N	10
	non-prime remote VM messages sent	N	10
	prime CA text service headers created	N	10
	non-prime CA text service headers created	N	10
	prime VM text service headers created	N	10
	non-prime VM text service headers created	N	10
	community id	N	2
	prime VM undeliverable notifications	N	10
	non-prime VM undeliverable notifications	N	10
	prime total VM messages created	N	10
	non-prime total VM messages created	N	10
	prime broadcast messages created	N	10
	non-prime broadcast messages created	N	10
	prime log-in announcements created	N	10
	non-prime log-in announcements created	N	10
	prime priority messages created	N	10
	non-prime priority messages created	N	10
	prime private messages created	N	10
	non-prime private messages created	N	10
	starting date	D	8
	ending time	T	4
	local voice components received - prime	N	10
	local voice components received - non-prime	N	10
	local FAX components received - prime	N	10
	local FAX components received - non-prime	N	10
	local binary attachments received - prime	N	10
	local binary attachments received - non-prime	N	10
	local text components received - prime	N	10
	local text components received - non-prime	N	10
	remote voice components received - prime	N	10
	remote voice components received - non-prime	N	10
	remote FAX components received - prime	N	10
	remote FAX components received - non-prime	N	10
	remote binary attachments received - prime	N	10
	remote binary attachments received - non-prime	N	10
	remote text components received - prime	N	10
	remote text components received - non-prime	N	10
	call answer voice components - prime	N	10
	call answer voice components - non-prime	N	10
	call answer FAX components - prime	N	10
	call answer FAX components - non-prime	N	10
	voice components created - prime	N	10
	voice components created - non-prime	N	10
	FAX components created - prime	N	10
	FAX components created - non-prime	N	10
	binary attachments created - prime	N	10
	binary attachments created - non-prime	N	10
	text components created - prime	N	10
	text components created - non-prime	N	10
	local voice components sent - prime	N	10
	local voice components sent - non-prime	N	10
	local FAX components sent - prime	N	10
	local FAX components sent - non-prime	N	10
	local binary attachments sent - prime	N	10
	local binary attachments sent - non-prime	N	10
	local text components sent - prime	N	10
	local text components sent - non-prime	N	10
	remote voice components sent - prime	N	10
	remote voice components sent - non-prime	N	10
	remote FAX components sent - prime	N	10
	remote FAX components sent - non-prime	N	10
	remote binary attachments sent - prime	N	10
	remote binary attachments sent - non-prime	N	10
	remote text components sent - prime	N	10
	remote text components sent - non-prime	N	10

Example

The following command retrieves the INTUITY AUDIX List Measurements Subscriber Day data for September 27, 2001, for all of the INTUITY AUDIX system subscribers in Department 27 and writes output to a file named trafd27:

gettraf -f day -d 092701 < subs.d27 > trafd27

The number of records in the output file will be the same as the number of subscriber extensions input to the gettraf command.

The following data is written to the file:

"Doe,John","56789",296,1200,312,0,0,0,2,0,0,0,66,0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,
20010927,2359