DHCFCONTROL

Generated from C.65.00 /SYSADMIN/PUB/MYCICAT last modified on Sun Aug 29 15:08:37 2004

Back to Main Index


DHCFCONTROL


     This command allows the issuer to control the HP
     SNA DHCF/XL subsystem.

SYNTAX


     DHCFCONTROL START
                 [;NODE=nodename]
                 [;TRACE]
                 [;TFILESIZE=recordcount]
                 [;COMMENT="reason"]
                 [;ERROPT=erroroption]
                 [;DEBUG=ldev]
                 [;OVERRIDE]

     DHCFCONTROL STARTSESS
                 [{;NODE=nodename    }]
                  {;LUNAME=hostluname}

     DHCFCONTROL STOP
                 [;NODE=nodename]
                 [;TYPE=stoptype]
                 [;DUMP]
                 [;COMMENT="reason"]

     DHCFCONTROL STOPSESS
                 [{;NODE=nodename    }]
                  {;LUNAME=hostluname}

                 [;TYPE=stoptype]
                 [;DUMP]
                 [;COMMENT="reason"]

     DHCFCONTROL TRACEON
                 [;NODE=nodename]
                 [;TFILESIZE=recordcount]
                 [;COMMENT="reason"]

     DHCFCONTROL TRACEOFF
                 [;NODE=nodename]

     DHCFCONTROL STATUS
                 [{;NODE=nodename    }]
                 {;LUNAME=hostluname}

     DHCFCONTROL DUMP
                 [{;NODE=nodename    }]
                 {;LUNAME=hostluname}
                 [;COMMENT="reason"]

     DHCFCONTROL [VERSION]


PARAMETERS


DHCFCONTROL START

            [;NODE=nodename]
            [;TRACE]
            [;TFILESIZE=recordcount]
            [;COMMENT="reason"]
            [;ERROPT=erroroption]
            [;DEBUG=ldev]
            [;OVERRIDE]

   NODE           If there is only one SNA DHCF node configured in the
                  NMCONFIG file, this parameter is optional and  SNA
                  DHCF will be started on behalf of that node. For more
                  than one SNA DHCF node configured in the NMCONFIG
                  file, this parameter is required and SNA DHCF will be
                  started on behalf of the node specified by nodename.

   nodename       An eight ( or fewer ) character nodename for which
                  SNA DHCF is to be started.  This is the nodename from
                  the NMCONFIG file and also the one used to start SNA
                  LINK.

   TRACE          This parameter is optional and specifies whether or
                  not SNA DHCF subsystem internal tracing is to be
                  activated.  When this parameter is used, tracing
                  remains active until the SNA DHCF subsystem is
                  stopped, or the TRACEOFF or TRACEON command is
                  issued.  The tracing information will be recorded in
                  a file named "NMTCnnnn.PUB.SYS", where "nnnn"
                  represents numerically sequential trace files.
                  The default is no tracing.

   TFILESIZE      This parameter is optional and is ignored unless the
                  TRACE parameter was specified.  It allows the issuer
                  to set the SNA DHCF trace file size.

   recordcount    A decimal number specifying the trace file size in
                  number of 128 word records.  The default is 10240.

   COMMENT        This parameter is optional and is ignored unless the
                  TRACE parameter was specified.  It allows the issuer
                  to provide a trace comment which will appear in a
                  formatted trace file.

   reason         Up to 160 characters surrounded by quotes explaining
                  why trace is being enabled.  The default is no
                  explanation.

   ERROPT         This parameter is optional and allows the issuer to
                  control whether a subsystem halt or system halt is to
                  occur if an internal SNA DHCF error is encountered.

   erroroption    This parameter specifies the action to be taken when
                  an irrecoverable internal error occurs in the  SNA
                  DHCF subsystem.  The following choices are available

                  SYS  Halts the system if an irrecoverable internal
                       error within the SNA DHCF subsystem occurs.

                  SUB  Shuts down the SNA DHCF subsystem if an
                       irrecoverable internal error within the SNA
                       DHCF subsystem occurs.

                  The default erroroption is SUB.

   DEBUG          This parameter is optional.  Use it to request the
                  SNA DHCF monitor to enter privilege mode debug
                  at the MPE/iX logical device indicated by ldev.
                  Use of this parameter requires PM and DI
                  capabilities in addition to the NM capability
                  required to issue the DHCFCONTROL command.

                  THE DEBUG PARAMETER IS INTENDED FOR USE BY HEWLETT-
                  PACKARD SUPPORT ENGINEERS.  HEWLETT PACKARD IS NOT
                  RESPONSIBLE FOR DAMAGES RESULTING FROM UNAUTHORIZED
                  USE.

   ldev           An MPE/iX logical device number which will be used to
                  debug the SNA DHCF monitor.

   OVERRIDE       This parameter is optional and allows the issuer to
                  override SNA DHCF version inconsistencies which would
                  normally prevent successful activation of the SNA DHCF
                  subsystem.  Use of this parameter requires PM and DI
                  capabilities in addition to the NM capability required
                  to issue the DHCFCONTROL command.

                  THE OVERRIDE PARAMETER IS INTENDED FOR USE BY HEWLETT
                  PACKARD SUPPORT ENGINEERS.  HEWLETT PACKARD IS NOT
                  RESPONSIBLE FOR DAMAGES RESULTING FROM UNAUTHORIZED
                  USE.

DHCFCONTROL STARTSESS

            [{;NODE=nodename    }]
             {;LUNAME=hostluname}

   NODE           This parameter is optional if there is only one active
                  SNA DHCF node.  Otherwise it is required.

   nodename       An eight ( or fewer ) character nodename for which an
                  SNA DHCF session should be started.  This is the node
                  name from the NMCONFIG file and also the one used to
                  start the SNA DHCF subsystem.

   LUNAME         This parameter is required and is used to specify
                  which SNA DHCF session to start.

   hostluname     An eight ( or fewer ) character name of the LU
                  identifying the SNA DHCF session to be started.  This
                  is an LU name from the NMCONFIG file which has been
                  configured under the node indicated by nodename.

DHCFCONTROL STOP

            [;NODE=nodename]
            [;TYPE=stoptype]
            [;DUMP]
            [;COMMENT="reason"]

   NODE           This parameter is optional if there is only one active
                  SNA DHCF node.  Otherwise it is required.

   nodename       An eight ( or fewer ) character nodename for which
                  SNA DHCF is to be stopped.  This is the nodename from
                  the NMCONFIG file and also the one used to start the
                  SNA DHCF subsystem.

   TYPE           This parameter is optional and allows the issuer to
                  specify how the SNA DHCF subsystem is to be stopped.

   stoptype       The manner in which you wish SNA DHCF to be stopped.
                  Valid choices are

                  K  (Kill) Immediate shutdown of SNA DHCF subsystem.
                     Any MPE/iX sessions will be terminated immediately.

                  P  (Protocol Shutdown) Immediate shutdown of SNA DHCF
                     subsystem, but waiting for any active sessions to
                     be notified.  Once all the sessions have been
                     notified, each session will be terminated along
                     with it's corresponding LU-LU session with HCF.

                  Q  (Quiesce) Orderly shutdown of SNA DHCF subsystem,
                     allowing all current sessions to be completed, but
                     preventing any new sessions from being started.
                     Each LU-LU session will not be stopped until the
                     session using it has been terminated; for
                     example, the user has logged off via the 'bye'
                     command.

                  The default stoptype is Q (Quiesce).

   DUMP           Perform a node-level dump of SNA DHCF data structures
                  to a file taking the form DHCFDMnn.DHCF.SYS, where nn
                  represents sequentially numeric dump files.

   COMMENT        This parameter is optional and is ignored unless the
                  DUMP parameter was specified.  It allows the issuer
                  to provide a dump comment which will appear in the
                  formatted dump file.

   reason         Up to 160 characters surrounded by quotes explaining
                  why a SNA DHCF dump is being taken.  The default is no
                  explanation.

DHCFCONTROL STOPSESS

            [{;NODE=nodename    }]
             {;LUNAME=hostluname}
            [;TYPE=stoptype]
            [;DUMP]
            [;COMMENT="reason"]

   NODE           This parameter is optional if there is only one active
                  SNA DHCF node.  Otherwise it is required.

   nodename       An eight ( or fewer ) character nodename for which an
                  SNA DHCF session is to be stopped.  This is the node
                  name from the NMCONFIG file and also the one used to
                  start the SNA DHCF subsystem.

   LUNAME         This parameter is required and is used to specify
                  which SNA DHCF session to stop.

   hostluname     An eight ( or fewer ) character name of the LU
                  identifying the SNA DHCF session to be stopped.

   TYPE           This parameter is optional and allows the issuer to
                  specify how the SNA DHCF session is to be stopped.

   stoptype       The manner in which you wish SNA DHCF to be stopped.
                  Valid choices are

                  K  (Kill) Immediate shutdown of SNA DHCF session.

                  P  (Protocol Shutdown) Immediate shutdown of SNA DHCF
                      session, after it has been notified.

                  Q  (Quiesce) Orderly shutdown of an SNA DHCF session.
                     The LU-LU session will not be stopped until the
                     session using it has been terminated; for example,
                     the user has logged off via the 'bye' command.

                  The default stoptype is Q (Quiesce).

   DUMP           Perform a session-level dump of SNA DHCF data
                  structures to a file taking the form
                  DHCFDMnn.DHCF.SYS, where nn represents sequentially
                  numeric dump files.

   COMMENT        This parameter is optional and is ignored unless the
                  DUMP parameter was specified.  It allows the issuer to
                  provide a dump comment which will appear in the
                  formatted dump file.

   reason         Up to 160 characters surrounded by quotes explaining
                  why an SNA DHCF dump is being taken.  The default is
                  no explanation.

DHCFCONTROL TRACEON

            [;NODE=nodename]
            [;TFILESIZE=recordcount]
            [;COMMENT="reason"]

   NODE           This parameter is optional if there is only one
                  active SNA DHCF node.  Otherwise it is required.

   nodename       An eight ( or fewer ) character nodename for which
                  SNA DHCF tracing is to be started.  This is the node
                  name from the NMCONFIG file and also the one used to
                  start the SNA DHCF subsystem.

   TFILESIZE      This parameter is optional and allows the issuer to
                  set the SNA DHCF trace file size.

   recordcount    A decimal number specifying the trace file size in
                  number of 128 word records.  The default is 10240.

   COMMENT        This parameter is optional and allows the issuer to
                  provide a trace comment which will appear in a
                  formatted trace file.

   reason         Up to 160 characters surrounded by quotes explaining
                  why tracing is being enabled.  The default is no
                  explanation.

DHCFCONTROL TRACEOFF

            [;NODE=nodename]

   NODE           This parameter is optional if there is only one active
                  SNA DHCF node.  Otherwise it is required.

   nodename       An eight ( or fewer ) character nodename for which
                  SNA DHCF tracing is to be stopped.  This is the node
                  name from the NMCONFIG file and also the one used to
                  start the SNA DHCF subsystem.

DHCFCONTROL STATUS

            [{;NODE=nodename    }]
            {;LUNAME=hostluname}

   NODE           This parameter is optional and allows the issuer to
                  request detailed SNA DHCF subsystem status about a
                  specific node.  If it is omitted, a node information
                  summary for all active SNA DHCF nodes will be
                  displayed.

   nodename       An eight ( or fewer ) character nodename for which
                  SNA DHCF status is to be reported.  This is the node
                  name from the NMCONFIG file and also the one used to
                  start the SNA DHCF subsystem.

   LUNAME         This parameter is optional.  Use it to request status
                  information about a specific session on a specific
                  node.  This parameter is ignored unless the NODE
                  parameter is specified.

   hostluname     An eight ( or fewer ) character name of the LU
                  identifying the SNA DHCF session for which status is
                  to be reported.

DHCFCONTROL DUMP

            [{;NODE=nodename    }]
            {;LUNAME=hostluname}

            [;COMMENT="reason"]

   NODE           This parameter is optional if there is only one active
                  SNA DHCF node.  Otherwise it is required.

   LUNAME         This parameter is optional and allows the issuer to
                  determine if a node-level or session-level dump is to
                  occur.  A session-level dump occurs for the session
                  represented by 'hostluname' if this parameter is
                  specified.  A node-level dump occurs if this parameter
                  is absent.

   hostluname     An eight ( or fewer ) character name of the LU
                  identifying the SNA DHCF session for which a dump is
                  to occur.

   COMMENT        This parameter is optional.  It allows the issuer to
                  provide a dump comment which will appears in the
                  formatted dump file.

   reason         Up to 160 characters surrounded by quotes explaining
                 why a SNA DHCF dump is being taken.  The default is no
                  explanation.

DHCFCONTROL [VERSION]

   The DHCFCONTROL VERSION command has no parameters.


OPERATION


START      Activate SNA DHCF subsystem for a specific SNA Node.

STARTSESS  Activate a specific SNA DHCF session on a given SNA Node.

STOP       Deactivate the SNA DHCF subsystem, including any active
           SNA DHCF sessions, for a specific SNA Node.

STOPSESS   Deactivate a specific SNA DHCF session on a given SNA Node.

TRACEON    Start the SNA DHCF internal trace facility.

TRACEOFF   Stop the SNA DHCF internal trace facility.

STATUS     Display the status of the SNA DHCF subsystem.

DUMP       Dump SNA DHCF subsystem data structures to a file.

VERSION    Display version information for the SNA DHCF subsystem.


EXAMPLE(S)

DHCFCONTROL START;NODE=DHCFNODE;TRACE

   This command requests that the node indicated by "DHCFNODE" be
   started with internal tracing turned on.

DHCFCONTROL STARTSESS;NODE=DHCFNODE;LUNAME=HOSTLU05

   This command requests that the logical unit indicated by "HOSTLU05"
   belonging to the node indicated by "DHCFNODE", be started.

DHCFCONTROL STOP;NODE=DHCFNODE;TYPE=K

   This command requests that the node indicated by "DHCFNODE"
   be stopped with the stoptype of Kill.

DHCFCONTROL STOPSESS;NODE=DHCFNODE;TYPE=Q;LUNAME=HOSTLU01

   This command requests that the logical unit indicated by "HOSTLU01"
   belonging to the node indicated by "DHCFNODE", be stopped with a
   stoptype of Quiesce.

DHCFCONTROL TRACEON;NODE=DHCFNODE

   This command requests that subsystem tracing be turned on for the
   node indicated by "DHCFNODE".

DHCFCONTROL TRACEOFF;NODE=DHCFNODE

   This command requests that subsystem tracing be turned off for the
   node indicated by "DHCFNODE".

DHCFCONTROL STATUS


   This command requests that status information summary be displayed
   for all active SNA DHCF nodes.  If only one SNA DHCF node is
   active, a detailed status summary will be displayed for that node.

DHCFCONTROL DUMP


   This command will dump SNA DHCF subsystem data structures assuming
   there is only one active node.

DHCFCONTROL VERSION


   This command requests that version information be displayed for the
   SNA DHCF subsystem.

Back to Main Index