ADDRESS VOX Commands › Notification Manager Database Maintenance Commands › LISTENTITY Command

LISTENTITY Command

The LISTENTITY command lists all the data for one or more entities (except the password).

This command has the following format:

ADDRESS VOX "LISTENTITY NAME(name)|KEY(key)
  [CMDRESP(destination)]  
  [PREFIX(varname)]"

NAME

Specifies the name of the entity to be listed. * indicates that you want data for all entities to be listed.

KEY

Specifies the key of the entity to be listed.

CMDRESP

(Optional) Directs return information, if any, to a specific destination. For a list of valid destination values, see the section ADDRESS VOX Return Information.

Default: REXX

PREFIX

(Optional) Specifies the name of the REXX stem variable (other than the default name) that contains the return information for the command.

For information about changing the default variable name, see the section ADDRESS VOX Return Information.

Default: VOX.LISTENTITY

Return Information:

After LISTENTITY executes, it sets the special REXX return code variable RC.

• If the command executes successfully, the RC variable contains a value of zero. The VOX.listentity.0 variable contains the number of lines of information returned. Each variable from VOX.listentity.1 to VOX.listentity.n contains a line of information. n represents the last line of return information.
• If the command does not execute successfully, the RC variable contains a nonzero value. The VOX.ERROR variable contains the complete VOX error message, which includes the four digit return code and error message text.

Usage Note:

For more information, see the sample REXX program listent.rex located in the CA Automation Point installation directory \sample\nm.