DECnet NCP CLEAR — VMS DECNet_SNA_Gateway_2.0
The CLEAR command sets parameters to their default values. If a parameter does not have a default value, the CLEAR command deletes it altogether. For some components, you can specify CLEAR ALL to delete the definition of the component.
Additional information available:
ACCESS_NAMECIRCUITLINELOGGINGLUPU
SERVER
ACCESS_NAME
The CLEAR ACCESS NAME parameter command removes the specified
parameters from the access name definition. CLEAR ACCESS NAME ALL
removes the access name from the database. There are no default
access names, and no default access name parameters.
FORMAT:
CLEAR access-name-component parameter [...]
ACCESS NAME COMPONENTS:
ACCESS NAME access-name-id
Removes the specified access name or parameters for the access
name. The access-name-id is a string of 1 to 16 alphanumeric
characters, for example, NCCF.
KNOWN ACCESS NAMES
Removes all known access names or parameters for all known
access names.
You do not type an underscore in "ACCESS NAME".
Additional information available:
ALLAPPLICATIONDATALOGON_MODELU_LIST
NOTEPU
ALL
Removes the definition of the specified access name. Do not use ALL with the other parameters.
APPLICATION
Removes the application name from the access name definition.
DATA
Removes the data parameter from the access name definition.
LOGON_MODE
Removes the name of the logon mode table entry from the access name definition. Format: LOGON MODE (with no underscore)
LU_LIST
Removes the LU list from the access name definition. Format: LU LIST (with no underscore)
NOTE
Removes the note text from the access name definition.
PU
Removes the PU name from the access name definition.
Example
1. SNANCP> CLEAR ACCESS NAME TSO LU LIST
This command removes the list of LUs that have been defined
for the access name TSO.
2. SNANCP> CLEAR ACCESS NAME TSO ALL
This command removes the access name TSO.
CIRCUIT
The CLEAR CIRCUIT command resets circuit parameters to their default
value (if any). CLEAR CIRCUIT ALL removes the definition of the
specified circuit from the database.
Before clearing a circuit or circuit parameters (except for COUNTER
TIMER, LOGGING, and NOTE), make sure the circuit is in the OFF state.
FORMAT:
CLEAR circuit-component parameter [...]
CIRCUIT COMPONENTS:
CIRCUIT circuit-id
Resets to the default value (if any) or removes the parameters
for a specific circuit. Enter the circuit-id in the format
SDLC-n or CHAN-n.
KNOWN CIRCUITS
Resets parameters to the default value (if any) or removes the
parameters for all known circuits.
Additional information available:
ALLCHANNEL_ADDRESSCOUNTER_TIMERDUPLEXIDLE_TIMER
LINELOGGINGNOTERESPONSE_MODESTATION_ADDRESS
STATION_ID
ALL
Removes the definition of the specified circuit or all known circuits. The circuit must be in the OFF state before you can specify this parameter. Do not use ALL with the other parameters.
CHANNEL_ADDRESS
Removes the channel address from the circuit database. You must respecify an appropriate address before setting the circuit state ON. Format: CHANNEL ADDRESS (with no underscore). This parameter applies only to IBM channel links.
COUNTER_TIMER
Resets the logging timer interval to the default value, which is 0. Setting the timer interval to zero prevents any further circuit counter logging for the circuit. Format: COUNTER TIMER (with no underscore)
DUPLEX
Resets the data transfer mode of the specified circuit to the default which is HALF (half-duplex). The duplex setting must correspond with the DATMODE parameter for the IBM ACF/NCP PU macro. For information on setting the physical characteristics of the communication path, see the SET LINE command. This parameter does not apply to IBM channel links.
IDLE_TIMER
Resets the number of seconds the circuit should wait for a poll from the IBM system to the default value which is 30. Format: IDLE TIMER (with no underscore). This parameter does not apply to IBM channel links.
LINE
Resets the line parameter to null, thus removing the association between this circuit and any line. You cannot set the circuit ON until you have respecified the line parameter.
LOGGING
Resets logging to the default which is to log only fatal events. Fatal event logging is always enabled, even when other levels are specified.
NOTE
Removes the note text for the specified circuit(s). The default is no note.
RESPONSE_MODE
Resets response mode to NORMAL. This setting must correspond to the ACF/NCP LINE macro MODULO parameter. Format: RESPONSE MODE (with no underscore). This parameter does not apply to IBM channel links.
STATION_ADDRESS
Resets the SDLC station address to the default value of 01. This value must correspond with the setting of the ADDR parameter for the IBM ACF/NCP PU macro. Format: STATION ADDRESS (with no underscore). This parameter does not apply to IBM channel links.
STATION_ID
Resets the SDLC Exchange-Identification (XID) for dial-up lines to the default value, which is 00000000. See the description under the SET command for the format of this parameter. Format: STATION ID (with no underscore). This parameter does not apply to IBM channel links.
Example
1. SNANCP> SET CIRCUIT SDLC-0 STATE OFF
SNANCP> CLEAR CIRCUIT SDLC-0 ALL
After you set circuit SDLC-0 to the OFF state, the CLEAR
CIRCUIT ALL command removes the definition of the circuit.
2. SNANCP> CLEAR CIRCUIT CHAN-0 LOGGING
The CLEAR CIRCUIT LOGGING command resets logging to the
default which is to log only fatal events.
LINE
The CLEAR LINE command resets the line parameters to the default
values (if any). CLEAR line-component ALL removes the definition of
the specified line(s) from the database.
Before clearing a line or line parameters (except for COUNTER TIMER,
LOGGING, and NOTE), make sure the line is in the OFF state.
FORMAT:
CLEAR line-component parameter [...]
LINE COMPONENTS:
LINE line-id
Resets the specified line to default values (if any) or
removes the parameters for a specific line. Line-id
specifies the name of the line you want to clear. Enter the
line-id in the format SYN-n or CQ-n.
KNOWN LINES
Resets all known lines to default values (if any) or removes
the parameters for all lines.
Additional information available:
ALLBUFFER_SIZECLOCKCOUNTER_TIMERDUPLEX
FORCED_BURSTINTERLEAVELOGGINGMODEM_TYPE
NOTEPROTOCOLRECEIVE_BUFFERSSIGNALLING
ALL
Removes the definition of the specified line(s). The line must be in the OFF state before you specify this parameter. Furthermore, there must be no circuits associated with this line. Clear circuits before you clear lines.
BUFFER_SIZE
Resets the size of the buffers used for storing messages from the IBM system to the default value. The default value depends on the link type. For synchronous links, the default is 265. For channel-attached links, the default is 4105. Format: BUFFER SIZE (no underscore).
CLOCK
Resets the clocking that regulates the signals sent between the IBM system and the Gateway to the default value, which is EXTERNAL. This parameter does not apply to IBM channel links.
COUNTER_TIMER
Resets the logging timer interval to the default value, which is 0: this means that the timer is not running. Further counter logging is thus inhibited for the line. Format: COUNTER TIMER (with no underscore)
DUPLEX
Resets the duplex setting of the line to the default value which is HALF (half-duplex). The duplex setting must be the same as that defined for the IBM modem by the value of the DUPLEX parameter and by the ADDRESS parameter for the IBM ACF/NCP LINE macro. This parameter does not apply to IBM channel links.
FORCED_BURST
Resets the forced-burst mode to the default, which is DISABLED. Format: FORCED BURST (with no underscore). This parameter applies only to IBM channel links.
INTERLEAVE
Resets the byte multiplexer interleave size to the default of 16 bytes. This parameter applies only to IBM channel links.
LOGGING
Resets LOGGING to the default value which is to log only fatal events. Fatal event messages are always enabled, even when other levels are specified.
MODEM_TYPE
Resets the modem type to the default value of NORMAL (for transfer of data). Format: MODEM TYPE (with no underscore). This parameter does not apply to IBM channel links.
NOTE
Removes the note text for specified line(s). The default is no note.
PROTOCOL
Resets the protocol to the default value. For SYN-n lines, this is SDLC POINT. For CQ-n lines, this is CHANNEL BLOCK.
RECEIVE_BUFFERS
Resets the maximum number of buffers allocated to the line to the default value, which depends on the link type. For synchronous links, the default is 16. For channel-attached links, the default is 64. See the description of this parameter under the SET command for guidelines on choosing a suitable value. Format: RECEIVE BUFFERS (with no underscore)
SIGNALLING
Resets the mode for line signals to the default value which is NORMAL. The value for this parameter must correspond with the setting of the NRZI parameter for the IBM ACF/NCP line macro (for synchronous links) or to the capabilities of the channel hardware (for channel-attached links).
Example
1. SNANCP> SET LINE SYN-0 STATE OFF
SNANCP> CLEAR LINE SYN-0 ALL
After setting line SYN-0 to the OFF state, the CLEAR LINE ALL
command removes the definition of the line.
2. SNANCP> SET LINE CQ-0 STATE OFF
SNANCP> CLEAR LINE CQ-0 FORCED BURST
After setting line CQ-0 to the OFF state, the CLEAR LINE
FORCED BURST command disables the use of forced burst mode on
the channel.
LOGGING
The CLEAR LOGGING command removes or resets parameters to default for
all event logging. Set the logging state to OFF before using the
CLEAR LOGGING command.
See the CLEAR command for individual components (LINE, CIRCUIT, PU,
LU, ACCESS NAME, SERVER) for a description of how to reset the level
of messages logged for a particular component.
FORMAT:
CLEAR logging-component parameter [...]
LOGGING COMPONENTS:
LOGGING FILE
Removes or resets parameters for logging to a file.
LOGGING MONITOR
Removes or resets parameters for logging to a monitor.
KNOWN LOGGING
Removes or resets parameters for all known logging components
(on the selected sink node).
Additional information available:
ALL
Removes all parameters for the selected logging components.
KNOWN_SINKS
Format: KNOWN SINKS Specifies that this CLEAR command is to be applied to all known sink nodes. See also the SINK NODE parameter for more details.
NAME
Removes the name of the file or monitor process to which events are logged.
SINK_NODE
Format: SINK NODE node-id The SINK NODE parameter qualifies which sink node is to be affected by this CLEAR command. By default, the command is applied to the load host's sink definition.
Example
SNANCP> CLEAR LOGGING FILE SINK NODE MANRAY ALL This command removes all file logging to the node named MANRAY.
LU
The CLEAR LU command resets LU parameters to the default values (if
any). CLEAR LU ALL resets all LU parameters to their default values.
(To remove the definition of an LU, use the CLEAR PU LU LIST command.)
FORMAT:
CLEAR lu-component [component-qualifier] parameter [...]
LU COMPONENTS:
LU lu-id
Resets parameters of the specified LU to default values.
Enter the lu-id in the format pu.id.nnn, for example, SNA-0.1.
KNOWN LUS
Resets parameters for all known LUs.
Additional information available:
ALL
Resets all parameters to their default values.
LOGGING
Resets LOGGING to the default which is to log only fatal events. Fatal is always enabled, even when other levels are specified.
NOTE
Removes the note text for the specified LU(s). The default is no note.
Component Qualifiers
AUTHORIZATION auth-id KNOWN AUTHORIZATIONS Removes the definition for a specific authorization entry or all known authorization entries. You must enter the CLEAR LU AUTHORIZATION component qualifier as a separate command. It cannot be part of a command that clears LU parameters. You can remove any or all of the following access control parameters for an authorization entry:
Additional information available:
ALL
Deletes the specified authorization entry.
NODE
Removes the node name from the authorization entry, thus causing this entry to match any node name.
USER
Removes the user name from the authorization entry, thus causing this entry to match any user name.
TERMINAL
Removes the terminal name from the authorization entry, thus causing this entry to match any terminal name.
PASSWORD
Removes the password from the authorization entry, thus causing this entry to require no password.
Example
1. SNANCP> SET CIRCUIT SDLC-0 STATE OFF
SNANCP> CLEAR LU SNA-0.1
The first command sets the circuit SDLC-0 (the circuit
associated with PU SNA-0) to the OFF state. The second
command resets logging to the default value (fatal) and
removes any note text for LU SNA-0.1.
2. SNANCP> CLEAR LU SNA-0.1 AUTHORIZATION DADAIST NODE USER
This command removes the NODE and USER information from the
authorization entry DADAIST.
3. SNANCP> CLEAR LU SNA-0.1 AUTHORIZATION DADAIST ALL
This command removes the entire authorization entry DADAIST
from the database.
PU
The CLEAR PU command resets PU parameters to the default value (if
any). CLEAR pu-component ALL removes the definition of the specified
PU(s) from the database.
Before clearing a PU or PU parameters, make sure the corresponding
circuit is in the OFF state.
FORMAT:
CLEAR pu-component parameter [...]
PU COMPONENTS:
PU pu-id
Resets the specified PU to default values (if any) or removes
the definition for a specific PU. Enter the pu-id in the
format SNA-nnn, for example, SNA-0.
KNOWN PUS
Resets all PUs to default values (if any) or removes the
definitions for all PUs.
Additional information available:
ALLCIRCUITCOUNTER_TIMERLOGGINGLU_LISTNOTE
QUERY_THRESHOLDSEGMENT_SIZESSCP_ID
ALL
Removes the definition of the specified PU or all known PUs (including any associated LUs). A PU must be inactive before you can remove its definition or delete an LU list. To make a PU inactive, set the state of the corresponding circuit to OFF.
CIRCUIT
Resets the circuit parameter to null, and thus dissociates the PU from any circuit.
COUNTER_TIMER
Resets the logging timer to the default value of 0 (this means that the timer is not running). This cancellation of the logging timer prevents any further PU counter logging for the specified PU(s). Format: COUNTER TIMER (with no underscore).
LOGGING
Resets LOGGING to the default which is to log only fatal events. Fatal event messages are always logged, even when other levels are specified.
LU_LIST
Removes the definition of all LUs associated with this PU. Format: LU LIST (with no underscore).
NOTE
Removes the note text for the PU. The default is no note.
QUERY_THRESHOLD
Resets the number of seconds that must elapse between REQMS (Request Maintenance Statistics) messages to the default value of 0. When the value is 0, the Gateway processes all REQMS messages it receives from the IBM Network Problem Determination Application (NPDA). Format: QUERY THRESHOLD (with no underscore)
SEGMENT_SIZE
Resets the size of the frames of data sent to the IBM system to the default value which is 265. The value assigned to this parameter with SNANCP is ignored for channel-attached links. The gateway will choose a suitable value at link connection time. Format: SEGMENT SIZE (with no underscore)
SSCP_ID
When you specify a particular sscp-id, any other SSCPs that you have
defined will not be cleared. Any of these other SSCPs can activate
the PU.
To clear all the SSCPs defined for a PU, specify ALL after the SSCP ID
parameter.
Format: SSCP ID {sscd-id|ALL}
Example
SNANCP> SET CIRCUIT SDLC-0 STATE OFF SNANCP> CLEAR PU SNA-0 SSCP ID ALL LU LIST After setting the circuit SDLC-0 to OFF, the CLEAR PU command removes all SSCP IDs and the LU list defined for PU SNA-0. You must use the SET command to define a new LU LIST and SSCP IDs.
SERVER
The CLEAR SERVER command resets parameters to their default values.
The CLEAR server-component ALL command does not delete a server, it
resets all parameters to their default values.
For all servers, set the state to OFF before you reset the parameter
values with the CLEAR SERVER ALL command. For the DHCF server, set
the server state to OFF before you clear the MAXIMUM LINKS, and PU LU
LIST parameters.
FORMAT:
CLEAR server-component [component-qualifier] parameter [...]
SERVER COMPONENTS:
SERVER server-id
Resets the specified parameters for a particular server. The
server-id is one of the following: RJE, SNA-ACCESS, or DHCF.
KNOWN SERVERS
Resets parameters for all three servers.
Additional information available:
ALLLOGGINGLU_LISTMAXIMUM_LINKSNOTEPU
TEXT_FILE
ALL
Removes the specified server from the database.
LOGGING
Resets the LOGGING parameter to the default, which is to log only fatal event messages. Fatal is always enabled, even when other levels are specified.
LU_LIST
Resets the allocation of LUs to the DHCF server to the default value
which is none. Must be preceded by a PU qualifier: thus
PU pu-id LU LIST
Enter the pu-id in the format SNA-n, for example, SNA-0. Note that
there is no underscore in "LU LIST".
MAXIMUM_LINKS
Resets the maximum number of DECnet logical links that can be active for the server. In other words, the MAXIMUM LINKS parameter will be set to the highest value supported for each server. Format: MAXIMUM LINKS (no underscore).
NOTE
Removes the note text from the server definition. The default is no note.
PU
Qualifies an LU LIST to be cleared (see under topic LU_LIST). Format: PU pu-id LU LIST
TEXT_FILE
Removes the current text file. You can use the SET SERVER server-id TEXT FILE command to define a new file. Format: TEXT FILE (with no underscore).
Component qualifiers
The following component qualifiers apply only to the SNA-ACCESS server. LU lu-id Identifies the particular LU for which the subsequent outbound session allocation parameters are to be cleared. KNOWN LUs Specifies that the subsequent outbound session allocation parameters are to be cleared for all LUs. The following parameters can be cleared for the specified LUs:
Additional information available:
ALLNODEOBJECT_NAMEOBJECT_NUMBERUSER
PASSWORDACCOUNT
ALL
Clears all outbound session allocation parameters for the specified LUs.
NODE
Clears the name of the DECnet node that will receive the bind request.
OBJECT_NAME
Clears the name of the DECnet object. Format: OBJECT NAME
OBJECT_NUMBER
Clears the number of the DECnet object. Format: OBJECT NUMBER
USER
Clears the user name used to establish the logical link.
PASSWORD
Clears the password used to establish the logical link.
ACCOUNT
Clears the account name used to establish the logical link.
Example
SNANCP> SET SERVER SNA-ACCESS STATE OFF SNANCP> CLEAR SERVER SNA-ACCESS PU SNA-0 LU LIST The first command sets the server state off. The second command deallocates all LUs on PU SNA-0 for the SNA-ACCESS server.