This section describes the Entire Net-Work operator commands. It covers the following topics:
Although Entire Net-Work operates automatically, there are operator commands available to display or modify the status of the network and control the local Entire Net-Work node.
The Entire Net-Work commands described in this section are similar to Adabas operator commands. A summary and description of the operator commands for z/OS, BS2000/OSD are provided.
The Entire Net-WorkTCPX line driver has the ability to process operator commands that are directed to a specific link or directly to the driver. For more information about TCPX line driver operator commands, read TCPX Operator Commands.
The following table summarizes the Entire Net-Work operator commands:
| Use Command | Arguments | To |
|---|---|---|
| ADAEND | --- | Terminate Entire Net-Work session. |
| CLOSE | driver | Disconnect all links of a driver, then close the driver. |
| CLOSE NETPRNT | --- | Close the NETPRNT file and route all trace and snap output to DDPRINT. |
| CONNECT | link | (Re-) connect a link after a disconnect or handshake error. |
| DEFINE | link | Dynamically define a new link. |
| DISABLE | link | Disable a link (link cannot accept connects). |
| DISCONNECT | link | Disconnect a link. |
| DISPLAY | various | Display links, nodes, targets, paths or statistics. |
| DUMP | --- | Snap data areas, then terminate the Entire Net-Work session. |
| ENABLE | link | Enable a link (the link can accept connects). |
| END | --- | Terminate Entire Net-Work session. |
| FORCE | nodename or node ID | Broadcast a "node down" message. |
| HALT | --- | Terminate Entire Net-Work session. |
| HELP | --- | List available operator commands. |
| LOGDON | driver | Activates logging for the Simple Connection Line Driver. |
| LOGDOFF | driver | Deactivates logging for the Simple Connection Line Driver. |
| LOGLON | link | Activates logging for a specific link name. A wildcard can be used to activated logging for link names with certain characters in their names. |
| LOGLOFF | link | Deactivates logging for a specific link name. A wildcard can be used to deactivate link logging. |
| LOGTON | target | Activates logging for a specific target ID. |
| LOGTOFF | target | Deactivates logging for a specific target. |
| NETEND | --- | Terminate Entire Net-Work session. |
| OPEN | driver | Reopen a driver after a close or access method failure. |
| OPEN NETPRNT | --- | Open the NETPRNT file and route all trace and snap output to the NETPRNT file. |
| PROBE | nodename or node ID and bytes | Send a probe message to a node. |
| RESUME | link | Resume sending messages via this link. |
| SET | various | Change the values of Entire Net-Work parameters. Note: The minimum abbreviation for SET is the null string (zero characters long). |
| SNAP | --- | Snap data areas to DDPRINT. |
| START | driver | (Re-) start driver (then connect all links of driver). |
| STOP | --- | Terminate Entire Net-Work session. |
| SUSPEND | link | Stop sending messages on this link. |
| TERMINATE | --- | Terminate Entire Net-Work session. |
This section describes each of the operator commands in detail. The underlined portion of the command is the minimum abbreviation.
ADAEND END HALT NETEND STOP TERMINATE
Any one of the above commands can be used to terminate an Entire Net-Work session normally. The STOP operator command (for example, STOP taskid or P taskid) can be used in z/OS environments.
A check is made for any additional parameters. If one is found, the command is rejected and message NET0115 is issued. Thus, erroneous commands are rejected and an accidental termination of Entire Net-Work is avoided.
Once the termination command has been accepted by Entire Net-Work, no more requests are selected from the request queue. Message NET0999 is displayed on the operator console confirming that normal termination procedures have been started.
Note:
The DUMP command also ends
Entire Net-Work operation after performing a snap dump of pertinent data areas.
CLOSE driver
Terminate all activities of the driver by disconnecting and closing all links related to the driver, then closing the driver itself.
The effect of this command can be reversed by issuing the OPEN or START command for the driver, and CONNECT commands for the links (as appropriate).
CLOSE NETPRNT
Close the NETPRNT file and route all trace and snap output to the DDPRINT file. When the NETPRNT file is closed, the data set can be copied for sending to Software AG support, without shutting down Entire Net-Work. The file must be allocated SHR. This command cannot be abbreviated.
CONNECT linkname
Attempt to connect link linkname. The link name specified must match that used on the LINK statement. If the link was disconnected after a "handshaking" conflict, the CONNECT command can be used to retry the procedure. If the link is disabled, the CONNECT command can be used to enable it.
DEFINE LINK linkname={ link statement | LIKE linkname }
Define a link during Entire Net-Work operation. The link statement must adhere to the format described in the section about the related line driver.
Note:
DEFINE commands will only be accepted if the
NODE statement DEFINE parameter is set
to"Y" .
The LIKE linkname parameter can be used instead of the link statement to define a link by copying the parameters specified for a previously defined link. For example:
DEFINE LINK TOPSYS LIKE BOTSYS
Note:
DEFINE LINK, is permitted only if DEFINE=Y is specified on the NODE
statement
DISABLE linkname
Instructs the specified link not to accept any connections from other Entire Net-Work nodes. If the link is connected, it is disconnected and then disabled.
DISCONNECT linkname
Disconnect the specified link, which is connected to this node. The link name specified must be the same as that used on the LINK statement.
DISPLAY { ALINKS | CSCI | LINKS | LOGGING | NODES | PATHS | STATS | TARGETS | ZAPS }
[ {name | string* } ]
Displays current information about the specified network component. Only one component type (link, node, path, logging, statistics, target, or zaps) can be specified in a single DISPLAY command. The information is displayed in the form of Entire Net-Work messages. For more information, see the section Messages and Codes.
The optional second parameter serves to qualify the display request, thereby limiting the information displayed. At the same time, additional information is displayed for qualified DISPLAY LINK or DISPLAY NODES requests.
The possible qualifier values and their meanings depend on the type of request. A link name, node name, or (numeric) target ID may be specified. Alternatively, a string ending in a "wild card" character (*) may be used to indicate all links or nodes whose names start with the specified string. The asterisk (* ) alone may be used to produce a display of all links or nodes, but additional information is shown only for qualified display requests.
The following is an example of DISPLAY CSCI output:
F NETWK,D C NETQ002I: Csi Server -ESG111- Act Targ(00039) Srv(00013) NETQ002I: Csi Server ESQSRV Act Targ(00039) Srv(00012) NETQ002I: Csi Server TESTNAT Act Targ(01001) Srv(00011) NETQ002I: Csi Server KSPS2 Act Targ(01001) Srv(00010) NETQ002I: Csi Server KSPS1 Act Targ(01001) Srv(00009) NETQ002I: Csi Server -DAEKCO- Act Targ(01014) Srv(00008) NETQ002I: Csi Server KCOSRV4 Act Targ(01014) Srv(00007) NETQ004I: Registered Servers Display Function Complete
The following is an example of DISPLAY NODES output:
F NETWK,D N NET0122I: NODE FNODE (50752) LOCAL NET0122I: NODE ALSNODE (54080) DIST 000040 VIA LINK LNKE NET0122I: NODE ANODE (49472) DIST 000020 VIA LINK LNKA NET0122I: NODE ENODE (50496) DIST 000020 VIA LINK LNKE
A qualifier is used in the following example:
F NETWK,D N A* NET0122I: NODE ALSNODE (54080) DIST 000040 VIA LINK LNKE NET0123I: TARGETS: 00025 00171 00194 00175 00173 00018 00009 NET0123I: TARGETS: 00177 NET0122I: NODE ANODE (49472) DIST 000020 VIA LINK LNKA NET0123I: TARGETS: 00125 00192
The following is an example of DISPLAY PATHS output:
F NETWK,D P NET0122I: NODE ALSNODE (54080) DIST 000080 (001) VIA LINK LNKA NET0122I: NODE ALSNODE (54080) DIST 000040 (002) VIA LINK LNKE NET0122I: NODE ANODE (49472) DIST 000020 (001) VIA LINK LNKA NET0122I: NODE ANODE (49472) DIST 000040 (002) VIA LINK LNKE NET0122I: NODE ENODE (50496) DIST 000040 (002) VIA LINK LNKA NET0122I: NODE ENODE (50496) DIST 000020 (001) VIA LINK LNKE
The DISPLAY STATS command produces the same type of information found in the statistics displayed at the end of an Entire Net-Work session. A qualifier parameter, if given, would have no effect. The buffer usage statistics displayed depend on the operating system being used.
The following is an example of DISPLAY STATS output. It includes a NETB001I and a NETB009I for each active buffer pool, a set of NETB008I, NETB010I, and NETB012I for each subpool within the buffer pools, and a NETB013I for each operator command issued.
F NETWK,D STATS NETB000I: ---------------------------------------------------------------- NETB001I: Statistics For Buffer Pool COMN Loc = ANY NETB000I: ---------------------------------------------------------------- NETB008I: Req =( 13, 0, 10, 0) NETB010I: ELM =( 512, 512, 512, 512), Sz = 512 B NETB011I: Str =( 256, 256, 254, 252 ) K NETB012I: Exp =( 0, 1, 0, 0) NETB000I: ---------------------------------------------------------------- NETB008I: Req =( 1, 0, 0, 0) NETB010I: Elm =( 10, 10, 10, 2), Sz = 1 K NETB011I: Str =( 15, 15, 13, 13) K NETB012I: Exp =( 0, 1, 0, 0) NETB000I: ---------------------------------------------------------------- NETB008I: Req =( 1, 0, 0, 0) NETB010I: Elm =( 1, 1, 1, 1), Sz = 14K NETB011I: Str =( 14, 14, 0, 0) K NETB012I: Exp =( 0, 1, 0, 0) NETB000I: ---------------------------------------------------------------- NETB009I: High Allc= 285 Curr Allc = 285 Curr Avail = 267 K NETB000I: ---------------------------------------------------------------- NETB001I: Statistics For Buffer Pool PGFX Loc = ANY NETB000I: ---------------------------------------------------------------- NETB008I: Req =( 0, 0, 0, 0) NETB010I: Elm =( 64, 64, 64, 0), Sz = 4K NETB011I: Str =( 256, 256, 256, 256) K NETB012I: Exp =( 0, 0, 0, 0) NETB000I: ---------------------------------------------------------------- NETB009I: High Allc= 256 Curr Allc = 256 Curr Avail = 256 K NETB000I: ---------------------------------------------------------------- NETB013I: Combined Buffer Pools Size 541 K NETB000I: ----------------------------------------------------------------
The following is an example of DISPLAY TARGETS output:
F NETWK,D T NET0124I: TARGET 09777 (C-N) ACTIVE ON NODE ALSNODE NET0124I: TARGET 00009 (I-T) ACTIVE ON NODE ALSNODE NET0124I: TARGET 02048 (L-N) ACTIVE ON NODE ANODE NET0124I: TARGET 00237 (I-N) ACTIVE ON NODE ANODE NET0124I: TARGET 00238 (I-N) ACTIVE ON NODE ANODE NET0124I: TARGET 09888 (C-N) ACTIVE ON NODE ANODE NET0124I: TARGET 00234 (I-N) ACTIVE ON NODE ANODE NET0124I: TARGET 55769 (C-N) ACTIVE ON NODE ANODE
The DISPLAY ZAPS command lists, for each Entire Net-Work module, its name, assembly date, system maintenance level, and zap level. If zaps were applied after initial shipment, their numbers are listed as "Additional Zaps". The following is an excerpt from a DISPLAY ZAPS example:
F NETWK,D Z NET0037I: NETCLF (1998/11/10 SM=0001) ZAP LEVEL 0000
DUMP
Issue a snap dump, then end the Entire Net-Work session. DUMP is equivalent to the SNAP command followed by an ADAEND (or synonymous) command.
ENABLE linkname
Revokes a previously entered DISABLE command. The specified link is instructed to accept incoming connect requests. Enabling a disconnected link does not connect the link.
FORCE { nodename | nodeid }
Broadcasts a control message through the network to notify all Entire Net-Work nodes that the specified node is no longer available. This command is provided for diagnosis and exception handling, and should be used only on the advice of your Software AG technical support representative.
HELP
Lists the available Entire Net-Work operator commands with a short explanation of their function.
LOGDON TCPX
Activates logging for the Simple Connection Line Driver.
LOGDOFF TCPX
Deactivates logging for the Simple Connection Line Driver.
LOGLON {linkname[,linkname]... | (linkname[,linkname]...) | ALL }
Activates logging for currently defined links that match the linknames specified in the command. The link names can be specified in parentheses or out of parentheses. At least one link name or "ALL" must be specified. If you specify "ALL", logging is activated for all links. You can use an asterisk (*) as a wildcard at the end of a link name ("linkname*") to specify a pattern of link names; logging will be activated for all currently defined links that match the pattern.
In the following example, logging is activated for links named XYZ and for links beginning with the characters "ABCD".
LOGLON XYZ, ACBD*
LOGLOFF {linkname[,linkname]... | (linkname[,linkname]...) | ALL }
Deactivates logging for currently defined links that match the linknames specified in the command. The link names can be specified in parentheses or out of parentheses. At least one link name or ALL must be specified. If you specify ALL, logging is deactivated for all links. You can use an asterisk (*) as a wildcard at the end of a link name ("linkname*") to specify a pattern of link names; logging will be deactivated for all currently defined links that match the pattern.
In the following example, logging is deactivated for links named XYZ and for links beginning with the characters "ABCD".
LOGLOFF (XYZ, ACBD*)
LOGTON {target-ID[,target-ID]... | (target-ID[,target-ID]...) }
Activates logging for the targets specified in the command. The target IDs can be specified in parentheses or out of parentheses. At least one target ID must be specified. Valid target ID values range from "1" through "65535".
In the following example, logging is activated for targets 12 and 181.
LOGTON 12, 181
LOGTOFF {target-ID[,target-ID]... | (target-ID[,target-ID]...) | ALL }
Deactivates logging for the targets specified in the command. The target IDs can be specified in parentheses or out of parentheses. At least one target ID or ALL must be specified. If you specify ALL, logging is deactivated for all targets. Valid target ID values range from "1" through "65535".
In the following example, logging is deactivated for targets 12 and 181.
LOGTOFF (12, 181)
OPEN driver
Reopen an installed/defined line driver that was stopped due to an access method or other network or system failure, or by the CLOSE operator command. The driver name must be the same as that specified on a DRIVER statement. Note that this command is currently a synonym for the START command. For further information, see the explanation of the START command.
OPEN NETPRNT
Open the NETPRNT file and route all trace and snap output to NETPRNT. This command is necessary only after a CLOSE NETPRNT command has been used. It opens the NETPRNT file when Entire Net-Work is initialized. If the file is allocated SHR or OLD it will be erased when opened. This command cannot be abbreviated.
PROBE { nodename | nodeid } [ nnnn ]
The PROBE command verifies that the specified node is available and can be reached. Entire Net-Work issues internal probe commands for the same purpose during normal operation. PROBE routes an internal message to the specified node and back. If the node cannot be reached, this information is sent to all active nodes, updating the node status.
The optional second parameter specifies that nnnn bytes of random user data (64512 bytes maximum) are to be appended to the actual probe message. The exact length of the message sent can be calculated as follows:
70 + (nodestack size) + nnnn
where nodestack size is twice the number specified by the NODE statement parameter MAXPATH=, rounded up to the next multiple of 4. For example, with MAXPATH=4 (the default value) the following command results in a message of length 1078:
PROBE nodename 1000
The result of the operation is displayed on the operator console, as shown in the following example:
F NET1,PROBE TWO NET0136I: PROBE MESSAGE SENT NET0135I: PROBE FOR NODE TWO (0001.711 SEC) NET0120I: NODE TWO (62194) DIST 000030 VIA LINK TOFIVE NET0140I: VERSION v.r.s (1999/11/10)
RESUME linkname
Revokes a SUSPEND command for the specified link. The link's status changes to "active" and the link resumes sending queued messages.
SET parameter=value, [ ... ]
The SET command can be used to change Entire Net-Work parameter settings dynamically without interrupting network operations. The SET command itself may be omitted.
Multiple parameters can be specified with one SET command. The parameters allowed for the SET command are a subset of those defined on the Entire Net-Work NODE statement. This section covers the following topics:
SET CQTIMER=secs
The CQTIMER parameter of the SET command can be used to set the approximate waiting time allowed for a user or application to retrieve command results with a router-16-call before timeout occurs. For more information, read about the CQTIMER parameter of the NODE statement.
SET DUMP={ ALL | NONE | BLOCKS | TRACETAB | BUFFERS | LINKAREA | FORMAT }
The DUMP parameter of the SET command can be used to set the storage areas to be included in a dump when Entire Net-Work terminates abnormally. The information is printed to the NETPRNT file if it is open. Otherwise, it is printed to the DDPRINT file. SET DUMP can be used to reduce the amount of output generated during an abend, especially on large Entire Net-Work systems. This command cannot be abbreviated.
In general, the default value of ALL should be used so that all diagnostic information is available to Software AG support.
Multiple values can be specified, separated by commas and surrounded by parentheses. For example:
SET DUMP=(BLOCKS, TRACETAB, FORMAT)
If conflicting values are specified, the last value specified is used. In the following, for example, the value used is NONE:
SET DUMP=(BLOCKS, TRACETAB, NONE)
| Value | Description |
|---|---|
| ALL | All storage areas are dumped. This is the default value. |
| NONE | No storage areas are dumped. |
| BLOCKS | The major control blocks are dumped. |
| TRACETAB | The internal trace table is dumped. |
| BUFFERS | All internal buffer areas are dumped. |
| LINKAREA | All storage areas related to a driver and link are dumped. |
| FORMAT | The driver and link trace tables are formatted. |
SET LOG={ ON | OFF | YES | NO | FULL | SHORT }
The LOG parameter of the SET command can be used to regulate control flow and logging of selected data areas to the printer data set. For more information, read about the LOG parameter of the NODE statement.
SET LOGBUF={ ON | OFF | YES | NO}
The LOGBUF parameter of the SET command can be used to control the destination of log data. For more information, read about the LOGBUF parameter of the NODE statement.
SET LOGBUFSZ=[{0 | logbuffersize}]
The LOGBUFSZ parameter of the SET command can be used to specify the size of the log buffer. For more information, read about the LOGBUFSZ parameter of the NODE statement.
SET MAXPATH=linkcount
The MAXPATH parameter of the SET command can be used to set the maximum path link, specified in number of links, that a message from users on this node is expected to travel. For more information, read about the MAXPATH parameter of the NODE statement.
SET MSGFORM=message-format
The MSGFORM parameter of the SET command can be used to set the message format of console messages and DDPRINT output. For more information, read about the MSGFORM parameter of the NODE statement.
SET PASSWORD=password
The PASSWORD parameter of the SET command can be used to set the password that controls access to the Programmable Command Interface (PCI). For more information, read about the PASSWORD parameter of the NODE statement.
Note:
For security reasons, this command is accepted only through the
Programmable Command Interface.
SET REMCMD={ N | Y }
The REMCMD parameter of the SET command can be used to allow or disallow remote access to the Programmable Command Interface. For more information, read about the REMCMD parameter of the NODE statement.
SET REPLYTIM=secs
The REPLYTIM parameter of the SET command can be used to set the time, in seconds, that this node is to wait for a reply to a user request before timing out. For more information, read about the REPLYTIM Parameter of the NODE statement.
SET SNAPERR=[(msg1[,msg2][,msg3][,msg4]) | OFF]
Note:
The SET SNAPERR operator command does not work for all error
messages. Use SNAPERR only under the direction of your Software AG support
representative.
This optional parameter can be used for diagnostics. When specified correctly, it will take a snap dump whenever specific Entire Net-Work errors occur. For more information, read about the SNAPERR Parameter of the NODE statement.
To clear a SNAPERR setting, issue the operator command SET SNAPERR=OFF, or SET SNAPERR with no value specified.
SET { TRACE | TROFF | TRON }={ trace | (trace,...) }
The TRACE, TROFF, and TRON parameters of the SET command can be used to set the trace control parameters for performing program traces. For more information, read about the TRACE, TROFF, and TRON parameters of the NODE statement.
SET UCMSG={ N | Y }
The UCMSG parameter of the SET command can be used to control whether messages are issued in upper case or mixed case. For more information, see the UCMSG parameter of the NODE statement.
SET ULINK={ N | Y }
The ULINK parameter of the SET command can be used to allow or disallow multiple links to an adjacent Entire Net-Work node. For more information, see the ULINK parameter of the NODE statement.
For example, the following operator command:
F NODEA,SET CQTIMER=180,TRACE=OFF
is equivalent to the following NODE statement specification:
NODEA,CQTIMER=180,TRACE=OFF
SNAP { BPH | CQ | CURRMSG | LOGBUF | MAIN | MYBLK | TRACE | UBQ }
Issue a snap dump of selected data areas to the DDPRINT file and continue processing. (Under certain circumstances, a snap dump is performed internally at either normal or abnormal session end.)
The optional parameters are used to snap one or more specific data areas:
| Parameter | Area |
|---|---|
| BPH | Buffer pool headers. |
| CQ | Command queue. |
| CURRMSG | Message that Entire Net-Work mainline is currently working on. |
| LOGBUF | Log buffer. |
| MAIN | Header of mainline module. |
| MYBLK | Central control block. |
| TRACE | Internal trace table. |
| UBQ | UB-Queue (currently active Adabas commands). |
START drivername
Restart an installed line driver that was stopped due to an access method or other network or system failure, or by the CLOSE operator command. The driver name must be the same as that specified on a DRIVER statement. The START command is a synonym for the OPEN command.
SUSPEND linkname
Instructs the specified link to not send any more messages. However, Entire Net-Work can still queue messages on this link. The SUSPEND command is valid only if the link is active.
VERIFY target-id
The VERIFY command is used to verify whether a target is still active or present in the network.
This command will report on the status of the target. If the target is not active but still locally in the network, it is removed and will no longer be seen in the DISPLAY TARGETS command. If the target is active and on another node, the target, target attributes and node will be displayed. If the target is active locally, but is not known to Entire Net-Work, Entire Net-Work becomes aware of the target and broadcasts this information throughout the network.
Specify a valid numeric target-ID in the range from 1 to 65535 with this command.
Note:
This command potentially changes the status information within
Entire Net-Work. You should therefore use it with care, and have a clear understanding of
what's happening.
VERIFY command processing takes no action for virtual or relocatable targets managed by Adabas Cluster Services. It acts only on targets that are local to the Entire Net-Work node where the command is issued.
If Entire Net-Work believes that the target is active on this node, but the target is not actually active, Entire Net-Work changes the target’s current status on this node as no longer active and broadcasts this information throughout the network.
If the target is active locally, but is not known to Entire Net-Work, Entire Net-Work becomes aware of the target and broadcasts this information throughout the network.
If the target is not known in the network and is not active locally, error message NET0172 is issued and no action is taken.
If the target is active locally, but Entire Net-Work believes it is active on another node, correct the situation in two steps:
Issue the VERIFY command on the Entire Net-Work node where the target is believed to be active. This will make the target inactive in Entire Net-Work's view.
Issue the VERIFY command on the Entire Net-Work node where the target is currently active. This will make Entire Net-Work aware of the target in the correct location.
For example, the following command verifies whether target 181 is still in the network:
VERIFY 181
When the target is active and local to the node, one of the following messages is issued:
NET0171I Verify target 00181 already active NET0174I Verify target 00181 is relocatable or virtual
If the target is not present in the network, the following message is issued:
NET0172I Verify target 00181 not in this Net-Work
If the target is active and on another node, the following message is issued:
NET0124I: Target ttttt (a-a) active on node nnnnnnnn
where nnnnnnnn is the node name, ttttt is the target ID, and (a-a) are the attributes of the target.
If the target is locally active but is not known to Entire Net-Work, Entire Net-Work becomes aware of the target and issues the following broadcast message:
NET0042I Local Target 000181 active