RTVNETA (Retrieve Network Attributes)

RTVNETA Command syntax diagram

 

Purpose

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 CL variables.

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

 

Optional Parameters

SYSNAME

Specifies the name of the CL variable that receives the current system name. Specify the name of a character variable with a minimum length of 8 characters. If the system name has fewer characters than the variable allows, the value is padded on the right with blanks.

PNDSYSNAME

Specifies the name of the CL variable that receives the pending system name. Specify the name of the character variable with a minimum length of 8 characters. The value returned is blank if no pending system name is provided. If the system name has fewer characters than the variable allows, the value is padded on the right with blanks.

LCLNETID

Specifies the name of the CL variable that receives the current local network ID. Specify the name of the character variable with a minimum length of 8 characters. If the network ID has fewer characters than the variable allows, the value is padded on the right with blanks.

LCLCPNAME

Specifies the name of the CL variable that receives the current local control point. Specify the name of the character variable with a minimum length of 8 characters. If the control point has fewer characters than the variable allows, the value is padded on the right with blanks.

LCLLOCNAME

Specifies the local location name.

DFTMODE

Specifies the name of the CL variable that receives the default mode name. Specify the name of the character variable with a minimum length of 8 characters. If the default mode has fewer characters than the variable allows, the value is padded on the right with blanks.

NODETYPE

Specifies the name of the CL variable that receives the current APPN nodetype. Specify the name of the character variable with a minimum length of 8 characters.

The values that can be returned in the variable as the node type are:

*ENDNODE

The node does not provide network services to other nodes but may participate in the APPN network by using the services of an attached network server or may operate in a peer-to-peer environment similar to migration end nodes.

*NETNODE

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

*BEXNODE

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

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.

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 iSeries 400 is an SNA intermediate node.

-1

*REQUEST: The remote systems are requested to compress data when the iSeries 400 is an SNA intermediate node.

MAXINTSSN

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

RAR

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

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 control point name or network ID has fewer characters than the variable allows, the value is padded on the right with blanks. The list can contain 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 may contain the value *LCLNETID which specifies that the current network ID is used. If less than five node servers are specified, the remaining ones contain hexadecimal zeros for a name. As soon as the first null name is encountered in the list, it is safe to assume that the remaining names will also be null.

ALRSTS

Specifies the name of the CL variable that receives the current system 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 values that can be returned in the variable as the current system alert status are:

*ON

Alert processing is currently active.

*UNATTEND

Alert processing is currently active, but the system is unattended.

*OFF

Alert processing is currently inactive.

ALRPRIFP

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

The values that can be returned in the variable as the primary alert focal point are:

*NO

The system is not an alert primary focal point.

*YES

The system is an alert primary focal point.

ALRDFTFP

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

The values that can be returned in the variable as the default alert focal point are:

*NO

The system is not an alert default focal point.

*YES

The system is an alert default focal point.

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. You must specify the name of a character variable with a minimum length of 10 characters. If the back up system name has fewer characters than the variable allows, the value is padded on the right with blanks.

ALRRQSFP

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

ALRFTR

Specifies the name of the CL variable that receives the name of the active alert filter. You must 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.

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.

ALRLOGSTS

Specifies the name of the CL variable that receives the current alert logging status. Specify the name of a character variable with a minimum length of 10 characters.

The values that can be returned in the variable as the current alert logging status are:

*NONE

Do not log alerts.

*LOCAL

Log only locally generated alerts.

*RCV

Log only alerts received from other nodes.

*ALL

Log both locally generated and incoming alerts.

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 the name of a character 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 values that can be returned in the variable are:

*NONE

There is no controller for alerts.

controller-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).

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. Specify the name of a decimal variable with a total length of 5 digits without decimal positions. The maximum number of alerts that can be created before the alerts are sent is 32,767.

Note:

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 value that can be returned in the variable as the maximum number of alerts is:

*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.

MSGQ

Specifies the name of the CL variable that receives the group message queue name. This must be 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.

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.

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.

OUTQLIB

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.

JOBACN

Specifies the name of the CL variable that receives the current job action for input streams received through the network. Specify the name of a character 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 values that can be returned in the variable as the current job action are:

*FILE

Input streams received from the network are filed in the queue of network files for the user to which it was sent.

*REJECT

Input streams received from the network are rejected.

*SEARCH

The table of network job entries is searched to determine the action for any input streams received.

MAXHOP

Specifies the name of the CL variable that receives the maximum number of systems in the SNADS network so that a distribution queue originating at this node may 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 without decimal positions.

DDMACC

Specifies the name of the CL variable that receives the current system action for DDM or DRDA requests from other systems. Specify the name of a character 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 values that can be returned in the variable as the current system action for DDM requests are:

*REJECT

This system does not allow DDM or DRDA requests from remote systems. However, this system can still use DDM or DRDA to access files or SQL tables on remote systems. A remote system cannot access files or SQL tables on a 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.

program-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. iSeries 400 object level security still applies.

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 DDMACC parameter, the value for DDMACCLIB is all blanks.

PCSACC

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

The values that can be returned in the variable as the current system action for PCS requests are:

*REJECT

The system does not allow any PCS requests.

*OBJAUT

All PCS 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.

program-name

Specify the name of the customer supplied Client Access/400 host system application exit program that can supplement system object level security.

PCSACCLIB

Specifies the name of the CL variable that receives the name of the library that contains the PCS 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 PCSACC parameter, the value for PCSACCLIB is all blanks.

DFTNETTYPE

Specifies the name of the CL variable that receives the system default value for the integrated services digital network (ISDN) network type. The user must specify a character variable name with a minimum length of 10 characters.

The values that can be returned in the variable as the network type are:

*ATT This value is used when attaching to an ISDN that uses an AT&T interface.

*DBP1TR6 This value is used when attaching to an ISDN controlled by Germany's Post Telephone and Telegraph Administration (PPT). (Deutsche Bundespost 1TR6).

*ETSI This value is used when attaching to the ISDN that uses a European interface (ETSI, also known as EuroISDN standard).

*JAPAN This value is used when attaching to an ISDN that uses a Japanese interface.

*NISDN This value is used when attaching to an ISDN that uses a North American interface.

*NORTEL This value is used when attaching to an ISDN that uses the Northern Telecom interface.

*NORTHAMT1 This value is used when attaching to a channelized North American T1 interface.

DFTCNNLST

Specifies the name of the CL variable that receives the system default value for the ISDN connection list. The user must specify a character variable name with a minimum length of 10 characters.

ALWANYNET

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

NWSDOMAIN

Specifies the name of the CL variable that receives the LAN Server domain to which all Integrated PC Servers, also known as File Server Input/Output Processors (FSIOP), on the system belong. You must specify a character variable name with a maximum length of 8 characters.

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.

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.

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. The decimal variable must be of at least 5 digits length.

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.

ALWADDCLU

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.

MDMCNTRYID

Specifies the country or region identifier associated with a modem. The character variable must have a minimum length of 2 characters.

This defines the country-specific or region-specific default characteristics for modems which are internal to iSeries 400 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.

Examples for RTVNETA Example 1: Retrieving Current System Name and Number of Systems

DCL  VAR(&SNAME)  TYPE(*CHAR)  LEN(8)
DCL  VAR(&HOPS)  TYPE(*DEC)  LEN(5 0)
RTVNETA  SYSNAME(&SNAME)  MAXHOP(&HOPS)

This command retrieves the current system name and the maximum number of systems in a SNADS network so that a distribution queue entry can be received and rerouted on the path to its destination.

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.

Error messages for RTVNETA

*ESCAPE Messages

CPF1844

Cannot access network attribute &1.