Administration Guide
Administration Guide
for UNIX
Administration Guide
Version 4.1
This edition applies to the 4.1 Version of IBM Sterling Connect:Direct for UNIX and to all subsequent releases
and modifications until otherwise indicated in new editions.
Before using this information and the product it supports, read the information in Notices, on page 97.
CDUNXAG1107
Contents
Server Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Process Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Command Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Session Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Sterling Connect:Direct for UNIX Concepts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
User Authorization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Process Restart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Archive Statistics Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Sample Processes, Shell Scripts, and API Programs. . . . . . . . . . . . . . . . . . . . . 11
Sterling Connect:Direct for UNIX Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Sterling Connect:Direct for UNIX Configuration Files . . . . . . . . . . . . . . . . . . . . . 12
Sterling Connect:Direct for UNIX Directory Structure . . . . . . . . . . . . . . . . . . . . . 13
Sterling Connect:Direct for UNIX Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Task Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
IP Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
IPv4 Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
IPv6 Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Host Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Port Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Multiple Addresses, Host Names, and Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Using Masks for IP Address Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Glossary 85
Index 91
Notices 97
Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
IBM Sterling Connect:Direct for UNIX links technologies and moves all types of information
between networked systems and computers. It manages high-performance transfers by providing
such features as automation, reliability, efficient use of resources, application integration, and ease
of use. Sterling Connect:Direct for UNIX offers choices in communications protocols, hardware
platforms, and operating systems. It provides the flexibility to move information among mainframe
systems, midrange systems, desktop systems, and LAN-based workstations.
Sterling Connect:Direct for UNIX is based on client-server architecture. The Sterling
Connect:Direct for UNIX server components interact with the user interfaces (API, CLI, IBM
Sterling Connect:Direct Browser User Interface, and IBM Sterling Control Center) to enable
you to submit, execute, and monitor Sterling Connect:Direct for UNIX statements and commands.
Server Components
Sterling Connect:Direct for UNIX has the following server components:
Process Manager
The Process Manager (PMGR) is the daemon that initializes the Sterling Connect:Direct for UNIX
server environment. The PMGR provides the following functions:
Initializes Sterling Connect:Direct for UNIX
Accepts connection requests from Sterling Connect:Direct for UNIX client APIs and remote
nodes
Creates Command Manager and Session Manager child Processes to communicate with APIs
and remote nodes
Accepts requests from Command Managers and Session Managers when centralized Sterling
Connect:Direct for UNIX functions are required
Stops Sterling Connect:Direct for UNIX
Note: Any application, including End User Applications (EUA), can run on any computer as long as it can
connect to the PMGR.
Command Manager
A Command Manager (CMGR) is created for every API connection that is successfully established.
The number of Command Managers that a PMGR can create is system-dependent and limited by
the number of file descriptors available for each UNIX Process. The number of file descriptors set
up by the UNIX operating system may affect Sterling Connect:Direct for UNIX operation. You
must define enough file descriptors to handle the number of concurrent Sterling Connect:Direct for
UNIX sessions allowed, which can be as many as 999.
The CMGR provides the following functions:
Executes commands sent by the API and sends the results back to the API
Carries out the Sterling Connect:Direct for UNIX authentication procedure, in conjunction
with the API, to determine access to Sterling Connect:Direct for UNIX
Interacts with the PMGR when executing commands
Session Manager
The Session Manager (SMGR) is created and invoked by the PMGR when resources are available
and either a Process is ready to run or a remote node requests a connection with a local node. The
SMGR provides the following functions:
Performs the necessary Sterling Connect:Direct for UNIX work
Acts as a primary node (PNODE) and initiates Process execution
Acts as a secondary node (SNODE) to participate in a Process initiated by the PNODE
When an SMGR is created to execute a Process submitted to a node, it creates the connection to the
remote node. If the SMGR is started by the PMGR to execute local Processes, the SMGR runs each
Process on this session until all Processes are completed.
If an SMGR is created because a remote node initiated a connection, the SMGR completes the
connection. If the SMGR is started by the PMGR to execute remote Processes, the SMGR executes
remote Process steps supplied by the remote SMGR until the remote SMGR completes all of its
Processes.
The SMGR depends on the PMGR for Transmission Control Queue (TCQ) services and other
centralized services. Refer to the Transmission Control Queue on page 14 for an overview of the
TCQ.
User Authorization
Sterling Connect:Direct for UNIX can authorize local and remote users to perform certain Sterling
Connect:Direct for UNIX tasks. In order to use Sterling Connect:Direct for UNIX, each user must
have a record defined in the user authorization file, called userfile.cfg. Each local user must have a
record in the user authorization file, and remote users may be mapped to a local user ID in a proxy
relationship.
To provide a method of preventing an ordinary user from gaining root access through Sterling
Connect:Direct for UNIX, a second access file called the Strong Access Control (SACL) file is
created when you install Sterling Connect:Direct for UNIX and is named sysacl.cfg. The
root:deny.access parameter, which is specified in the sysacl.cfg file, allows, denies, or limits root
access to Sterling Connect:Direct for UNIX. If the SACL file is deleted or corrupted, access to
Sterling Connect:Direct for UNIX is denied to all users.
For more information about specifying user authorizations in the userfile.cfg and the sysacl.cfg
files, see Maintaining Access Information Files in the Sterling Connect:Direct for UNIX
Administration Guide.
Process Restart
Several facilities are provided for Process recovery after a system malfunction. The purpose of
Process recovery is to resume execution as quickly as possible and to minimize redundant data
transmission after a system failure. The following Sterling Connect:Direct for UNIX facilities are
available to enable Process recovery:
Process step restartAs a Process runs, the steps are recorded in the TCQ. If a Process is
interrupted for any reason, the Process is held in the TCQ. When you release the Process to
continue running, the Process automatically begins at the step where it halted.
Automatic session retryTwo sets of connection retry parameters are defined in the remote
node information record of the network map file: short-term and long-term. If you do not
specify a value for these parameters in the remote node information record, default values are
used from the local.node entry of the network map file. The short-term parameters allow
immediate retry attempts. Long-term parameters are used after all short-term retries are
attempted. Long-term attempts assume that the connection problem cannot be fixed quickly
and retry attempts occur after a longer time period, thus saving the overhead of connection
retry attempts.
Checkpoint restartThis feature is available with the copy statement.
Checkpoint restart can be explicitly configured within a copy step through the ckpt parameter.
(Refer to the IBM Sterling Connect:Direct for UNIX Processes Web site at
http://www.sterlingcommerce.com/documentation/processes/processhome.html) If it is not
configured in the copy step, it can be configured in the Initparms through the ckpt.interval
parameter. (See Maintaining the Initialization Parameters File in the Sterling Connect:Direct
for UNIX Administration Guide for more information on this parameter.)
Run Task restartIf a Process is interrupted when a run task on an SNODE step is executing,
Sterling Connect:Direct for UNIX attempts to synchronize the previous run task step on the
SNODE with the current run task step. Synchronization occurs in one of the following ways:
If the SNODE is executing the task when the Process is restarted, it waits for the task to
complete, and then responds to the PNODE with the task completion status. Processing
continues.
If the SNODE task completes before the Process is restarted, it saves the task results.
When the Process is restarted, the SNODE reports the results, and processing continues.
If synchronization fails, Sterling Connect:Direct for UNIX reads the restart parameter in the
run task step or the initialization parameters file to determine whether to perform the run
task step again. The restart parameter on the run task step overrides the setting in the
initialization parameter.
For example, if the SNODE loses the run task step results due to a Sterling Connect:Direct for
UNIX cold restart, Sterling Connect:Direct for UNIX checks the value defined in the restart
parameter to determine whether to perform the run task again.
Note: Run task restart works differently when Sterling Connect:Direct for UNIX runs behind a
connection load balancer. For more information on the considerations you need to know when
running Sterling Connect:Direct for UNIX in a load balancing environment, see the IBM
Sterling Connect:Direct for UNIX Release Notes, IBM Sterling Connect:Direct for UNIX
Administration Guide, and the Sterling Connect:Direct for UNIX Getting Started Guide.
Interruption of Process activity when the SNODE is a Sterling Connect:Direct for UNIX
nodeWhen the SNODE is a Sterling Connect:Direct for UNIX node and the PNODE
interrupts Process activity by issuing a command to suspend Process activity, deleting an
executing Process, or when a link fails or an I/O error occurs during a transfer, the Process is
placed in the Wait queue in WS status.
If Process activity does not continue, you must manually delete the Process from the TCQ.
Refer to the Sterling Connect:Direct for UNIX User Guide for command syntax and parameter
descriptions for the delete process command.
Note: You cannot issue a change process command from the SNODE to continue Process activity;
the Process can only be restarted by the PNODE, which is always in control of the session.
If you want to restore statistics files that have been archived, run the statrestore.sh script. It uses
the uncompress and tar commands to restore all the statistics files in the archive. You supply two
arguments to the statrestore command. The first argument is the directory path where the statistics
files are located and the second argument identifies the archived file name followed by as many
archived file names as you want to restore. Below is a sample statrestore command:
After files are restored, the statistics records can be viewed using the select statistics command.
cpunx.cd copy
sbunx.cd submit
The following table displays the file names of sample shell scripts. Modify the shell scripts as
required.
send.sh send
recv.sh receive
apicheck.C Same as apicheck.c, except that it is compiled with one of the C++
compilers listed in the Sterling Connect:Direct for UNIX User Guide.
exit_skeleton.C Same as exit_skeleton_c, except that it is compiled with one of the C++
compilers listed in the Sterling Connect:Direct for UNIX User Guide.
exit_sample.c This is the same program as the skeleton user exit program, except that
the security exit is demonstrated with code that approximates
PassTicket functionality.
sdksample.C This program exercises various commands using the SDK interface to
Sterling Connect:Direct for UNIX.
Initialization parameters file Provides information to the server to use at start up. During the
installation, you identify the settings necessary for the initialization
parameters file.
User authorization information Contains the local user information and remote user information record
file types. You customize this file during installation to map remote user IDs
to local user IDs and create remote user information records in the user
authorization information file.
Strong access control file Improves the security of Sterling Connect:Direct for UNIX and allows,
denies, or limits root access control. This file is created when you install
Sterling Connect:Direct for UNIX. If the file is deleted or corrupted,
access to Sterling Connect:Direct for UNIX is denied to all users.
Network map file Describes the local node and other Sterling Connect:Direct for UNIX
nodes in the network. You can define a remote node record for each
node that Sterling Connect:Direct for UNIX communicates with.
Server authentication key file Verifies client API connection requests. Only verified clients are granted
a connection.
Client configuration file Identifies the port and host name used by a client to connect to Sterling
Connect:Direct for UNIX.
Client authentication key file Identifies Sterling Connect:Direct for UNIX servers that a Sterling
Connect:Direct for UNIX client connects to. You can have multiple
entries for multiple servers.
Note: The secure+ directory is available only when Sterling Connect:Direct for UNIX Secure Plus is
installed.
d_dir/
stats
traces
src/
lib/
README cfg/
bin/ apicheck.c security/ secure+/ include/ xlate/ man1/ SACL/
example
files
cliapi/ certificates/
ndmapi.a ndmapi.h
libcd2g.so (not HP) user_exit.h ndmmsg.1
libcd2g.sl (HP only) trusted.txt user_exit2.h ndmxlt.1
libcdsna.so (not HP) cdunxsdk.h ndmpmgr.1
libcdsna.sl (HP only) export/ cdpmgr.1
libcdsnpsna.so ndmapi.cfg
libcdsp.so
libcdspsrvr.so import/ sysacl.cfg
libcdspsssl.so cd_node/
log/ default_recv.xlt
default_send.xlt
ndmcmgr locks/
cdpmgr cdcust
ndmpmgr ttlflst1.0
ndmsmgr nodes/ svcflst1.0
ndmcli cliflst1.0
direct cdver
ndmproc keys.client cdsnacfg (AIX LU6.2 only)
ndmproc.awk keys.server snaver.sh (AIX LU6.2 only)
ndmstat tcq_convert
ndmstat.awk template (Brixton SNA only)
ndmmsg diskfree
ndmxlt cliapi diskfree.so
ndmauths initparm.cfg cfg.convert
ndmauthc netmap.cfg spcust_sample1.sh
cdcustrpt userfile.cfg spcust_sample2.sh
cdsacomp msgfile.cfg spcust_sample3.sh
cdstatm msgfile.idx
cfgcheck
ndmumgr
cdmsgutil
initcnvt
statarch.sh
statrestore.sh
sample.cd
ndmview
ndmview.awk
initcnvt
Install.bin
lcu.jar
lcu.sh
ohj-jewt.jar (Secure+ only)
runjar.jar (Secure+ only)
SecureOHelp.jar (Secure+ only)
SPAdmin.jar (Secure+ only)
spadmin.sh (Secure+ only)
SPCli.jar (Secure+ only)
CPCliMessages.properties (Secure+
only)
spcli.sh (Secure+ only)
Cipher.txt (Secure+ only)
help4.jar (Secure+ only)
Note: See the following figure to view the work directory for a node.
A d_dir/work/cd_node directory is created for each node. The following figure displays the work
directory for multiple nodes and illustrates the working files created for each node, such as TCQ
files:
d_dir/
ndm/ work/
Task Overview
The following table guides you to the information required to perform Sterling Connect:Direct for
UNIX installation tasks:
Task Reference
Understanding Sterling Connect:Direct for UNIX Chapter 1, About Sterling Connect:Direct for
UNIX
Task Reference
Setting up the Sterling Connect:Direct for UNIX server Chapter 2, Installing Sterling Connect:Direct
for UNIX
Setting up the Sterling Connect:Direct for UNIX client Chapter 2, Installing Sterling Connect:Direct
for UNIX
Creating the Strong Access Control file and changing file Chapter 2, Installing Sterling Connect:Direct
permissions on session manager, process manager, for UNIX
command manager, and user manager programs.
Installing Sterling Connect:Direct for UNIX File Agent Chapter 2, Installing Sterling Connect:Direct
for UNIX
Installing Sterling Connect:Direct for UNIX Secure Plus Chapter 2, Installing Sterling Connect:Direct
for UNIX
Managing files with Sterling Connect:Direct for UNIX File Chapter 3, Managing Files with Sterling
Agent Connect:Direct File Agent
Configuration files define the operating environment for Sterling Connect:Direct. The following
configuration files are created during the customization procedure:
Initialization parameters file
Client configuration parameters file
Network map file
Two access files: userfile.cfg and sysacl.cfg
After the initial customization, you can modify these files, if necessary. This chapter provides you
with the information to modify the configuration files.
ndm.path:path=/ndm/users/c:
Record names and parameter names are not case sensitive. Parameter values are case sensitive.
Lines 7 through 23 illustrate a longer logical record. Line 7 contains the record name local.node
followed by an optional colon (:) and a backslash (\) character. All lines between 7 and 23 end with
a backslash (\) character. Line 23 does not contain a backslash (\) character, to indicate the end of
the record.
The following table displays a portion of the initialization parameters file to illustrate the format of
Sterling Connect:Direct configuration files:
13 .
. . . .
21 .
Configuration files allow duplicate but not identical records, in some cases. For example, you can
define more than one remote node information (rnode.listen) record in the initialization parameters
file.
$ d_dir/etc/cdcust
Initialization parameters determine various Sterling Connect:Direct settings that control system
operation. The initialization parameters file is created when you install Sterling Connect:Direct for
UNIX and can be updated as needed.
You can modify Sterling Connect:Direct initialization parameters file using any text editor. Before
changing a value in the file, first shut down the Sterling Connect:Direct server. After you change a
value and save the file, restart the server. Restarting the server validates the new values and
generates an error message if a value is invalid. All available parameters are described in this
chapter.
If you use Sterling Connect:Direct Browser User Interface to update parameters in the Local Node
Connection Record, you do not have to stop and restart the server.
Note: You can also use the Sterling Connect:Direct Browser User Interface to perform some of the
procedures in this chapter. To learn more about the Sterling Connect:Direct Browser User Interface,
see the documentation on the Sterling Connect:Direct Browser User Interface CD-ROM or available
online from the IBM Documentation Library.
Transmission Control Queue (TCQ) informationThe tcq record defines how long a Process
is held in error before being deleted.
Global copy parametersThe copy.parms record defines default parameters used by the
Copy operation including checkpoint parameters, file size limitations, translation table
information, exception handling, CRC checking, file allocation retry parameters, and
compression options.
Global run task parametersThe runtask.parms record defines a parameter to define the
restart option.
Statistics file informationThe stats record includes parameters to define default statistics
file information including file size limitations, the type of information to write to the statistics
file, and how long to maintain statistics files before archiving them.
Server authentication informationThe authentication record parameters to authenticate the
server.
User exit parametersThe user.exits record defines the programs used during a user exit
procedure.
Firewall navigation informationThe firewall.parms record defines the ports or range of
ports to use for outbound sessions when a server operates behind a firewall.
The following sample initialization parameters file shows how some of these parameters are
specified:
# Miscellaneous Parameters
ndm.path:path=/sci/users/mscarbro/cd4000:\
:snode.work.path=/sci/users/mscarbro/cd4000/shared:
ndm.node:name=mws_joshua_4000:
ndm.pam:service=cdlogin:
ndm.quiesce:quiesce.resume=n
proc.prio:default=10:
restrict:cmd=y
# TCQ information
tcq:\
:max.age=8:
# Authenticator
authentication:\
:server.program=/sci/users/mscarbro/cd4000/ndm/bin/ndmauths:\
:server.keyfile=/sci/users/mscarbro/cd4000/ndm/security/keys.server:
# Secure+ parameters
secure+:\
:certificate.directory=/home/nis02/jlyon/certs: \
:s+cmd.enforce.secure.connection=n:
path The path to all Sterling Connect:Direct subdirectories and path specification
files.
snode.work.path The path to the shared work area for SNODE work files. path specification
Note: Specify the same path for all nodes in a cluster.
name The name of the The maximum length is 16 bytes. If a node name is longer, the
node. name will be truncated.
default The default value of the Process priority. 115. The default value is 10.
15 is the highest priority.
comm.transport The transport protocol for the remote node. tcp | lu62 | blklu62 | udt33
tcpFor TCP/IP connections
lu62For AIX SNA LU6.2
connections
blklu62For other LU6.2
connections
udt33For UDT connections
ckpt.interval The default number of bytes transmitted in a The maximum possible value
copy operation before a checkpoint is taken. is 1 terabyte (TB). The normal
Following is a list of the maximum number of value is 64KB.
digits for each byte interval:
noNo checkpointing
nnnnnnnnUp to an 8-digit decimal
nnnnnnnnKUp to an 8-digit decimal, where K
denotes 1024 bytes
nnnnnnnnMUp to an 7-digit decimal, where M
denotes 1048576 bytes
nnnnGUp to an 4-digit decimal, where G
denotes 1073741824 bytes
ulimit The action taken when the limit on a user output nIgnores the limit. n is the
file size is exceeded during a copy operation. default value.
yRecognizes the user file
size limit. If this limit is
exceeded during a copy
operation, the operation fails.
xlate.dir The name of the directory containing the Any valid directory.
translation tables. The default path is
d_dir/ndm/xlate.
xlate.send The default translation table used when sending Any valid directory.
data to a remote node. The default file name is
def_send.xlt.
xlate.recv The name of the default translation table used The default file name is
when copying data from a remote node. def_recv.xlt in the directory
defined in the xlate.dir
parameter.
ecz.windowsize The size of the compression window and history Valid values are 915. The
buffer. The larger the window, the greater the default is 13.
compression. However, increasing the window
uses more virtual memory.
retry.codes The codes to recognize as a file allocation retry Any valid error code
attempt. File allocation retry enables a Process
with a file allocation or open error on either the
local or remote node to run the Process again,
beginning at the copy step where the error
occurred. This feature supports the ability to
retry a Process that failed when a file is already
in use.
When a file allocation or open error occurs on
either the local or remote node, the PNODE
searches for the error or message ID in the
retry.codes and retry.msgids parameters. If the
error code or message ID is found, the Process
is retried.
Since error codes can vary from one operating
system to another and the same error code can
have different meanings, use message IDs to
identify retry conditions when communicating
between two different platforms.
You can perform retry attempts based on codes
only, IDs only, or a combination of the two.
When a retry condition is detected, the session
is terminated cleanly and the Process is placed
in the Timer queue.
retry.msgids Identifies the message IDs to use to support a Any of the valid file allocation
file allocation retry attempt. retry messages.
Since error codes can vary from one operating
system to another and the same error code can
have different meanings, use message IDs to
identify retry conditions when communicating
between two different platforms.
When a file allocation or open error occurs on
either the local or remote node, the PNODE
searches for the message ID in the retry.msgids
parameters. If the message ID is found, the
Process is retried.
You can perform retry attempts based on codes
only, message IDs only, or a combination of the
two.
When a retry condition is detected, the session
is terminated cleanly and the Process is placed
in the Timer queue.
max.age Specifies how old a statistics file must be before it is A 3-digit decimal number.
archived. Once a day, a shell script is executed that The default is 8 days.
identifies the statistics files that are as old as the 0no archiving.
max.age, runs the tar command and the compress
command to create a compressed archive, and then
deletes the statistics files that have been archived.
Running a Process generates multiple statistics records. To accommodate the large number of
statistics records generated, Sterling Connect:Direct closes the current statistics file and creates a
new statistics file at midnight every day. It can also close the current file before midnight if the file
size exceeds the value set for the file.size initialization parameter. The default file size is 1
megabyte.
Statistics files are stored in the d_dir/work/cd_node directory. Names of the statistics files are in the
format Syyyymmdd.ext, where yyyy indicates year, mm indicates month, and dd indicates day.
The extension (ext) begins as 001. The extension is incremented by one each time a new statistics
file is created in a single day.
Sterling Connect:Direct for UNIX provides a utility to archive and purge statistics files. You
identify when to archive a statistics file by setting the parameter, max.age. The max.age parameter
defines how old a statistics file must be before you want to archive the file. Once a day, the script
called statarch.sh is started. This script identifies the statistics files that are greater than or equal to
the max.age. It then runs the tar command and the compress command to create a compressed
archived file of all the statistics records that match the max.age parameter. Once the statistics files
are archived, these files are purged.
The archived files are stored in the directory where the statistics files and TCQ are stored. The shell
script, statarch.sh, is located in the ndm/bin directory. If necessary, modify the script to customize
it for your environment.
If you want to restore statistics files that have been archived, run the statrestore.sh script. It uses the
tar command to restore all the statistics files in the archive. Once files are restored, the statistics
records can be viewed using the select statistics command.
server.program The name and location of the server program used during The default is
the authentication procedure. ndmauths.
server.keyfile The name and location of the key file used during the The default is
authentication procedure. keys.server.
stats.exit.program The gateway control program used during the Name of the gateway control
user exit procedure. This exit is given control program.
for each statistics record that is written.
file.open.exit.program The file open exit program used during the Name of the file open exit
user exit procedure. It enables you to control program.
file names on both the sending and receiving
node. The exit is located so that it takes control
on the receiving (remote) node before the file
is opened.
This exit applies only to the copy statement
and provides access to all file control
parameters (including the data set name file
name, sysopt parameters, and disposition).
security.exit.program The security exit program used during the user Name of the security exit
exit procedure. This exit generates and verifies program.
passtickets, and it also supports other
password support programs, such as
PASSTICKET, part of the RACF security
system available on MVS hosts and also
supported by IBM on UNIX AIX and OS/2
computers using the NETSP product.
Note: Before you configure firewalls for use with UDT, refer to Appendix A, Configuring Firewall
Navigation, for information on the differences between UDT and TCP session establishment and
firewall navigation.
tcp.src.ports For TCP/IP connections, remote IP Valid IP address with an optional mask
addresses and the ports permitted for the upper boundary of the IP address
for the addresses when using a range and the associated outgoing port
packet-filtering firewall. This number or range of port numbers for the
parameter is required only if the specified IP address, for example:
local node acts as a PNODE. (199.2.4.*, 1000), (fd00:0:0:2015:*::*,
Place all values for an address 2000-3000), (199.2.4.0/255.255.255.0,
inside parentheses and separate 4000-5000),(fd00:0:0:2015::0/48, 6000,
each value for an address with a 7000)
comma. A wildcard character (*) is supported to
define an IP address pattern. If the
wildcard character is used, the optional
mask is not valid.
For more information on IP addresses,
masks, and ports, see Appendix
B, Specifying IP Addresses, Host
Names, and Ports.
tcp.src.ports.list.iterations The number of times that Sterling Any numeric value from 1255. The
Connect:Direct scans the list of default value is 2.
available ports to attempt a .
connection before going into a retry
state.
udp.src.ports For UDT connections, remote IP Valid IP address with an optional mask
addresses and the ports permitted for the upper boundary of the IP address
for the addresses when using a range and the associated outgoing port
packet-filtering firewall. This number or range of port numbers for the
parameter is recommended if a specified IP address, for example:
firewall is used whether the local (199.2.4.*, 1000), (fd00:0:0:2015:*::*,
node acts as a PNODE or an 2000-3000), (199.2.4.0/255.255.255.0,
SNODE. 4000-5000),(fd00:0:0:2015::0/48, 6000,
Place all values for an address 7000)
inside parentheses and separate A wildcard character (*) is supported to
each value for an address with a define an IP address pattern. If the
comma. wildcard character is used, the optional
mask is not valid.
For more information on IP addresses,
masks, and ports, see Appendix
B, Specifying IP Addresses, Host
Names, and Ports.
udp.src.ports.list.iterations The number of times that Sterling Any numeric value from 1255. The
Connect:Direct scans the list of default value is 2.
available ports to attempt a .
connection before going into a retry
state.
The client configuration file consists of parameter records that interface with End User Applications
(EUA). The client file includes the following parameters:
Sterling Connect:Direct API configuration parameters
Sterling Connect:Direct CLI configuration parameters
Client authentication parameters
You can modify Sterling Connect:Direct configuration files using any text editor. If you want to
create a new configuration file, use the cdcust command.
cli.parms:\
:script.dir=/home/qatest/jsmith/cdunix/hp/ndm/bin/:\
:prompt.string=Test CD on Medea:
api.parms:\
:tcp.hostname=alicia:\
:tcp.port=1393:\
:wait.time=50:
# Authenticator
authentication:\
:client.program=/home/qatest/jsmith/cdunix/hp/ndm/bin/ndmauthc:\
:client.keyfile=/home/qatest/jsmith/cdunix/hp/ndm/sc/keys.client:
tcp.port The TCP/IP port number to which Port number. The default is 1363.
the API usually connects.
wait.time The number of seconds to wait for Seconds to wait. The default is 50 seconds.
responses from the server. If this
limit is exceeded, the message ID
XCMG000I is displayed.
script.dir The directory where customized script files are stored. Specify Directory name.
this parameter if you have created a custom script to format the The default
output of the select statistics and select process commands.
directory is
The file names must be ndmstat and ndmproc.
ndm/bin/.
prompt.string Identifies the CLI prompt to display on the command line when Prompt string up to
the client is started. 32 characters. The
If the prompt string includes spaces or special characters, default is Direct.
enclose it in single or double quotation marks.
You can set the customized prompt in this parameter and at the
command line (using the -P parameter). If the prompt string is
specified in both places, the -P parameter at the command line
takes precedence.
When the default prompt is overridden, the new prompt string is
displayed in the Welcome banner and at the command prompt.
client.program The client program to use during authentication. Client program name.
The default is ndmauthc.
client.keyfile The key file to use during authentication. Client key file. The default is
keys.client.
This chapter describes the parameters in the network map file. This file is created when you install
Sterling Connect:Direct. If necessary, use a text editor to add or modify remote node records in the
network map file. You can modify the network map file dynamically while the server is running.
Note: You can also use the Sterling Connect:Direct Browser User Interface to perform some of the
procedures in this chapter. To learn more about the Sterling Connect:Direct Browser User Interface,
see the documentation on the Sterling Connect:Direct Browser User Interface CD-ROM or
available online from the IBM Documentation Library.
Note: If you are using TCP/IP, the local node can communicate with a remote node without a remote node
information record. Specify the required connection information in the submit command or the
Process statement.
Note: To insert comments about fields in the network map, be sure to place a # in the first column. If the
# is not in the first column, the comment is not ignored and the field is read.
long-term parameters after exhausting short-term attempts. Long-term attempts are set for less
frequent retries, because long-term attempts assume that the connection problem cannot be fixed
quickly.
Following are the local.node parameters. The parameters in bold are required.
comm.bufsize The buffer size for transmitting data to and The value for TCP/IP has no
from a remote node for TCP/IP limit (up to 2,147,483,623).
connections. For LU6.2, the maximum is
32000.
The default is 65536 bytes.
conn.retry.stwait The time to wait between retries The maximum value is limited
immediately after a connection failure to the highest value in the
occurs. The format is hh.mm.ss, where hh clock format, 23.59.59. The
specifies hours, mm specifies minutes, and default is 00.00.30, which is
ss specifies seconds. 30 seconds.
conn.retry.exhaust.action Action to take after the specified short and hold | delete
long-term retries have been used. holdPlaces Processes in
the hold queue in Held in
Error status, after all retry
attempts are used. This is the
default value.
deleteCauses the
Processes to be deleted from
the TCQ.
pacing.send.delay The time to wait between send operations The format is nnn.
to the remote node. The decimal number is No limit exists for the size of
the number of milliseconds between the this value.
end of one packet and the beginning of the
The default is 0, which
next packet. Time-based pacing does not
indicates no pacing of this
contribute to network traffic.
type.
The value for this parameter has no effect
on LU6.2 connections.
pacing.send.count The number of send operations to perform No limit exists for the size of
before automatically waiting for a pacing this value.
response from the remote node. The value The default is 0, which
for this parameter has no effect on LU6.2 indicates no pacing of this
connections. type.
tcp.api.bufsize The buffer size for transmitting data to and This value has no limit. The
from an Sterling Connect:Direct CLI/API. default is 32768 bytes.
tcp.api.inactivity.timeout This is the maximum time a CMGR waits 086399 (23 hours, 59
before exiting when it has not received a minutes, and 59 seconds)
command from a client program. The value is in seconds. The
default is 0, which indicates
no timeout occurs.
tcp.max.time.to.wait The maximum time the local node waits for 010000
a message from the remote node when The value is in seconds. The
using TCP/IP. When the time expires, the default value is 180.
Process is moved to the Timer queue and
Sterling Connect:Direct attempts to
re-establish a session with the remote
node. When set to 0, wait time is unlimited
unless limited by the operating system.
conn.retry.stwait The time to wait between retries The maximum value is limited to
immediately after a connection failure the highest value in the clock
occurs. The format is hh.mm.ss, where format, 23.59.59.
hh specifies hours, mm specifies The default is 00.00.30, which is
minutes, and ss specifies seconds. 30 seconds.
comm.bufsize The buffer size for transmitting data to The value for TCP/IP has no limit
and from a remote node. (up to 2,147,483,623).
For LU6.2, the maximum is
32000.
The default is 16000 bytes.
pacing.send.count The number of send operations to No limit exists for the size of this
perform before automatically waiting for value.
a pacing response from the remote The default is 0, which indicates
node. no pacing of this type.
The value for this parameter has no
effect on LU6.2 connections.
comm.bufsize The buffer size for transmitting The value for TCP/IP has no limit (up
data to and from a remote node to 2,147,483,623).
on TCP/IP connections. For LU6.2, the maximum is 32000.
The default is 65536 bytes.
comm.transport The transport protocol for the tcp | lu62 |blklu62 | udt33
remote node. tcpTCP/IP connections
lu62AIX SNA LU6.2 connections
blklu62Other LU6.2 connections
udt33UDT connections
conn.retry.stwait Time to wait between retries The maximum value is limited to the
immediately after a connection highest value in the clock format,
failure occurs. The format is 23.59.59.
hh.mm.ss, where hh specifies The default is 00.00.30, which is 30
hours, mm specifies minutes, seconds.
and ss specifies seconds.
pacing.send.count The number of send operations No limit exists for the size of this
to perform before automatically value.
waiting for a pacing response The default is 0, which indicates no
from the remote node. The value pacing of this type.
for this parameter has no effect
on LU6.2 connections.
You can control access to Sterling Connect:Direct through the following: the user authorization
information file, strong access control file, program directory, local and remote user information
records, and security exit.
Note: To disable access to the software for a local user, delete or comment out the local user information
record.
You can create a generic user ID by specifying an asterisk (*) as the user ID. If a user does not have
a specific local user information record, the user authorizations will default to those specified in this
generic record. If no generic local user information record is defined and no specific local user
information record is defined for the user, the user cannot use Sterling Connect:Direct.
Sterling Connect:Direct may optionally use remote user information records to translate remote
user IDs to valid local user IDs where Sterling Connect:Direct is installed. If an snodeid parameter
is not coded on the incoming Process, Sterling Connect:Direct uses this proxy relationship to
determine the rights of remote users to issue Sterling Connect:Direct commands and statements.
Sterling Connect:Direct for UNIX uses the asterisk (*) character to establish generic mappings that
facilitate mapping remote user IDs to local user IDs. The asterisk matches the node name or the host
name. For example, you can specify *@node name to map the remote user ID to all user IDs at one
node name, specify id@* to map to a specific user ID at all node names, or specify *@* to match
all users at all node names.
The following table displays sample remote user ID mappings to local user IDs using the special
characters:
You can generate all the records through the script-based customization procedure or generate only
one or two records and use a text editor to generate additional records. After customization, you
may want to modify some of the parameters. Use cdcust to create a new user file or a text editor to
modify the file as necessary.
[email protected]:\
:local.id=sam:\
:pstmt.upload=y:\
:pstmt.upload_dir=/home/qatest/username/ndm/uploaddir:\
:pstmt.download=y:\
:pstmt.download_dir=/home/qatest/username/ndm/downloaddir:\
:pstmt.run_dir=/home/qatest/username/ndm/rundir:\
:pstmt.submit_dir=/home/qatest/username/ndm/submitdir:\
:descrip=:
sam:\
:admin.auth=y:\
:pstmt.copy.ulimit=y:\
:pstmt.upload=y:\
:pstmt.upload_dir=/home/qatest/username/ndm/uploaddir:\
:pstmt.download=y:\
:pstmt.download_dir=/home/qatest/username/ndm/downloaddir:\
:pstmt.run_dir=/home/qatest/username/ndm/rundir:\
:pstmt.submit_dir=/home/qatest/username/ndm/submitdir:\
:name=:\
:phone=:\
:descrip=:
:cmd.s+conf=n:
pstmt.copy.ulimit The action taken when the limit on a user y | n | nnnnnnnn | nnnnnnnnK |
output file size is exceeded during a copy nnnnnnnM | nnnnG
operation. The value for this parameter yHonors the user file size limit. If
overrides the equivalent value for the ulimit this limit is exceeded during a copy
parameter in the initialization parameters file. operation, the operation fails.
nIgnores the limit. The default is
n.
nnnnnnnn, nnnnnnnnK, nnnnnnnM,
or nnnnGEstablishes a default
output file size limit for all copy
operations. K denotes 1024 bytes.
M denotes 1048576 bytes. G
denotes 1073741824 bytes. The
maximum value you can specify is
1 TB.
pstmt.upload Determines if the user can send files from this y|n
local node. If a file open exit is in use, this yAllows the user to send files.
parameter is passed to the exit, but it is not The default is y.
enforced.
nPrevents the user from sending
files.
pstmt.upload_dir The directory from which the user can send Directory path name
files. If a value is set for this parameter, then
files can only be sent from this directory or
subdirectories. If a file open exit is in use, this
parameter is passed to the exit, but it is not
enforced. If this parameter is defined, file
names in Copy statements must be relative to
this directory. Absolute path names can be
used, but the path must coincide with this
specification.
pstmt.download_dir The directory to which the user can receive Directory path name
files. If a value is set for this parameter, then
files can only be received to this directory or
subdirectories. Otherwise, they can be
received to any directory. If a file open exit is
in use, this parameter is passed to the exit, but
it is not enforced.
pstmt.runjob Specifies whether the user can issue the run y|n
job statement. yAllows the user to issue the
statement.
nPrevents the user from issuing
the statement. The default is n.
pstmt.runtask Specifies whether the user can issue the run y|n
task statement. yAllows the user to issue the
statement.
nPrevents the user from issuing
the statement. The default is n.
pstmt.submit_dir The directory from which the user can submit Directory path name
Processes. This is for submits within a
Process.
pstmt.crc Gives the user the authority to specify the use y|n
of CRC checking in a Process statement. yAllows a user to specify CRC
Setting this parameter to y enables the user to checking on a Process statement.
override the initial settings in the initialization nPrevents a user from specifying
parameters or network map settings files. CRCchecking on a Process
statement. The default is n.
If the same parameter is specified in the remote user information record and the local user
information record, the parameter in remote user information record takes precedence unless it is a
null value. When a null value is specified in the remote record, the local user record takes
precedence.
Note: To prevent the remote user from using Sterling Connect:Direct, delete or comment out the remote
user information, unless the remote user specifies an SNODEID parameter in the Process.
The remote user information record is remote userid@remote node name. It specifies the user and
remote node name pair defined as a remote user. This value becomes the key to the record and must
be unique. Create a remote user information record for each user on a remote node that will
communicate with this local node.
Following are the parameters for the remote user information record:
pstmt.upload_dir The directory from which the user can Directory path name
send files. If a value is set for this
parameter, then files can only be sent
from this directory or subdirectories. If a
file open exit is in use, this parameter is
passed to the exit, but it is not enforced. If
this parameter is defined, file names in
Copy statements must be relative to this
directory. Absolute path names can be
used, but the path must coincide with this
specification.
pstmt.download_dir The directory to which the user can Directory path name
receive files. If a value is set for this
parameter, then files can only be received
to that directory or subdirectories.
Otherwise, they can be received to any
directory. If a file open exit is in use, this
parameter is passed to the exit, but it is
not enforced.
pstmt.run_dir The directory that contains the programs Directory path name
and scripts the user can execute with run
job and run task statements. Any
attempt to execute a program or script
outside the specified directory fails.
To restrict the use of special characters in
the run directory, be sure to configure Y
for the restrict:cmd initialization
parameter. For more information on
specifying the restrict:cmd initialization
parameter, see Restricting the Use of
Special Characters in the Run Directory
on page 23.
pstmt.submit_dir The directory from which the user can Directory path name
submit Processes. This is for submits
within a Process.
Note: Even if you do not want to limit root access through Sterling Connect:Direct for UNIX, the
sysacl.cfg file must exist. If the file is deleted or corrupted, all users are denied access to Sterling
Connect:Direct for UNIX.
The file layout of the sysacl.cfg file is identical to the user portion of the userfile.cfg file. Setting a
value in the sysacl.cfg file for a user overrides the value for that user in the userfile.cfg file.
The root:deny.access parameter, which is specified in the sysacl.cfg file, allows, denies, or limits
root access to Sterling Connect:Direct. This parameter is required. The following values can be
specified for the root:deny.access parameter:
If a user is denied access because the root:deny.access parameter is defined in the sysacl.cfg file
for that user, a message is logged, and the session is terminated. If a user is running a limited ID, an
informational message is logged.
Security Exit
The Security Exit in the initialization parameters file, initparm.cfg, provides an interface to
password support programs.
This exit generates and verifies passtickets and it also supports other password support programs.
An example of other programs is PASSTICKET, part of the RACF security system available on
MVS hosts and also supported by IBM on UNIX AIX and OS/2 computers using the NETSP
product.
Refer to Chapter 3, Maintaining the Initialization Parameters File, for information on the Security
Exit.
This chapter contains information about client and server authentication key files. You can edit both
key files with any text editor installed on your system.
hostname The host name of the server with which you want to 116 characters and must be
communicate or the host name of the API you will unique within its key file.
allow to communicate with your server. The
hostname is followed by one or more space
characters. If you replace the host name with an
asterisk (*) character in the server configuration file,
the server accepts a connection from any API with a
matching key. You can use only one asterisk per file.
Always place the entry with the asterisk after entries
with specific host names.
MRLN SIMP A required character string, separated from the other Character string
fields by one or more spaces.
key The security key. Separate the key from SIMP by Up to 22 characters long
one or more spaces. including A to Z, a to z, 0 to 9,
period (.), and
slash (/).
API C can communicate with Server A and Server B through matching keys. API C also can
communicate with Server C and Server D only through the * MRLN SIMP keyany line.
Clients Servers
API A SERVER A
Server1 MRLN SIMP key11 API1 MRLN SIMP key11
Server2 MRLN SIMP key21 API2 MRLN SIMP key12
Server3 MRLN SIMP key31 API3 MRLN SIMP key13
Server4 MRLN SIMP key41 API4 MRLN SIMP key14
API B SERVER B
Server1 MRLN SIMP API1 MRLN SIMP key21
key12 API2 MRLN SIMP key22
Server2 MRLN SIMP API3 MRLN SIMP key23
key22 API4 MRLN SIMP key24
API C SERVER C
Server1 MRLN SIMP key13 API1 MRLN SIMP key31
Server2 MRLN SIMP key23 API2 MRLN SIMP key32
* MRLN SIMP keyany API3 MRLN SIMP key33
* MRLN SIMP keyany
API D SERVER D
Server1 MRLN SIMP key14 API1 MRLN SIMP key41
Server2 MRLN SIMP key24 API2 MRLN SIMP key42
Server3 MRLN SIMP key34 * MRLN SIMP keyany
* MRLN SIMP keyany
Note: Substitute the correct host name for Server1, 2, 3, or 4 and API1,
2, 3, or 4.
from the Sterling Connect:Direct API, to ensure that the authentication procedure is not bypassed
by an unauthorized user. The following figure displays the components that perform authentication:
User Application
Connect:Direct Server
Connect:Direct API
Parameter Description
Parameter Description
Firewall navigation enables controlled access to an Sterling Connect:Direct system running behind
a packet-filtering firewall without compromising your security policies or those of your trading
partners. You control this access by assigning a specific TCP or UDT source port number or a range
of source port numbers with a specific destination address (or addresses) for Sterling
Connect:Direct sessions.
Before you configure source ports in the Sterling Connect:Direct initialization parameters, you need
to review the information in this chapter, especially if you are implementing firewalls for UDT.
Firewall Navigation
Firewall rules need to be created on the local firewall to allow the local Sterling Connect:Direct
node to communicate with the remote Sterling Connect:Direct node. A typical packet-filtering
firewall rule specifies that the local firewall is open in one direction (inbound or outbound) to
packets from a particular protocol with particular local addresses, local ports, remote addresses, and
remote ports. Firewall Navigation differs between TCP and UDT; as a result, firewall rules for TCP
and UDT should be configured differently.
PNODE session Outbound Local C:Ds source ports Remote C:Ds listening port
SNODE session Inbound Local C:Ds listening port Remote C:Ds source ports
PNODE Session Request Outbound Local C:Ds source ports Remote C:Ds listening port
PNODE Session Outbound Local C:Ds source ports Remote C:Ds source ports
SNODE listen Inbound Local C:Ds listening port Remote C:Ds source ports
SNODE session Inbound Local C:Ds source ports Remote C:Ds source ports
Note: The IP addresses in the examples have been chosen to be distinctive and are not intended to be valid
IP addresses.
The local node has IP address 222.222.222.222 and listening port 2264. Its source ports for
communicating with the remote node are 20002200.
The remote node has IP address 333.333.333.333 and listening port 3364. Its source ports for
communicating with the local node are 30003300.
Note: See Session Establishment on page 72 for a discussion of the differences between UDT and TCP
session establishment.
Based on this scenario, the firewall rules for the local node are the following:
Session Establishment
Session establishment differs between TCP and UDT; these differences affect how you set up
firewall rules and configure the firewall navigation initialization parameters in Sterling
Connect:Direct.
Sterling Connect:Direct accepts both Internet Protocol version 4 (IPv4) and Internet Protocol
version 6 (IPv6) versions of the Internet Protocol as well as host names. You can enter IP
addresses/host names and ports in several ways, depending on the field you are specifying:
Address or host name only
Port number only
Address/host name with a port number
Multiple address/host name and port combinations
When specifying IP addresses/host names and ports for Sterling Connect:Direct, use the following
guidelines.
IP Addresses
Sterling Connect:Direct accepts both IPv4 and IPv6 addresses. Wherever an IP address is specified
in IBM Sterling Connect:Direct, you can use either IPv4 or an IPv6 addresses.
IPv4 Addresses
IPv4 supports 232 addresses written as 4 groups of dot-separated 3 decimal numbers (0 through 9),
for example, 10.23.107.5.
IPv6 Addresses
IPv6 supports 2128 addresses written as 8 groups of colon-separated 4 hexadecimal digits, for
example, 1001:0dc8:0:0:0:ff10:143e:57ab. The following guidelines apply to IPv6 addresses:
If a four-digit group contains zeros (0000), the zeros may be omitted and replaced with two
colons (::), for example:
2001:0db8:85a3:0000:1319:8a2e:0370:1337
can be shortened as
2001:0db8:85a3::1319:8a2e:0370:1337
Any number of successive 0000 groups may be replaced with two colons (::), but only one set
of double colons (::) can be used in an address, for example:
001:0db8:0000:0000:0000:0000:1319:58ab
Can be shortened as:
2001:0db8:0000:0000::1319:58ab
Leading zeros in a four-zero group can be left out (0000 can be shortened to 0), for example:
2001:0db8:0000:0000:0000:0000:1319:58ab
Can be shortened as:
2001:0db8:0:0:0:0:1319:58ab
You can write a sequence of 4 bytes that occur at the end of an IPv6 address in decimal format
using dots as separators, for example:
::ffff:102:304
Can be written as:
::ffff:1.2.3.4
Host Names
When you specify a host name, rather than an IP address, Sterling Connect:Direct gets the IP
address from the operating system. The first IP address returned by the operating system is used
regardless of whether it is in IPv4 or IPv6 format.
A host name (net, host, gateway, or domain name) is a text string of up to 24 characters comprised
of the alphabet (AZ), digits (09), minus sign (-), and period (.), for example, msdallas-dt.
The following guidelines also apply:
No blank or space characters are permitted as part of the name.
Periods are allowed only when they are used to delimit components of domain-style names.
Host names are not case sensitive.
The first and last character must be a letter or digit.
Single-character names or nicknames are not allowed.
Port Numbers
Port numbers can be appended to the end of IP/host addresses when they are preceded by a
semi-colon (;), for example, 10.23.107.5;1364. This convention is specific to Sterling
Connect:Direct and is not an industry standard.
A port number must be in the range of 0 through 65535. Port numbers lower than 1024 are
designated as reserved and should not be used. The following examples show port numbers
appended to IP/host addresses using these conventions:
10.23.107.5;1364
fe00:0:0:2014::7;1364
msdallas-dt;1364
You can also specify a port number for each address or host name. The port is separated from its
corresponding address/host name with a semi-colon (;), and each address/host name and port
combination is separated by a comma (,). A space may be added after the comma for readability.
The following example shows multiple address/host name and port combinations:
Multiple address/host names (and combinations with port numbers) are limited to 1024 characters.
You can enable a test mode for production instances of Sterling Connect:Direct to perform the
following functions:
Test new applications and customer connections
Prevent future production work from executing until testing is complete after you have
terminated all active production work using the Flush Process command
Resume regular production work after testing
Control individual file transfers by application
Enable and disable individual nodes and applications
While testing is being conducted, only Processes, particularly file transfers, involved with the
testing activity are executed. No production data is transferred to applications being tested while at
the same time no test data is transferred to production applications.
In addition to telling Sterling Connect:Direct which Processes to run, you tell the system what to do
with the Processes which do not get executed. You can specify the following dispositions for
Processes not permitted to run:
Place the Process in the Hold queue
Place the Process in the Timer queue for session retry
Flush the Process from the queue
For more information on how the testing mode can be used, see Sample Test Scenarios on page 82.
When the testing mode is enabled, Sterling Connect:Direct performs a syntax check on the
parameter table and fails initialization if the table is invalid. If the table is valid, Sterling
Connect:Direct scans it looking for a pattern that matches the Process that is about to execute. If a
match is found, the Process is permitted to execute if the I (Include) command code is in effect.
If command code X (Exclude) is in effect, the process is not permitted to execute. If a match is
not found in the table, the opposite processing occurs from the case where a match is found, that is,
if no match is found and command code I is in effect, the Process is not permitted to execute,
whereas if command code X is in effect, the Process is permitted to execute.
If a Process is not permitted to execute, the disposition specified in the NDMPXTBL parameter
table to either hold, retry, or flush the Process is implemented and a non-zero return code is returned.
When a Process is prevented from executing in testing mode, appropriate messages are issued and
can be viewed in the statistics log.
Note: For Processes initiated on remote nodes, the testing mode functions in the same manner as it does
for Processes submitted on the local Sterling Connect:Direct node except that the remote node is the
PNODE (Process owner) for that Process, and the local node is the SNODE (secondary node). The
NDMPXTBL Parameter Table is searched for a matching entry, and the remotely-initiated Process
is either permitted to execute or is excluded from execution. Because the local node is the SNODE
for this type of transfer, it cannot enforce the Process disposition setting in the NDMPXTBL
parameter table. The remote PNODE determines how the Process is handled. Typically, the remote
node places the Process in the Hold queue with a status of HE (Held in Error).
Note: If you enable the quiesce.resume initialization parameter, you must have an NDMPXTBL
parameter table.
Each table entry or record consists of a single-character command code in column one. Most
command codes have a parameter which begins in column two and varies according to the
command code function.
E Enables execution of Processes based on table The second column in this entry must
entries. Either E or D must be the first contain one of the following values
non-comment entry in the table. which indicates the disposition of a
PNODE Process if it is not allowed to
run.
HPlaces the Process in the Hold
queue
RPlaces the Process in the Timer
queue in session retry
FFlushes the Process from the
queue
D Disables the execution of all Processes regardless The parameter for command code
of the contents of the parameter table and fails E can also be specified in column
Process execution with a non-zero (error) return two. This is a convenience to make it
code and message LPRX003E. Either E or D easier to change from E to D and
must be the first non-comment entry in the table vice versa without having to change
column two to a blank for command
code D.
* Execute no processes at all. Put them in the hold queue and return.
DF
I
PACH*
PDITEST01
PDITEST02
L
Client
A program that makes requests of the Sterling Connect:Direct server and accepts the servers
responses.
daemon
The long-running process that provides a service to a client. The PMGR is the Sterling Connect:Direct
for UNIX daemon.
Diagnostic Commands
Sterling Connect:Direct commands that assist in the diagnosis of Sterling Connect:Direct software
problems.
Execution Queue
A logical queue in the TCQ. A Process in the Execution Queue can be transferring data to or from
a remote Sterling Connect:Direct node or it can be waiting for a connection to the remote
Sterling Connect:Direct node before it can perform its tasks.
Hold Queue
A logical queue in the TCQ. Processes in the Hold Queue are waiting for operator intervention
before they move to the Wait Queue for scheduling.
Monitoring Commands
Sterling Connect:Direct commands that allow you to display information from the statistics file and
the TCQ about Sterling Connect:Direct Process execution results.
Session
A connection between two Sterling Connect:Direct nodes.
Sterling Connect:Direct
The family of data transfer software products that distributes information and manages production
activities among multiple data centers.
Timer Queue
A logical queue in the TCQ. Processes on the Timer Queue are waiting for a start time before they
move to the Wait Queue for scheduling.
Wait Queue
A logical queue in the TCQ. Processes on the Wait Queue are waiting on a connection to or from
the remote Sterling Connect:Direct node.
tcp.ip.default 46 pstmt.submit_dir
tcp.max.time.to.wait 45, 46 Local User Information Record 59
Remote User Information Record 61
P pstmt.upload
Local User Information Record 58, 60
pacing.send.count
local node parameter 43 pstmt.upload_dir
remote node parameter 51 Local User Information Record 58, 60
tcp/ip settings for local node parameter 48
pacing.send.delay Q
local node parameter 43, 47
quiesce and resume, testing mode 79
remote node parameter 51
quiesce.resume
path parameter, for ndm.path record 21
test mode 79
Permissions
required for the client 68
required for the server 68
R
recid, remote node connection parameter 24
phone, Local User Information Record 57
Record
PMGR, description 7
api.parms 36
Port numbers authentication 31
specifying 77 copy.parms 26
Ports firewall.parms 33
multiple 77 local user information 55
ndm.node 22
proc.prio record 23 ndm.path 21
Process restart, overview 9 remote user information 59
remote userid@remote node name 60
Process, samples 11
runtask.parms 29
profile name, LU 6.2 parameter 24, 50 stats 30
Program directory, about 63 tcp.ip.default 46
tcq 25
proxy.attempt, local node parameter 43 user.exits 32
pstmt.copy, Local User Information Record 57, 60 Record, authentication 37
pstmt.copy.ulimit, Local User Information Record 57 Remote node information record
pstmt.crc, Local User Information Record 57, 59 creating 13
modifying 39
pstmt.download
Local User Information 58, 60 Remote User Information Record
about 59
pstmt.download_dir
descrip 61
Local User Information Record 58, 61
local.id 60
pstmt.run_dir pstmt.run_dir 61
local user information record 58 pstmt.submit_dir 61
remote user information record 61
remote userid@remote node name, user authorization
pstmt.runjob, Local User Information Record 59, 61 information record 60
pstmt.runtask, Local User Information Record 59, 61 restart, run task parameter 29
pstmt.submit, Local User Information Record 59, 61
Testing mode 79
Testing mode, scenarios 82
Text editor, modifying configuration files 18
U
udp.src.ports, firewall navigation parameter 34
udp.src.ports.list.iterations, firewall navigation
parameter 34
ulimit, copy parameters 26
UNIX, restricted shell 63
User authorization information file
description 9
local user information 55
modifying 53
program directory 63
remote user information 59
remote userid@remote node name 60
userid 53
User exit parameters, described 32
user.exits record 32
userfile.cfg, content and use 53
W
wait.time, CLI/API configuration parameter 36
X
xlate.dir, copy parameter 26
xlate.recv, copy parameter 26
xlate.send, copy parameter 26
This information was developed for products and services offered in the U.S.A.
IBM may not offer the products, services, or features discussed in this document in other
countries. Consult your local IBM representative for information on the products and
services currently available in your area. Any reference to an IBM product, program, or
service is not intended to state or imply that only that IBM product, program, or service may
be used. Any functionally equivalent product, program, or service that does not infringe any
IBM intellectual property right may be used instead. However, it is the user's responsibility
to evaluate and verify the operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter described in
this document. The furnishing of this document does not grant you any license to these
patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
For license inquiries regarding double-byte character set (DBCS) information, contact the
IBM Intellectual
Property Department in your country or send inquiries, in writing, to:
Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan Ltd.
1623-14, Shimotsuruma, Yamato-shi
Kanagawa 242-8502 Japan
The following paragraph does not apply to the United Kingdom or any other country
where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS
MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT
NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT,
This information is for planning purposes only. The information herein is subject to change
before the products described become available. This information contains examples of
data and reports used in daily business operations. To illustrate them as completely as
possible, the examples include the names of individuals, companies, brands, and products.
All of these names are ficticious and any similarity to the names and addresses used by an
actual business enterprise is entirely coincidental.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which illustrate
programming techniques on various operating platforms. You may copy, modify, and
distribute these sample programs in any form without payment to IBM, for the purposes of
developing, using, marketing or distributing application programs conforming to the
application programming interface for the operating platform for which the sample
programs are written. These examples have not been thoroughly tested under all conditions.
IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these
programs. The sample programs are provided "AS IS", without warranty of any kind. IBM
shall not be liable for any damages arising out of your use of the sample programs.
Each copy or any portion of these sample programs or any derivative work, must include a
copyright notice as follows:
IBM 2011. Portions of this code are derived from IBM Corp. Sample Programs.
Copyright IBM Corp. 2011.
If you are viewing this information softcopy, the photographs and color illustrations may
not appear.
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International
Business Machines Corp., registered in many jurisdictions worldwide. Other product and
service names might be trademarks of IBM or other companies. A current list of IBM
trademarks is available on the Web at Copyright and trademark information at
www.ibm.com/legal/copytrade.shtml.
Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks
or trademarks of Adobe Systems Incorporated in the United States, and/or other countries.
IT Infrastructure Library is a registered trademark of the Central Computer and
Telecommunications Agency which is now part of the Office of Government Commerce.
Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron,
Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks
of Intel Corporation or its subsidiaries in the United States and other countries.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or
both.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft
Corporation in the United States, other countries, or both.