Retrieve Network Attributes (RTVNETA)

Where allowed to run: Compiled CL program or interpreted REXX (*BPGM *IPGM *BREXX *IREXX) Threadsafe: No

Parameters Examples Error messages

The Retrieve Network Attributes (RTVNETA) command is used in a CL program or REXX procedure to retrieve the network attributes of the system. The values are returned (copied) to the specified variables in the program.

Restrictions: The attributes of the network attribute and the receiving variable must be compatible.

Top

---

 

Parameters

Keyword	Description	Choices	Notes
SYSNAME	CL var for SYSNAME (8)	Character value	Optional
PNDSYSNAME	CL var for PNDSYSNAME (8)	Character value	Optional
LCLNETID	CL var for LCLNETID (8)	Character value	Optional
LCLCPNAME	CL var for LCLCPNAME (8)	Character value	Optional
LCLLOCNAME	CL var for LCLLOCNAME (8)	Character value	Optional
DFTMODE	CL var for DFTMODE (8)	Character value	Optional
NODETYPE	CL var for NODETYPE (8)	Character value	Optional
DTACPR	CL var for DTACPR (10 0)	Decimal number	Optional
DTACPRINM	CL var for DTACPRINM (10 0)	Decimal number	Optional
MAXINTSSN	CL var for MAXINTSSN (5 0)	Decimal number	Optional
RAR	CL var for RAR (5 0)	Decimal number	Optional
NETSERVER	CL var for NETSERVER (85)	Character value	Optional
ALRSTS	CL var for ALRSTS (10)	Character value	Optional
ALRPRIFP	CL var for ALRPRIFP (10)	Character value	Optional
ALRDFTFP	CL var for ALRDFTFP (10)	Character value	Optional
ALRLOGSTS	CL var for ALRLOGSTS (7)	Character value	Optional
ALRBCKFP	CL var for ALRBCKFP (16)	Character value	Optional
ALRRQSFP	CL var for ALRRQSFP (16)	Character value	Optional
ALRCTLD	CL var for ALRCTLD (10)	Character value	Optional
ALRHLDCNT	CL var for ALRHLDCNT (5 0)	Decimal number	Optional
ALRFTR	CL var for ALRFTR (10)	Character value	Optional
ALRFTRLIB	CL var for ALRFTRLIB (10)	Character value	Optional
MSGQ	CL var for MSGQ (10)	Character value	Optional
MSGQLIB	CL var for MSGQLIB (10)	Character value	Optional
OUTQ	CL var for OUTQ (10)	Character value	Optional
OUTQLIB	CL var for OUTQLIB (10)	Character value	Optional
JOBACN	CL var for JOBACN (10)	Character value	Optional
MAXHOP	CL var for MAXHOP (5 0)	Decimal number	Optional
DDMACC	CL var for DDMACC (10)	Character value	Optional
DDMACCLIB	CL var for DDMACCLIB (10)	Character value	Optional
PCSACC	CL var for PCSACC (10)	Character value	Optional
PCSACCLIB	CL var for PCSACCLIB (10)	Character value	Optional
DFTNETTYPE	CL var for DFTNETTYPE (10)	Character value	Optional
DFTCNNLST	CL var for DFTCNNLST (10)	Character value	Optional
ALWANYNET	CL var for ALWANYNET (10)	Character value	Optional
NWSDOMAIN	CL var for NWSDOMAIN (8)	Character value	Optional
ALWVRTAPPN	CL var for ALWVRTAPPN (10)	Character value	Optional
ALWHPRTWR	CL var for ALWHPRTWR (10)	Character value	Optional
VRTAUTODEV	CL var for VRTAUTODEV (5 0)	Decimal number	Optional
HPRPTHTMR	CL var for HPRPTHTMR (40)	Character value	Optional
ALWADDCLU	CL var for ALWADDCLU (10)	Character value	Optional
MDMCNTRYID	CL var for MDMCNTRYID (2)	Character value	Optional

Top

 

CL var for SYSNAME (8) (SYSNAME)

Specifies the name of the CL variable that receives the current system name. The variable must be a character variable with a minimum length of 8 characters.

Top

 

CL var for PNDSYSNAME (8) (PNDSYSNAME)

Specifies the name of the CL variable that receives the pending system name. The variable must be a character variable with a minimum length of 8 characters. If there is no pending system name, the value returned is blanks.

Top

 

CL var for LCLNETID (8) (LCLNETID)

Specifies the name of the CL variable that receives the local network ID. The variable must be a character variable with a minimum length of 8 characters.

Top

 

CL var for LCLCPNAME (8) (LCLCPNAME)

Specifies the name of the CL variable that receives the local control point name. The variable must be a character variable with a minimum length of 8 characters.

Top

 

CL var for LCLLOCNAME (8) (LCLLOCNAME)

Specifies the name of the CL variable that receives the default local location name. The variable must be a character variable with a minimum length of 8 characters.

Top

 

CL var for DFTMODE (8) (DFTMODE)

Specifies the name of the CL variable that receives the default mode name. The variable must be a character variable with a minimum length of 8 characters.

Top

 

CL var for NODETYPE (8) (NODETYPE)

Specifies the name of the CL variable that receives the APPN node type. The variable must be a character variable with a minimum length of 8 characters.

The following values can be returned in the CL variable:

*ENDNODE

The node does not provide network services to other nodes but can participate in the APPN network by using the services of an attached network server or can operate in a peer environment similar to low entry networking nodes.

*NETNODE

The node provides intermediate routing, route selection services, and distributed directory services for local users and to end nodes and low entry networking nodes that it is serving.

*BEXNODE

The node performs as a branch extender node. The node performs as an end node in the backbone APPN network, and performs as a network node server to end nodes within its local domain.

Top

 

CL var for DTACPR (10 0) (DTACPR)

Specifies the name of the CL variable that receives the current level of data compression. Specify the name of the decimal variable with a minimum length of 10 digits without decimal positions.

The values that can be returned in the variable as the data compression level are:

0

*NONE - Data compression is not allowed on the session.

-1

*REQUEST - Data compression is requested on the session by the local system. However, the request can be refused or changed to a lower compression level by the remote system. Data compression is allowed on the session if requested by the remote system.

-2

*ALLOW - Data compression is allowed on the session by the local system if requested by a remote system. The local system does not request compression.

-3

*REQUIRE - Data compression is required on the session. If the remote system does not change the levels of compression to the local system's exact requested levels, the session is not established. The data compression levels that the local system requires are the specified levels.

Top

 

CL var for DTACPRINM (10 0) (DTACPRINM)

Specifies the name of the CL variable that receives the current level of intermediate node data compression. Specify the name of the decimal variable with a minimum length of 10 digits without decimal positions.

The values that can be returned in the variable as the intermediate node data compression levels are:

0

*NONE - The remote systems are not notified of a need to compress data when the system is an SNA intermediate node.

-1

*REQUEST - The remote systems are requested to compress data when the system is an SNA intermediate node.

Top

 

CL var for MAXINTSSN (5 0) (MAXINTSSN)

Specifies the name of the CL variable that receives the maximum number of intermediate sessions. Specify the name of a decimal variable with a minimum length of 5 digits and no decimal positions.

Top

 

CL var for RAR (5 0) (RAR)

Specifies the name of the CL variable that receives the route addition resistance. Specify the name of a decimal variable with a minimum length of 5 digits and no decimal positions.

Top

 

CL var for NETSERVER (85) (NETSERVER)

Specifies the name of the CL variable that receives the list of network node servers. Specify the name of a character variable with a minimum length of 85 characters. If the server name or network ID has fewer characters than the variable allows, the value is padded on the right with blanks. The list contains five node servers. Each server has the form: Network ID (9 characters) followed by the server name (8 characters). There are no separators. The network ID can contain the value *LCLNETID, which specifies that the current network ID is used. If there are less than five node servers specified, the remaining ones contain blanks for a name. As soon as the first blank name is encountered in the list, it is safe to assume that the remaining names are also blank.

Top

 

CL var for ALRSTS (10) (ALRSTS)

Specifies the name of the CL variable that receives the alert status. Specify the name of a character variable with a minimum length of 10 characters. (If the alert status value has fewer characters than the variable allows, the value is padded on the right with blanks.)

The following values can be returned in the CL variable:

*ON

Alerts are created by the system for all alert conditions, except unattended conditions.

*OFF

Alerts are not created by the system.

*UNATTEND

Alerts are created by the system for all alert conditions, including messages for which *UNATTEND is specified for the Alert options (ALROPT) parameter of the Add Message Description (ADDMSGD) or Change Message Description (CHGMSGD) command.

Top

 

CL var for ALRPRIFP (10) (ALRPRIFP)

Specifies the name of the CL variable that receives the alert primary focal point. Specify the name of the CL variable with a minimum length of 10 characters. (If the alert primary focal point value has fewer characters than the variable allows, the value is padded on the right with blanks.)

The following values can be returned in the variable:

*NO

The system is not an alert primary focal point.

*YES

The system is an alert primary focal point.

Top

 

CL var for ALRDFTFP (10) (ALRDFTFP)

Specifies the name of the CL variable that receives the value for the alert default focal point. Specify a CL variable with a minimum length of 10 characters. (If the alert default focal point value has fewer characters than the variable allows, the value is padded on the right with blanks.)

The following values can be returned in the variable:

*NO

The system is not an alert default focal point.

*YES

The system is an alert default focal point.

Top

 

CL var for ALRLOGSTS (7) (ALRLOGSTS)

Specifies the name of the CL variable that receives the alert logging status. The variable must be a character variable with a minimum length of 7 characters.

The following values can be returned in the CL variable:

*NONE

No alerts are logged.

*LOCAL

Only locally created alerts are logged.

*RCV

Only alerts received from other nodes are logged.

*ALL

Both locally created alerts and alerts received from other nodes are logged.

Top

 

CL var for ALRBCKFP (16) (ALRBCKFP)

Specifies the name of the CL variable that receives the name of the system that provides alert focal point services if the primary focal point is unavailable. Specify the name of a character variable with a minimum length of 16 characters. (If the back up system name has fewer characters than the variable allows, the value is padded on the right with blanks.)

Top

 

CL var for ALRRQSFP (16) (ALRRQSFP)

Specifies the name of the CL variable that receives the name of the system that is requested to provide alert focal point services. Specify the name of a character variable with a minimum length of 16 characters. (If the requesting system name has fewer characters than the variable allows, the value is padded on the right with blanks.)

Top

 

CL var for ALRCTLD (10) (ALRCTLD)

Specifies the name of the CL variable that receives the name of the controller through which alert messages are sent to another system when alert processing is active. Specify a CL variable with a minimum length of 10 characters. (If the alert controller name has fewer characters than the variable allows, the value is padded on the right with blanks.)

The following values can be returned in the variable:

*NONE

There is no controller for alerts.

name

Specifies the name of the controller being used for alerts in an alert controller session. This controller is ignored if the system has a primary or default alert focal point (if, for example, the node is in another system's sphere of control).

Top

 

CL var for ALRHLDCNT (5 0) (ALRHLDCNT)

Specifies the name of the CL variable that receives the maximum number of alerts that are created before the alerts are sent over the alert controller session (ALRCTLD network attribute). The alerts are held (queued) by the system until the specified number of alerts have been created. This parameter can be used to manage alerts that are sent over a limited resource by reducing the number of times alerts are sent.

The ALRHLDCNT network attribute only applies when the ALRCTLD network attribute is used. When management services sessions, APPN, and sphere of control support are used, the ALRHLDCNT value is ignored.

The maximum number of alerts that can be created before the alerts are sent is 32,767. Specify the name of a decimal variable with a total length of 5 digits without decimal positions.

The following values can be returned in the variable:

-2

This value represents *NOMAX. The alerts are held indefinitely. The current alert hold count is the maximum value. The alerts can be sent at a later time by changing the ALRHLDCNT value to a lower value.

0-32767

Specifies the maximum number of alerts that can be created before being sent. Alerts have a "held" status until the maximum is reached. If the value 0 is specified, alerts are sent as soon as they are created.

Top

 

CL var for ALRFTR (10) (ALRFTR)

Specifies the name of the CL variable that receives the name of the active alert filter. Specify the name of a character variable with a minimum length of 10 characters. (If the alert filter name has fewer characters than the variable allows, the value is padded on the right with blanks.)

Top

 

CL var for ALRFTRLIB (10) (ALRFTRLIB)

Specifies the name of the CL variable that receives the name of the library that contains the alert filter definition. Specify the name of a character variable with a minimum length of 10 characters. If the library name has fewer characters than the variable allows, the value is padded on the right with blanks.

Top

 

CL var for MSGQ (10) (MSGQ)

Specifies the name of the CL variable that receives the system default network message queue name. Specify the name of a character variable with a minimum length of 10 characters. (If the message queue name has fewer characters than the variable allows, the value is padded on the right with blanks.)

Top

 

CL var for MSGQLIB (10) (MSGQLIB)

Specifies the name of the CL variable that receives the name of the library that contains the system-default network message queue. Specify the name of a character variable with a minimum length of 10 characters. (If the library name has fewer characters than the variable allows, the value is padded on the right with blanks.)

Top

 

CL var for OUTQ (10) (OUTQ)

Specifies the name of the CL variable that receives the system default network output queue name. Specify the name of a character variable with a minimum length of 10 characters. (If the output queue name has fewer characters than the variable allows, the value is padded on the right with blanks.)

Top

 

CL var for OUTQLIB (10) (OUTQLIB)

Specifies the name of the CL variable that receives the name of the library that contains the system-default network output queue. Specify the name of a character variable with a minimum length of 10 characters. (If the library name has fewer characters than the variable allows, the value is padded on the right with blanks.)

Top

 

CL var for JOBACN (10) (JOBACN)

Specifies the name of the CL variable that receives the current job action for job streams received through the network. Specify the variable with a minimum length of 10 characters. (If the job action value has fewer characters than the variable allows, the value is padded on the right with blanks.)

The following values can be returned in the CL variable:

*REJECT

The input stream is rejected by the system. This action allows you to secure your system from job streams received through the network.

*FILE

The input stream is filed in the queue of network files received by the user to whom it was sent. That user can then view, end, or receive the input stream, or submit the input stream to a job queue.

*SEARCH

The table of network job entries is searched to determine the action taken for the input stream.

Top

 

CL var for MAXHOP (5 0) (MAXHOP)

Specifies the name of the CL variable that receives the maximum number of times in the SNADS network that a distribution queue originating at this node can be received and rerouted on the path to its final destination. Specify the name of a decimal variable with a total length of 5 digits, and no decimal positions.

Top

 

CL var for DDMACC (10) (DDMACC)

Specifies the name of the CL variable that receives the current system action for DDM or DRDA requests from other systems. Specify the CL variable with a minimum length of 10 characters. (If the DDM access value has fewer characters than the variable allows, the value is padded on the right with blanks.)

The following values can be returned in the CL variable:

*REJECT

This system does not allow DDM and DRDA requests from remote systems. However, this system can still use DDM or DRDA to access files or SQL tables on remote systems. Source (client) systems cannnot access files or SQL tables on any other system that specifies *REJECT.

*OBJAUT

If the user profile associated with the DDM or DRDA job is authorized to the files, all file or remote SQL requests are accepted. Object authorities such as read, write, or update must also exist for the files.

name

Specifies the name of the customer validation program that can supplement object level security. This user-exit program can restrict user access to *PUBLIC and private files. The target DDM support calls the user program for each reference to a file. The user-exit program indicates to DDM if the request should proceed or end. In the case of DRDA use, the validation program is called only for connection requests, not for individual file access.

Top

 

CL var for DDMACCLIB (10) (DDMACCLIB)

Specifies the name of the CL variable that receives the name of the library that contains the DDM access program. Specify the name of a character variable with a minimum length of 10 characters. (If the library name has fewer characters than the variable allows, the value is padded on the right with blanks.) If *REJECT or *OBJAUT is returned for the CL var for DDMACC (10) (DDMACC) parameter, the value for this parameter is all blanks.

Top

 

CL var for PCSACC (10) (PCSACC)

Specifies the name of the CL variable that receives the current system action for iSeries Access requests. Specify a CL variable with a minimum length of 10 characters. (If the iSeries Access access value has fewer characters than the variable allows, the value is padded on the right with blanks.)

The following values can be returned in the CL variable:

*REJECT

The system does not allow any iSeries Access requests.

*OBJAUT

All iSeries Access requests are allowed and controlled by the object authorizations on the system.

*REGFAC

The registration facility is used to determine exit programs for the different servers. If no program is defined in the registration facility, *OBJAUT is used.

name

The name of the customer supplied iSeries Access host system application exit program that can supplement system object level security.

Top

 

CL var for PCSACCLIB (10) (PCSACCLIB)

Specifies the name of the CL variable that receives the name of the library that contains the iSeries Access access program. You must specify the name of a character variable with a minimum length of 10 characters. (If the library name has fewer characters than the variable allows, the value is padded on the right with blanks.) If *REJECT, *REGFAC, or *OBJAUT is returned for the CL var for PCSACC (10) (PCSACC) parameter, the value for this parameter will be all blanks.

Top

 

CL var for DFTNETTYPE (10) (DFTNETTYPE)

Specifies the name of the CL variable that receives the system default value for the Integrated Services Digital Network (ISDN) network type. The operating system no longer uses this network attribute. Changes made to this network attribute have no effect. The variable must be a character variable with a minimum length of 10 characters.

Top

 

CL var for DFTCNNLST (10) (DFTCNNLST)

Specifies the name of the CL variable that receives the system default value for the ISDN connection list. The operating system no longer uses this network attribute. Changes made to this network attribute have no effect. The variable must be a character variable with a minimum length of 10 characters.

Top

 

CL var for ALWANYNET (10) (ALWANYNET)

Specifies the name of the CL variable that receives the network attribute that allows the Communications APIs to use other communication transports that are not native for that API. Examples include ICF over TCP/IP or Sockets over SNA. The variable must be a character variable with a minimum length of 10 characters.

Top

 

CL var for NWSDOMAIN (8) (NWSDOMAIN)

Specifies the name of the CL variable that receives the LAN Server domain to which all integrated PC Servers, also knows as File Server Input/Output Processors(FSIOP), on the system belong. The variable must be a character variable with a minimum length of 8 characters.

Top

 

CL var for ALWVRTAPPN (10) (ALWVRTAPPN)

Specifies the name of the CL variable that receives the current setting for the virtual APPN support. The character variable must have a minimum length of 10 characters.

Top

 

CL var for ALWHPRTWR (10) (ALWHPRTWR)

Specifies the name of the CL variable that receives the current setting for the HPR tower transport support. The character variable must have a minimum length of 10 characters.

Top

 

CL var for VRTAUTODEV (5 0) (VRTAUTODEV)

Specifies the name of the CL variable that receives the current setting for the maximum amount of automatically created APPC devices allowed on a virtual controller. Specify the name of a decimal variable with a total length of 5 digits, and no decimal positions.

Top

 

CL var for HPRPTHTMR (40) (HPRPTHTMR)

Specifies the name of the CL variable that receives the current settings for the maximum amount of time in minutes for the HPR path switch timers. This field requires a 40 character variable, each 10 characters represents one of the four timer values in the order of network, high, medium and low priority.

Top

 

CL var for ALWADDCLU (10) (ALWADDCLU)

Specifies the name of the CL variable that receives the value that specifies whether this system will allow another system to add it as a node in a cluster. The character variable must have a minimum length of 10 characters.

The values that can be returned in the variable for allow add to cluster are:

*NONE

No other system can add this system as a node in a cluster.

*ANY

Any other system can add this system as a node in a cluster.

*RQSAUT

Any other system can add this system as a node in a cluster only after the cluster add request has been authenticated.

Top

 

CL var for MDMCNTRYID (2) (MDMCNTRYID)

Specifies the name of the CL variable that receives the network attribute for the country or region identifier associated with a modem. The character variable must have a minimum length of 2 characters.

MDMCNTRYID defines the country-specific or region-specific default characteristics for modems which are internal to system I/O adapters. This value must be configured correctly to insure proper operation and, in some countries or regions, meet legal requirements. The adapter will fail the vary on of the line if modem country or region ID is not set.

Top

---

 

Examples

Example 1: Retrieving Current System Name

 DCL   VAR(&SNAME)  TYPE(*CHAR)  LEN(8)
RTVNETA   SYSNAME(&SNAME)

This command retrieves the current system name.

Example 2: Retrieving Virtual APPN Support, APPC Device Limits, and HPR Path Switch Timers

 DCL   VAR(&ALWVRTAPPN)  TYPE(*CHAR)  LEN(10)
DCL   VAR(&VRTAUTODEV)  TYPE(*DEC)  LEN(5 0)
DCL   VAR(&HPRPTHTMR)  TYPE(*CHAR)  LEN(40)
RTVNETA   ALWVRTAPPN(&ALWVRTAPPN)  VRTAUTODEV(&VRTAUTODEV)
          HPRPTHTMR(&HPRPTHTMR)

This command retrieves the current network attribute settings for allow virtual APPN support, automatically created APPC devices on a virtual controller, and the HPR path switch timers.

Top

---

 

Error messages

*ESCAPE Messages

CPF1844

Cannot access network attribute &1.

Top