/sys$common/syshlp/NCLHELP.HLB  —  loop

1  –  loopback_application

    Starts a loop test between the loopback applications on the
    specified source and destination nodes.

    loop [node node-id] loopback application -
         name fullname [,optional arguments...]

    loop [node node-id] loopback application  -
         address tower-set [,optional arguments...]

    The node keyword specifies the node from which the loop messages
    are sent. If you omit this keyword, the test is performed from the
    node on which you issue the loop command.  The Name or Address
    argument specifies the node whose loop mirror is used to reflect
    the messages back to the originator.  Either the Name or Address
    argument is required, but not both.  The MIRRO$SERVER account on
    the remote end must have at least the NET$EXAMINE right.

    Optional arguments are:  format, length, and count.

    Examples:

    loop loopback application name -  ! The "DOMAIN:" namespace
         DOMAIN:LAMCHP.SCH.DEC.COM    !  nickname is required for IP
                                      !  fullnames

    loop loopback application name LOCAL:.LAMCHP, count 10

    loop loopback application address = {([%x0119], -
         [dna_sessioncontrolv3, number = 25], -
         [dna_nsp], -
         [dna_osinetwork, 49::00-04:AA-00-04-00-1A-10:20])}, -
         format ff, count 10

1.1  –  address

    Address is the number of the destination for loopback messages
    in the form of a protocol tower. Specify either this argument or
    the Name argument.

    loop [node node-id] loopback application  -
         address tower-set [,optional argument...]

    Optional arguments are: format, length, count.

    Examples:

    loop loopback application address = {([%x0119], -
         [dna_sessioncontrolv3, number = 25], -
         [dna_nsp], -
         [dna_osinetwork, 49::00-04:AA-00-04-00-1A-10:20])}

    loop loopback application address = {([%x0119], -
         [dna_sessioncontrolv3, number = 25 ], -
         [dna_ositransportV1, %xDEC0 ] , -
         [dna_osinetwork, 49::00-04:AA-00-04-00-1A-10:21])}

1.2  –  count

    The optional argument Count is the number of loop messages to be
    sent to the loop mirror.  The test is complete when this number of
    loop messages has been reflected back by the loop mirror.  The
    default is 1, the value must be 0-4294967295.

    loop [node node-id] loopback application name full-name, -
         count integer [,optional arguments...]

    loop [node node-id] loopback application address tower-set, -
         count integer [,optional arguments...]

    Example:

    loop loopback application name DEC:.SCH.LAMCHP, count 10

1.3  –  format

    The optional Format argument is an octet (00-FF) which specifies
    the value of each byte in the test data part of each loop message.
    The default results in alternating 0 and 1 bits (55).

    loop [node node-id] loopback application name full-name, -
         format octet [,optional arguments...]

    loop [node node-id] loopback application address tower-set, -
         format octet [,optional arguments...]

    Example:

    loop loopback application name DEC:.SCH.LAMCHP, format FF

1.4  –  length

    The optional argument Length specifies the length, in octets,
    of the data field in each loop message.  The default is 40,
    and the value must be 0-65534.

    loop [node node-id] loopback application name full-name, -
         length integer [,optional arguments...]

    loop [node node-id] loopback application address tower-set, -
         length integer [,optional arguments...]

    Example:

    loop loopback application name DEC:.SCH.LAMCHP, length 80

1.5  –  name

    Name is the fullname of the node to which loopback messages are
    sent. Specify either this argument or the Address argument, but
    not both.   Optional arguments are: format, length, count.

    loop [node node-id] loopback application  -
         name full-name [,optional arguments...]

    Examples:

    loop loopback application name DOMAIN:LAMCHP.SCH.DEC.COM

    loop loopback application name DEC:.SCH.LAMCHP

    loop loopback application name LOCAL:.LAMCHP, length 80

1.6  –  Exception Messages

 o  bad data at mirror

    There has been an error in the loopback protocol. The possible
    errors are:

    o  The local node sent a loop message with a data field that was
       too long.

    o  The first octet of the loop message was corrupted when it
       arrived at the mirror module.

    Arguments:

    count          Requested number of messages in the loopback test
                   (that is, the value of the count argument).

    message        Number of the loop messages in which the error
    number         occurred.

    start time     Time at which the loopback test began.

 o  both name and address specified

    Both the name and address arguments have been specified. You must
    specify one of these arguments, but not both.

 o  neither name nor address specified

    Either the name or address argument must be specified, but not both.

 o  connection failed

    The session control connection to the loop mirror failed.

    Arguments:

    reason     Reason why the connection failed. This is the reason
               code provided by session control.

    start      Time the loopback test began.
    time

 o  data returned differs from data sent

    The data field in a loop message reflected back by the loop
    mirror is not the same as the data field in the loop message
    that was sent.

    Arguments:

    count      Requested number of messages in the loopback test (that
               is, the value of the count argument).

    format     Value for each octet of the data field of the loop
               message (that is, the value of the format argument).

    length     Length of the data field of the loop message, as
               requested by the length argument.

    message    Number of the loop message in which the error occurred.
    number

    message    Contents of the reflected loop message.
    returned

    start      Time the loopback test began.
    time

 o  disconnected

    The link to the loop mirror was disconnected before the loopback
    test was completed.

    Arguments:

    count      Requested number of messages in the loopback test (that
               is, the value of the count argument).

    message    Number of the loop message in which the error occurred.
    number

    reason     Reason why the link was disconnected. This is the
               reason code returned by session control.

    start      Time the loopback test began.
    time

 o  length too long

    The requested length of the data field is greater than the
    maximum data field length that the loop mirror can handle.

    Arguments:

    length     Data field length requested, in octets.
    maximum    Maximum data field length supported by the loop
    data       mirror.

    start      Time at which the loopback test began.
    time

 o  namespace name is invalid or not in cache

    The fullname provided is not valid.  Use a different fullname,
    or refer to HELP NETWORK_MANAGEMENT TOOLS DECNET_REGISTER for
    information on how to add this node to your node database.

2  –  mop

2.1  –  circuit

    Performs a loop operation with another system.

    loop  [node node-id] mop circuit circuit-name -
          address lan-address [,optional arguments...]

    If an Address is not supplied in the command on a LAN circuit,
    then the Client argument must be specified so the address
    information can be obtained from the MOP Client database.

    loop  [node node-id] mop circuit circuit-name -
          client client-name [,optional arguments...]

    Optional arguments for this loop mop circuit command are:
    Assistance Type, Assistant Address, Assistant System, Count,
    Format, and Length.

    Examples:

    loop mop circuit csmacd-1 address 08-00-2b-00-13-4F

    loop mop circuit fddi-1 client mynode ! Client gives Address

2.1.1  –  address

    Address is the LAN address of the circuit named in the
    circuit argument. This argument is required for LAN circuits.

    loop  [node node-id] mop circuit circuit-name -
          address lan-address [,optional arguments...]

    If an Address is not supplied in the command on a LAN circuit,
    then the Client argument must be specified so the address
    information can be obtained from the MOP Client database.

    loop  [node node-id] mop circuit circuit-name -
          client client-name [,optional arguments...]

    Optional arguments for this loop mop circuit command are:
    Assistance Type, Assistant Address, Assistant System, Count,
    Format, and Length.

2.1.2  –  assistance_type

    Assistance Type is an optional argument that specifies the
    degree of loopback assistance required.  Valid Assistant
    Type values are none, transmit, receive, and full.  This
    argument is for LAN circuits only.  If Assistance Type is
    any value other than none (the default), then an assistant
    is required.

    An assistant can be specified either by including an
    Assistant Address or Assistant System argument in the
    command line, but not both.  If neither is provided, then
    an assistant is located by first sending a request to the
    loopback assistant multicast address.

    loop  [node node-id] mop circuit circuit-name -
      address lan-address, -
      assistant address lan-address, -
      assistance type help-type [,optional arguments...]

    Address information specifying the node to receive the
    loop is required for the loop mop circuit command.  If
    the Address argument is not specified in the command,
    then the Client argument must be specified so the address
    information can be obtained from the MOP Client
    database.

    loop  [node node-id] mop circuit circuit-name -
      client client-name, -
      assistant system client-name, -
      assistance type help-type [,optional arguments...]

    Examples:

    loop mop circuit fddi-1 -
      address 08-00-2b-00-78-E4, -
      assistant address aa-00-04-00-33-44, -
      assistance type full

    loop mop circuit csmacd-1 -
      client foofoo, -        ! Client foofoo gives loop Address
      assistant system barbar,- ! barbar gives Assistant Address
      assistance type full

2.1.3  –  assistant_address

    The optional Assistant Address argument specifies the
    LAN address of the node to be used as a loopback assistant.
    This argument is meaningful for LAN circuits only.

    The involvement of the assistant depends on the Assistance
    Type parameter. For assistance of type none (the default),
    no assistant is needed, and is ignored if specified. For
    other values, an assistant is required.

    An assistant can be specified either by including an
    Assistant Address or Assistant System argument in the
    command line, but not both.  If neither is provided, then
    an assistant is located by first sending a request to the
    loopback assistant multicast address.

    Address information specifying the node to receive the
    loop is required for the loop mop circuit command.  If the
    Address argument is not specified in the command, then the
    Client argument must be specified so the address
    information can be obtained from the MOP Client
    database.

    loop  [node node-id] mop circuit circuit-name -
      address lan-address, -
      assistance type transmit-receive-or-full, -
      assistant address lan-address [,optional arguments...]

    loop  [node node-id] mop circuit circuit-name -
      client client-name, -
      assistance type transmit-receive-or-full, -
      assistant address lan-address [,optional arguments...]

    Examples:

    loop mop circuit fddi-1 -
      address 08-00-2b-00-33-44, -
      assistant address aa-00-04-00-33-44, -
      assistance type receive

    loop mop circuit csmacd-1 -
      client foofoo, -     ! Client foofoo gives loop Address
      assistant address aa-00-04-00-33-44, -
      assistance type full

2.1.4  –  assistant_system

    The optional Assistant System argument specifies a MOP
    client entity, from which an assistant address can be
    obtained.   This argument is meaningful for LAN circuits
    only.  The assistant address is the LAN address of the
    node to be used as the loopback assistant.

    The involvement of the assistant depends on the Assistance
    Type parameter. For assistance of type none (the default),
    no assistant is needed, and is ignored if specified. For
    other values, an assistant is required.

    An assistant can be specified either by including an
    Assistant Address or Assistant System argument in the
    command line, but not both.  If neither is provided, then
    an assistant is located by first sending a request to the
    loopback assistant multicast address.

    Address information specifying the node to receive the
    loop is required for the loop mop circuit command.  If the
    Address argument is not specified in the command, then the
    Client argument must be specified so the address
    information can be obtained from the MOP Client database.

    loop  [node node-id] mop circuit circuit-name -
      address lan-address, -
      assistance type transmit-receive-or-full, -
      assistant system client-name [,optional arguments...]

    loop  [node node-id] mop circuit circuit-name -
      client client-name, -
      assistance type transmit-receive-or-full, -
      assistant system client-name [,optional arguments...]

    Examples:

    loop mop circuit fddi-1 -
      address 08-00-2b-00-33-44, -
      assistant system barbar, - ! Client barbar has Assistant Address
      assistance type full

    loop mop circuit csmacd-1 -
      client foofoo, -            ! Client foofoo gives loop Address
      assistant system barbar, -  ! barbar gives Assistant Address
      assistance type transmit

2.1.5  –  client

    A client entity to be used to provide the LAN address for
    this loop operation.   If an Address is not supplied in the
    command on a LAN circuit, then the Client argument is
    required so the address information can be obtained from the
    MOP Client database.

    loop  [node node-id] mop circuit circuit-name -
          client client-name [,optional arguments...]

    Optional arguments for this loop mop circuit command are:
    Assistance Type, Assistant Address, Assistant System, Count,
    Format, and Length.

    Example:

    loop mop circuit csmacd-1 -
         client lamchp          ! Client gives default loop Address

2.1.6  –  count

    The optional Count argument is an integer between 0-4294967295
    which specifies the number of messages to be looped. The
    default count is 1.  Note, on failure of the loop test, NCL
    will display the count of messages successfully looped.

    loop  [node node-id] mop circuit circuit-name -
          address lan-address, -
          count integer [,optional arguments...]

    If an Address is not supplied in the command on a LAN circuit,
    then the Client argument must be specified so the address
    information can be obtained from the MOP Client database.

    loop  [node node-id] mop circuit circuit-name -
          client client-name, -
          count integer [,optional arguments...]

    Examples:

    loop mop circuit csmacd-1 address 08-00-2b-00-13-4F, count 50

    loop mop circuit fddi-1 -
         client mynode, count 10  ! Client gives default Address

2.1.7  –  format

    The optional Format argument is an octet (00-FF) which
    specifies the value of each byte in the test data part of each
    loop message.  The default results in alternating 0 and 1 bits
    (55).

    loop  [node node-id] mop circuit circuit-name -
          address lan-address, -
          format octet [,optional arguments...]

    If an Address is not supplied in the command on a LAN circuit,
    then the Client argument must be specified so the address
    information can be obtained from the MOP Client database.

    loop  [node node-id] mop circuit circuit-name -
          client client-name, -
          format octet [,optional arguments...]

    Examples:

    loop mop circuit csmacd-1 address 08-00-2b-00-13-4F, format FF

    loop mop circuit fddi-1 -
         client mynode, format 00  ! Client gives default Address

2.1.8  –  length

    The optional Length argument specifies the length of the test
    data part of each loop message. The maximum and minimum
    permitted values depend on the particular data link in use.
    The range is 0-4294967295.  The default length is 40.

    loop  [node node-id] mop circuit circuit-name -
          address lan-address, -
          length integer [,optional arguments...]

    If an Address is not supplied in the command on a LAN circuit,
    then the Client argument must be specified so the address
    information can be obtained from the MOP Client database.

    loop  [node node-id] mop circuit circuit-name -
          client client-name, -
          length integer [,optional arguments...]

    Examples:

    loop mop circuit csmacd-1 address 08-00-2b-00-13-4F, length 20

    loop mop circuit fddi-1 -
         client mynode, length 45  ! Client gives default Address

2.1.9  –  Exception Messages

 o  data link error

    An error was reported by the Data Link layer on the loop command.

 o  unrecognized client

    There is no client with the specified identification on the loop
    command.

 o  unrecognized circuit

    There is no circuit with the specified identification on the loop
    command.

 o  unrecognized assistant

    There is no assistant with the specified identification on the
    loop command.  The specified Assistant System does not exist in
    the MOP Client database.

 o  invalid assistant

    The assistant address is either a multicast address, or assistant
    system was specified, and the corresponding client subentity has
    the default value for its address on the loop command.

 o  timeout

    Operation has timed out on the loop command.

 o  entity class not supported (OpenVMS)

    MOP is not registered with EMAA.  The NET$MOP process is probably
    not started.  For instructions on how to restart the MOP process,
    refer to HELP NETWORK_MANAGEMENT MOP.

2.2  –  client

    Performs a loop operation with another system.

    loop [node node-id] mop client client-name [,optional args...]

    For a LAN circuit, if there is no default Address and Circuit
    information specified for this client in the MOP Client database,
    then that information must be specified on the command line.

    loop  [node node-id] mop client client-name -
          address lan-address, -
          circuit circuit-name [,optional arguments...]

    Optional arguments for this loop mop client command are:
    Assistance Type, Assistant Address, Assistant System, Count,
    Format, and Length.

    Examples:

    loop mop client lamchp    ! Client provides Address and Circuit.

    loop mop client lamchp -  ! Overrides default Circuit
         circuit csmacd-1     ! provided by Client

2.2.1  –  address

    Address is the LAN address of node to loop.  If Address and
    Circuit information is not supplied in the command on a LAN
    circuit, then that information must be available from the MOP
    Client database.

    loop  [node node-id] mop client client-name -
          address lan-address, -
          circuit circuit-name [,optional arguments...]

    Optional arguments for this loop mop circuit command are:
    Assistance Type, Assistant Address, Assistant System, Count,
    Format, and Length.

    Example:

    loop mop client mynode -          ! Client provides Circuit.
         address 08-00-2b-33-45-DD

2.2.2  –  assistance_type

    Assistance Type is an optional argument that specifies the
    degree of loopback assistance required.  Valid Assistant Type
    values are none, transmit, receive, and full.  This argument
    is for LAN circuits only.  If Assistance Type is any value
    other than none (the default), then an assistant is required.

    An assistant can be specified either by including an Assistant
    Address or Assistant System argument in the command line, but
    not both.  If neither is provided, then an assistant is
    located by first sending a request to the loopback assistant
    multicast address.

    loop  [node node-id] mop client lamchp -
      assistance type transmit-receive-or-full, -
      assistant address lan-address [,optional arguments...]

    Address and Circuit information loop is required for the loop
    mop client command.  If the Client cannot provide default
    Address and Circuit information, then that information must
    be specified in the command.

    loop  [node node-id] mop client client-name -
      address lan-address, -
      circuit circuit-name, -
      assistance type transmit-receive-or-full, -
      assistant system client-name [,optional arguments...]

    Examples:

    loop mop client lamchp -  ! Client gives Address and Circuit
      assistant address aa-00-04-00-33-44, -
      assistance type full

    loop mop client lamchp -  ! Client lamchp gives default Circuit
      address 08-00-2b-34-44-EF, -
      assistant system barbar,- ! barbar gives Assistant Address
      assistance type full

2.2.3  –  assistant_address

    The optional Assistant Address argument specifies the LAN address
    of the node to be used as a loopback assistant. This argument is
    meaningful for LAN circuits only.

    The involvement of the assistant depends on the Assistance Type
    parameter. For assistance of type none (the default), no assistant
    is needed, and is ignored if specified. For other values, an
    assistant is required.

    An assistant can be specified either by including an Assistant
    Address or Assistant System argument in the command line, but not
    both.  If neither is provided, then an assistant is located by
    first sending a request to the loopback assistant multicast
    address.

    loop  [node node-id] mop client client-name -
      assistance type transmit-receive-or-full, -
      assistant address lan-address [,optional arguments...]

    Address and Circuit information loop is required for the loop mop
    client command.  If the Client cannot provide default Address and
    Circuit information, then that information must be specified in
    the command.

    loop  [node node-id] mop client client-name -
      address lan-address, -
      circuit circuit-name, -
      assistance type transmit-receive-or-full, -
      assistant address lan-address [,optional arguments...]

    Examples:

    loop mop client lamchp -   ! Client gives Address and Circuit
      assistant address aa-00-04-00-33-44, -
      assistance type transmit

    loop mop client foofoo -  ! Client gives default loop Address
      circuit fddi-1, -
      assistant address aa-00-04-00-33-44, -
      assistance type receive

2.2.4  –  assistant_system

    The optional Assistant System argument specifies a MOP client
    entity, from which an assistant address can be obtained.
    This argument is meaningful for LAN circuits only.  The
    assistant address is the LAN address of the node to be used as
    the loopback assistant.

    The involvement of the assistant depends on the Assistance Type
    parameter. For assistance of type none (the default), no
    assistant is needed, and is ignored if specified. For other
    values, an assistant is required.

    An assistant can be specified either by including an Assistant
    Address or Assistant System argument in the command line, but
    not both.  If neither is provided, then an assistant is
    located by first sending a request to the loopback assistant
    multicast address.

    loop  [node node-id] mop client client-name -
      assistance type transmit-receive-or-full, -
      assistant system client-name [,optional arguments...]

    Address and Circuit information loop is required for the loop mop
    client command.  If the Client cannot provide default Address and
    Circuit information, then that information must be specified in
    the command.

    loop  [node node-id] mop client client-name -
      address lan-address, -
      circuit circuit-name, -
      assistance type transmit-receive-or-full, -
      assistant system client-name [,optional arguments...]

    Examples:

    loop mop client lamchp -     ! Lamchp gives Address and Circuit
      assistant system prkchp, - ! Client prkchp has Assistant Address
      assistance type full

    loop mop client foofoo -     ! Client foofoo gives default Circuit
      address 08-00-2b-44-33-5F, -
      assistant system barbar, - ! Barbar gives Assistant Address
      assistance type full

2.2.5  –  circuit

    The Circuit over which the loop operation is to be performed.
    The the Client specified cannot provide Circuit and Address
    information, then that information must be specified in the
    command.

    loop  [node node-id] mop client client-name -
          address lan-address, -
          circuit circuit-name [,optional arguments...]

    Optional arguments for this loop mop circuit command are:
    Assistance Type, Assistant Address, Assistant System, Count,
    Format, and Length.

    Example:

    loop mop client lamchp -  ! Client lamchp gives loop Address
         circuit csmacd-1

2.2.6  –  count

    The optional Count argument is an integer between 0-4294967295
    which specifies the number of messages to be looped. The
    default count is 1.  Note, on failure of the loop test, NCL
    will display the count of messages successfully looped.

    loop  [node node-id] mop client client-name -
          count integer [,optional arguments...]

    Address and Circuit information loop is required for the loop
    mop client command.  If the Client cannot provide default
    Address and Circuit information, then that information must
    be specified in the command.

    loop  [node node-id] mop client -
          address lan-address, -
          circuit circuit-name, -
          count integer [,optional arguments...]

    Examples:

    loop mop client lamchp -  ! Lamchp gives Address and Circuit
          count 50

    loop mop client mynode -  ! Mynode gives default Address
         circuit fddi-1, -
         count 10

2.2.7  –  format

    The optional Format argument is an octet (00-FF) which
    specifies the value of each byte in the test data part of
    each loop message.  The default results in alternating 0
    and 1 bits (55).

    loop  [node node-id] mop client client-name -
          format octect [,optional arguments...]

    Address and Circuit information loop is required for the
    loop mop client command.  If the Client cannot provide
    default Address and Circuit information, then that
    information must be specified in the command.

    loop  [node node-id] mop client -
          address lan-address, -
          circuit circuit-name, -
          format octet [,optional arguments...]

    Examples:

    loop mop client lamchp -  ! Client gives Address and Circuit
          format ff

    loop mop client mynode -  ! Client gives default Address
         circuit fddi-1, -
         format 00

2.2.8  –  length

    The optional Length argument specifies the length of the test
    data part of each loop message. The maximum and minimum
    permitted values depend on the particular data link in use.
    The range is 0-4294967295.  The default length is 40.

    The optional Format argument is an octet (00-FF) which
    specifies the value of each byte in the test data part of
    each loop message.  The default results in alternating 0 and
    1 bits (55).

    loop  [node node-id] mop client client-name -
          length integer [,optional arguments...]

    Address and Circuit information loop is required for the loop
    mop client command.  If the Client cannot provide default
    Address and Circuit information, then that information must
    be specified in the command.

    loop  [node node-id] mop client -
          address lan-address, -
          circuit circuit-name, -
          length integer [,optional arguments...]

    Examples:

    loop mop client lamchp -  ! Client gives Address and Circuit
         length 20

    loop mop client mynode -  ! Client gives default Circuit
         address 08-00-2b-34-56-DD, -
         length 45

2.2.9  –  Exception Messages

 o  data link error

    An error was reported by the Data Link layer on the loop
    command.

 o  unrecognized client

    There is no client with the specified identification on
    the loop command.

 o  unrecognized circuit

    There is no circuit with the specified identification on
    the loop command.

 o  unrecognized assistant

    There is no assistant with the specified identification on
    the loop command.  The specified Assistant System does not
    exist in the MOP Client database.

 o  invalid assistant

    The assistant address is either a multicast address, or
    assistant system was specified, and the corresponding client
    subentity has the default value for its address on the loop
    command.

 o  timeout

    Operation has timed out on the loop command.

 o  entity class not supported (OpenVMS)

    MOP is not registered with EMAA.  The NET$MOP process is
    probably not started.  For instructions on how to restart the
    MOP process, refer to HELP NETWORK_MANAGEMENT MOP.
Close Help