Library /sys$common/syshlp/NCPHELP.HLB  —  SET  MODULE
 Introduces the various module entities.

1  –  CONFIGURATOR

 Use the SET MODULE CONFIGURATOR command to create or modify the parameters
 of the Ethernet configurator module component in the volatile database at
 the local node on an Ethernet circuit. A qualifier must be specified
 following the configurator keyword.

 	SET MODULE CONFIGURATOR KNOWN CIRCUITS		ALL
 				CIRCUIT circuit-id	SURVEILLANCE control

 All underscores found in parameters must be replaced with spaces
 when parameters are used in NCP commands.

1.1  –  ALL

 Copies the configurator module information from the permanent database
 into the volatile database at the local node.

1.2  –  SURVEILLANCE control

 Indicates whether or not a list of active systems is to be kept for the
 Ethernet circuit or circuits specified.  There are two control values:

 	DISABLED	The list is not to be kept. This is the default.

 	ENABLED		The list is to be kept.

2  –  X25-ACCESS

 Use the SET MODULE X25-ACCESS and DEFINE MODULE X25-ACCESS commands
 to associate the host node with the specified multi-host node for the
 purpose of accessing a specified X25 network.  The multi-host node
 connected to the specified X25 network is a VMS node with VAX
 PSI multi-host software installed.

       SET    MODULE X25-ACCESS     NETWORK network-name     ACCOUNT
                                    KNOWN NETWORKS           ALL
                                                             NODE
                                                             PASSWORD
                                                             USER

 All underscores found in parameters must be replaced with spaces
 when parameters are used in NCP commands.

2.1  –  ACCOUNT

 Identifies the user account for use by incoming calls to the
 network.  Specify a string of from 1 to 39 characters.  By
 default, no account is used.

2.2  –  ALL

 Copies all X25-ACCESS parameters from the permanent data base into
 the volatile data base.

2.3  –  KNOWN NETWORKS

 Identifies all known networks

2.4  –  NETWORK network-name

 Identifies the network whose parameters are to be set in the
 data base.

2.5  –  NODE node-id

 Specifies the node address or name used of the multi-host node that
 is connected to a specified X25 network.  When you specify an
 X25-ACCESS network for the first time, this parameter is mandatory.

2.6  –  PASSWORD

 Specifies the password for use by incoming calls to the network.
 Specify a string of from 1 to 39 characters.  The default is that no
 password is used.

2.7  –  USER

 Specifies the user identification for use by incoming calls to the
 network.  Specify a string of from 1 to 16 characters.  The
 default is that no user identification is used.

3  –  X25-PROTOCOL

 Use the SET MODULE X25-PROTOCOL command to create or modify the
 parameters of the Protocol Module component in the volatile data
 base. Use the DEFINE MODULE X25-PROTOCOL command to create or modify
 the parameters of the Protocol Module component in the permanent data
 base.

 Use separate SET MODULE X25-PROTOCOL commands to a specify a DTE with
 its associated parameters, a group with its associated parameters and
 the network profile.

     SET  MODULE X25-PROTOCOL  DTE dte-address    NETWORK network-name
                                 KNOWN DTES       KNOWN NETWORKS
                                                  ALL
                                                  CALL TIMER seconds
                                                  CHANNELS list
                                                  CLEAR TIMER seconds
                                                  COUNTER TIMER seconds
                                                  DEFAULT DATA bytes
                                                  DEFAULT WINDOW count
                                                  INTERFACE code
                                                  INTERRUPT TIMER seconds
                                                  LINE line-id
                                                  MAXIMUM CIRCUITS count
                                                  MAXIMUM CLEARS count
                                                  MAXIMUM DATA bytes
                                                  MAXIMUM RESETS count
                                                  MAXIMUM RESTARTS count
                                                  MAXIMUM WINDOW count
                                                  RESET TIMER seconds
                                                  RESTART TIMER seconds
                                                  STATE ON
                                                        OFF
                                                        SHUT

                                 GROUP group-name  ALL
                                 KNOWN GROUPS      DTE dte-address
                                                   NETWORK net-name
                                                   NUMBER group-number
                                                   TYPE BILATERAL

                                 NETWORK net-name  PROFILE profile-name
                                 KNOWN NETWORKS

 All underscores found in parameters must be replaced with spaces
 when parameters are used in NCP commands.

3.1  –  ALL

 Can be used with DTE, GROUP or NETWORK. It selects all parameters for
 the specified component or for all known DTEs, groups or networks.

3.2  –  CALL TIMER

 Specifies a timer that starts when a request to set up an X25 virtual
 circuit is transmitted, and whose termination clears the request if no
 response has been received. Specify a value in the range 1 to 255.

 By default the timer takes the network value specified by the PROFILE
 parameter.

3.3  –  CHANNELS

 Specifies a list of logical channel numbers (LCNs) reserved for outgoing
 calls. The list can consist of one or more LCNs. Separate LCNs with
 hyphens to indicate ranges, or with commas to indicate separate list
 items. Specify a value in the range 0 to 4095 for each LCN.

 If a DTE is to make outgoing calls you must specify this parameter
 when defining the DTE.

3.4  –  CLEAR TIMER

 Specifies a timer that starts when a request to clear an X25 Virtual
 circuit is transmitted, and whose termination retransmits the clear
 request if not response has been received.  Specify a value in the
 range 1 to 255.  By default, the timer takes the network value
 specified by the PROFILE parameter.

3.5  –  COUNTER TIMER

 Sets a timer whose expiration causes a DTE counter logging event.
 Specify a decimal integer in the range 1 to 65,535.

3.6  –  DEFAULT

3.6.1  –  DATA

 Specifies the default packet size for X25 virtual circuits. This
 value must be at least 5 bytes less than the MAXIMUM BLOCK value you
 specify in the SET LINE command and must be a power of 2. Specify a
 value in the range 16 to 4096 bytes.

 By default packet size takes the network value specified by the
 PROFILE parameter.

3.6.2  –  WINDOW count

 Specifies the default window size for X25 virtual circuits, that is,
 the maximum number of packets for which outstanding acknowledgments
 are allowed. Specify a value in the range 1 to 127.

 By default, window size takes the network value specified by the
 PROFILE parameter.

3.7  –  DTE

 Identifies a local DTE. If you specify the DTE qualifier, you must
 associate with it:

   NETWORK network-name

   or

   KNOWN NETWORKS

3.8  –  KNOWN

 Can be used with DTES, NETWORKS and GROUPS.

 KNOWN DTES selects all known DTEs on the network specified or all
 known networks.

 KNOWN NETWORKS selects all known networks.

 KNOWN GROUPS selects all known groups.

3.9  –  INTERFACE code

 Specifies the way in which the processor operates. This parameter can
 only be used with the ISO8208 profile. The parameter can take one of
 the following values:

 DTE           The processor operates as a DTE.

 DCE           The processor operates as a DCE.

 NEGOTIATED    The processor can operate either as a DTE or DCE. The
               processor automatically selects the correct method of operation.

 The default is DTE.

3.10  –  INTERRUPT TIMER secs

 This is the interrupt timer (ISO T26 timer). This parameter can only
 be used with the ISO8208 profile. Specify a value in the range 1 to
 255. If you do not specify a value there is no time limit on interrupt
 acknowledgments.

3.11  –  LINE line-id

 Identifies the line associated with the DTE. Specify a line name in
 the format dev-c[u]. This parameter is mandatory when you specify a
 DTE for the first time.

3.12  –  MAXIMUM

3.12.1  –  CIRCUITS count

 Specifies the maximum number of circuits for the DTE. By default, the
 maximum is 255.

3.12.2  –  CLEARS count

 Specifies the maximum number of attempts to clear an X25 virtual
 circuit. Specify a value in the range 1 to 255. By default the value
 is the network value specified by the PROFILE parameter.

3.12.3  –  DATA bytes

 Specifies the maximum packet size for X25 virtual circuits. This
 value must be at least 5 bytes less than the MAXIMUM BLOCK value you
 specify in the SET LINE command and must be a power of 2. Specify a
 value in the range 16 to 4096 bytes.

 By default the value taken is the network value specified by the
 PROFILE parameter.

3.12.4  –  RESETS count

 Specifies the maximum number of attempts to reset an X25 virtual
 circuit. Specify a value in the range 1 to 255.

 By default, the count takes the network value specified by the PROFILE
 parameter.

3.12.5  –  RESTARTS count

 Specifies the maximum number of attempts to restart an X25 virtual
 circuit. Specify a value in the range 1 to 255.

 By default, the count takes the network value specified by the PROFILE
 parameter.

3.12.6  –  WINDOW count

 Specifies the window size allowed for X25 virtual circuits, that is,
 the maximum number of packets for which outstanding acknowledgments
 are allowed. Specify a value in the range 1 to 127.

 By default, the window size takes the network value specified by the
 PROFILE parameter.

3.13  –  GROUP

 Identifies a closed user group (CUG) or bilateral closed user group
 (BCUG) or specifies all known groups.

3.13.1  –  DTE dte-address

 Identifies the local DTE associated with the group name.  This
 parameter is mandatory when creating a group.

3.13.2  –  ALL

 Copies the group parameters from the permanent data base into the
 volatile data base.  (Used only with the SET MODULE X25-PROTOCOL
 command.)

3.13.3  –  NUMBER group-number

 Specifies the CUG or BCUG number. Specify a two-digit number for a
 CUG and a four-digit number for a BCUG.  You can omit leading zeroes.
 This parameter is mandatory when creating a group.

3.13.4  –  TYPE BILATERAL

 Specifies the user group as a BCUG. Omit this parameter if the user
 group is a CUG.

3.14  –  ALL

 Copies the network parameters from the permanent data base into the
 volatile data base.  (Used only with the SET MODULE X25-PROTOCOL
 command.)

3.15  –  NETWORK net-name

 Identifies a network.

3.16  –  PROFILE profile-name

 Specifies a profile to be used on the network. The profile-name is a
 character string of up to 32 characters. This parameter is mandatory.

3.17  –  RESET TIMER secs

 Specifies a timer that starts when a reset is transmitted, and whose
 termination retransmits the reset if no response has been received.
 Specify a value in the range 1 to 255.

 By default the timer takes the network value specified by the PROFILE
 parameter.

3.18  –  RESTART TIMER secs

 Specifies a timer that starts when a restart is transmitted, and whose
 termination retransmits the restart if no response has been received.
 Specify a value in the range 1 to 255.

 By default, the timer takes the network value specified by the PROFILE
 parameter.

3.19  –  STATE dte-state

 Specifies the operational state of the DTE as follows:

 ON          The DTE is available for normal use

 OFF         The DTE is not in use

 SHUT        The DTE is to be closed down when all present activity has
             ceased

3.19.1  –  PROFILE

 Specifies a profile to be used on the network.  The profile-name
 is a character string of up to 32 characters.  This parameter is
 mandatory.

3.20  –  CALL TIMER seconds

 Specifies a timer that starts when a request to set up a virtual
 circuit is transmitted, and whose expiration clears the request if no
 response has been received. Specify a value in the range 1 to 255. By
 default, the timer takes the network value specified by the NETWORK
 parameter.

3.21  –  CLEAR TIMER seconds

 Specifies a timer that starts when a request to clear a virtual
 circuit is transmitted, and whose expiration retransmits the clear
 request if no response has been received.  Specify a value in the
 range 1 to 255. By default, the timer takes the network value
 specified by the NETWORK parameter.

4  –  X25-SERVER

 Use the SET MODULE X25-SERVER command to create or modify the
 parameters of the X25 Call Handler in the volatile data base. Use
 the DEFINE MODULE X25-SERVER command to create or modify the
 parameters of the X25 Call Handler in the permanent data base.

 The components contain records that identify a destination,
 specify  parameters for this destination, specify the maximum
 number of circuits that each module (that is, all destinations
 for a particular module) may have, and specify the state of the
 module.

 Specify the module parameters and the destinations using
 separate SET or DEFINE MODULE X25-SERVER or X29-SERVER commands.

 Format:

 SET  MODULE X25-SERVER  ALL
             X29-SERVER  COUNTER TIMER seconds
                         MAXIMUM CIRCUITS count
                         STATE   ON
                                 OFF
                                 SHUT

                         DESTINATION dest-name  ACCOUNT account
                         KNOWN DESTINATIONS     CALL MASK hex-value
                                                CALL VALUE hex-value
                                                CALLED ADDRESS dte-address
                                                EXTENSION MASK hex-string
                                                EXTENSION VALUE hex-string
                                                GROUP group-name
                                                INCOMING ADDRESS dte-address
                                                NETWORK network-name
                                                NODE node-id
                                                OBJECT object-id
                                                PASSWORD password
                                                PRIORITY priority
                                                RECEIVING DTE dte-address
                                                REDIRECT REASON code
                                                SENDING ADDRESS dte-address
                                                SUBADDRESSES range
                                                USER user-id

 All underscores found in parameters must be replaced with spaces
 when parameters are used in NCP commands.

4.1  –  ALL

 Copies the Call Handler parameters from the permanent data base into
 the volatile data base.  (Used only for the SET MODULE X25-SERVER
 command or the SET MODULE X29-SERVER command.)

4.2  –  KNOWN DESTINATIONS

 Specifies all known destinations.

4.3  –  COUNTER TIMER seconds

 Sets a timer whose expiration causes a server module counter logging
 event.  Specify a decimal integer in the range 1 to 65,535.

4.4  –  MAXIMUM CIRCUITS count

 Specifies the maximum number of circuits that the module (that is,
 all destinations) may have.  By default, the maximum is 255.

4.5  –  STATE

 Specifies the operational state of the server module.  This parameter
 takes one of the following values:

     ON     The module is available for normal use.

     OFF    The module is not in use.

     SHUT   The module is to be closed down but only when all
            present activity has ceased. (The SHUT value applies only
            to the SET MODULE X25-SERVER or X29-SERVER command.)

            For the X25 server module, the default state is ON.  For
            the X29 server module, the default state is OFF.

4.6  –  CALLED ADDRESS dte-address

 For redirected calls, this parameter identifies the DTE that was
 originally called. The parameter value is used to select a destination
 for a redirected call.

 By default, no called DTE is used.

4.7  –  DESTINATION dest-name

 Identifies a destination or specifies all known destinations.
 Dest-name is an id string. Associate parameters with the destination
 or destinations, as follows:

4.8  –  ACCOUNT account

 Identifies the user account for use by incoming calls to the
 destination.  Specify a string of from 1 to 39 characters.  By
 default, no account is used.

4.9  –  CALL

4.9.1  –  MASK hex-value

 Specifies the mask applied to the incoming call data before it is
 tested.  Hex-value is a string of 2 to 32 hexadecimal digits.  By
 default, no mask is used.

4.9.2  –  VALUE hex-value

 Specifies the string used to test the incoming call data.  Hex-value
 is a string of 2 to 32 hexadecimal digits.  By default, no value is
 used.

4.10  –  EXTENSION

4.10.1  –  MASK hex-string

 Provides a mask for the called address extension facility. Using
 logical AND, the mask is merged with the called address extension in
 the incoming call and the result is compared with the extension value.

 By default no extension mask is used.

4.10.2  –  VALUE hex-string

 Provides a value for the called address extension facility. This value
 is compared with the address extension in the incoming call (after
 merging as described in EXTENSION MASK).

 By default no extension value is used.

4.11  –  GROUP group-name

 Identifies a closed user group (CUG) or bilateral closed user group
 (BCUG).  The group-name is an id string.  By default, no group name
 is used.

4.12  –  INCOMING ADDRESS dte-address

 Identifies the address of the DTE receiving the call (as specified in
 the call packet).

4.13  –  NETWORK net-name

 Specifies the network for which calls are accepted.

 By default, no network name is used.

4.14  –  NODE node-id

 Identifies the host node which is to be the destination of the
 incoming X25 call.

4.15  –  OBJECT object-id

 Identifies the object that is activated when an incoming call
 arrives.  The object-id is an id string.  If the object name looks
 like a number, enclose the string in  quotes.  This parameter is
 mandatory when you specify a destination for the first time.

4.16  –  PASSWORD password

 Specifies the password for use by incoming calls to the destination.
 Specify a string of from 1 to 39 characters.  The default is that no
 password is used.

4.17  –  PRIORITY priority

 Specifies the priority of the destination record and is used to
 select one of a set of destinations for which the incoming call may
 be valid.  Specify a value in the range 0 to 255, where 255 is the
 highest priority.  By default, priority takes a value of 0.

4.18  –  RECEIVING DTE

 Identifies the local DTE. IT is used to select a destination for calls
 received on the local DTE.

 By default, no receiving DTE is used.

4.19  –  REDIRECT REASON code

 Identifies a reason for redirecting an incoming call. The reason code
 can take one of the following values:

 BUSY             The original DTE was busy and could no accept any
                  more calls.

 OUT OF ORDER     The original DTE was out of order.

 SYSTEMATIC       All calls to the original DTE are automatically
                  rerouted.

 The reason code is used to select a destination for  a redirected
 call. By default, no reason is used.

4.20  –  SENDING ADDRESS dte-address

 Identifies the address of the remote DTE that originated the call. By
 default, no sending DTE is used.

4.21  –  SUBADDRESSES range

 Specifies the range of local DTE subaddresses that identify the
 destination for the incoming call. Range consists of one or two
 subaddresses.  Subaddress is a decimal integer in the range 0
 to 9999. Separate two subaddresses with a single hyphen to indicate
 a range. The second subaddress must be greater than the first.  By
 default, no subaddress range is used.

4.22  –  USER user-id

 Specifies the user identification for use by incoming calls to the
 destination.  Specify a string of from 1 to 16 characters.  The
 default is that no user identification is used.

5  –  X29-SERVER

 Use the SET MODULE X29-SERVER command to create or modify the
 parameters of the X.29 Call Handler in the volatile data base. Use
 the DEFINE MODULE X29-SERVER command to create or modify the
 parameters of the X.29 Call Handler in the permanent data base.

 The components contain records that identify a destination,
 specify  parameters for this destination, specify the maximum
 number of circuits that each module (that is, all destinations
 for a particular module) may have, and specify the state of the
 module.

 Specify the module parameters and the destinations using
 separate SET or DEFINE MODULE X25-SERVER or X29-SERVER commands.

 Format:

 SET  MODULE X25-SERVER  ALL
             X29-SERVER  COUNTER TIMER seconds
                         MAXIMUM CIRCUITS count
                         STATE   ON
                                 OFF
                                 SHUT

                         DESTINATION dest-name  ACCOUNT account
                         KNOWN DESTINATIONS     CALL MASK hex-value
                                                CALL VALUE hex-value
                                                CALLED ADDRESS dte-address
                                                EXTENSION MASK hex-string
                                                EXTENSION VALUE hex-string
                                                GROUP group-name
                                                INCOMING ADDRESS dte-address
                                                NETWORK network-name
                                                NODE node-id
                                                OBJECT object-id
                                                PASSWORD password
                                                PRIORITY priority
                                                RECEIVING DTE dte-address
                                                REDIRECT REASON code
                                                SENDING ADDRESS dte-address
                                                SUBADDRESSES range
                                                USER user-id

 Please refer to help on SET MODULE X25-SERVER for more details.
Close Help