UAF> grant/id net$examine Joe  ! Grant user Joe read access to local network data
UAF> grant/id net$manage  Joe  ! Grant user Joe read/write access to local network data
UAF> grant/id net$security Joe  ! Grant user Joe ability to set default accounts

In lieu of NET$MANAGE rights, the BYPASS privilege grants read and write access.

When issuing NCL commands to the local node (for example, NCL SHOW ALL or NCL SHOW NODE 0 ALL), the rights of the executing process determine whether access is granted.

If the account that runs the CML application does not have the NET$EXAMINE for read access, or NET$MANAGE identifier for read and write access, then the access is denied by the management agent.

The last option is one of the selections offered by NET$CONFIGURE when configuring the application database. If you select a default account for the CML application, NET$CONFIGURE grants NET$EXAMINE right to that account by default.

There are several methods of invoking the interactive NCL utility:

The ncl> prompt indicates that you are using the NCL utility. When you receive this prompt, you can enter NCL commands.

Other NCL operations include:

When you enter Help, you enter a standard help library containing descriptions of the network management entities and their attributes. NCL online help is a quick reference in addition to this book.

ncl> help or ?
  Information available:

  add        advertise  block      boot       change     clear      connect
  create     define_(Tru64_UNIX)   delete     Directory_Module      disable
  disconnect dump       echo       enable     Entity_Hierarchy
  Event_Messages        flush_(OpenVMS)       getnif     getsif     ignore
  limit      load       loop       NCL_Introduction      Network_Management
  pass       ping_(IP_Routers)     Please_Read_Me        query
  read_(Tru64_UNIX)     remove     rename     reset      restrict   set
  show       shut       shutdown   snapshot   SNA_Peer_Server_Module
  start      startloop  stop       stoploop   synchronize           test
  testevent  undefine_(Tru64_UNIX) unlimit    update     zero

  Topic?

Topic? add

ADD

  Additional information available:
  modem_connect    mop         osi_transport  routing
  session_control  x25_access  x25_protocol   x25_relay
  x25_server

ADD Subtopic?

ADD Subtopic? x25_relay
ADD

  x25_relay

    Additional information available:

    client     pvc

ADD x25_relay Subtopic?

ADD x25_relay Subtopic? client

ADD

  x25_relay

    client

         add  [node  node-id] x25 relay client client-name
               filters
               rights identifiers



      Additional information available:

      Characteristics       Identifiers

ADD x25_relay client Subtopic?

Continue down the hierarchy exactly as it appears in the syntax section of each entity module, as illustrated in Part 2 of this book.

NCL help includes several non-verb help topics that provide additional information about using NCL. The following display shows these help topics and their subtopics:

Entity_Hierarchy
  Additional information available:

  Node       DNS_Clerk  DNS_Server DSA        DTSS       Event_Dispatcher
  Alias_(OpenVMS)       Session_Control       OSAK       NSP
  OSI_Transport         Routing    X25_Protocol          X25_Access
  X25_Client_(OpenVMS)  X25_Relay_(Alpha)     X25_Server XOT_(OpenVMS_Alpha)
  LAPB       CSMA-CD    LLC2       MOP        HDLC       DDCMP_(OpenVMS_VAX)
  FDDI       Modem_Connect         Device     Frame_(OpenVMS)
  Token_Ring_(Tru64_UNIX)          Loopback_Application

Event_Messages
  Additional information available:

  csma-cd_station       ddcmp_link_(OpenVMS_VAX)         device_unit
  dtss       event_dispatcher      fddi_station          hdlc_link  lapb_link
  llc2_sap   modem_connect_line    mop_circuit           node       nsp
  osak       osi_transport         routing    session_control
  token_ring_(Tru64_UNIX)          x25_access x25_client_(OpenVMS)
  x25_protocol          x25_relay_(Alpha)     x25_server xot_(OpenVMS_Alpha)

NCL_Introduction
  Additional information available:

  Invoking_NCL                     Creating_Logs         Common_Commands
  Abbreviation_of_Commands         Syntax     Recalling_Commands    Output
  Specifying_Access_Control        Default_Context       Using_Snapshot
  Customizing_NCL

Network_Management
  Additional information available:
  Access_Control        Naming_Service_Management
  Remote_Node_Management           Logical_Names_(OpenVMS)
  Startup_Scripts_(OpenVMS)        Shutdown_and_Restart_(OpenVMS)
  MOP_(OpenVMS)         Event_Dispatcher_(OpenVMS)       Running_Over_TCP-IP
  Tools

Please_Read_Me
  Additional information available:

  Using_NCL_Help        Overview_of_NCL_Help Entity_Organization
  Managing_Entities_Using_NCL

$ help decnet-plus

To keep a record of the commands entered during an NCL session, use the NCL logging facility.

All information printed out in an NCL session is stored in the log file after logging is enabled. This information includes commands, output, and error messages. All information except the commands are preceded in the file by a comment symbol, so this file can be used as an NCL script in another session.

ncl> set ncl logfile filename.ncl
ncl> enable ncl logging
ncl> show node 0 session control application fal all attributes
   .
   .
   .

After saving the NCL commands to a log file, use the NCL log file as an indirect command file to be invoked (during subsequent NCL sessions) with the do control verb or the at sign (@) symbol.

ncl> enable node 0 session control
ncl> do setup_applications.ncl
   .
   .
   .

To display the name of the log file, enter show ncl logfile. The default file extension for an NCL log file is .ncl. The utility returns an error message if a log file does not exist.

Use the disable ncl logging command at any time to turn off NCL logging or to exit NCL.

You can execute commands saved in an NCL log file during subsequent NCL utility sessions. However, you must ensure that the proper context for the commands in the log file has been established. Check the contents of an NCL log file before running it in later utility sessions.

Under normal conditions, you can identify the remote node by name in the NCL command. However, if the name service is interrupted or unavailable, you can still reach remote nodes to perform management functions. You can use either the remote node's Phase IV address (if the remote node is configured to have one), or the remote node's network services access point (NSAP). Refer to the VSI DECnet-Plus Planning Guide for UNIX or OpenVMS NSAP format to use.

ncl> show node 12.5 routing circuit syn-0-0
ncl> show node net$49000CAA000400053020 routing circuit syn-0-0

ncl> add node 0 osi transport cons filters {filter_2,filter_3}

This command line adds two new values, filter_2 and filter_3, to the set of values represented by the cons filters characteristic of the OSI Transport entity. The values are enclosed in { }, and if more than one value is to be added in the same command, each value is separated from the previous value by a comma.

To specify the empty set (that is, a set with no values), specify { } as the value.

ncl> remove node 0 osi transport cons filters {filter_3}

This command line removes the value filter_3 from the set.

Use the add and remove commands only on characteristics with set values (as indicated in the description of the characteristic).

You can also use the set command to change the values of a set-valued characteristic. However, the set command replaces the current contents of the set with the values you specified.

Use the create command to create a new instance of an entity. Most entities support the create command; however, some entities are created automatically by software, and so do not support the create command. For example, entities that correspond to communications links are usually created dynamically as these links are opened.

Use the delete command to delete an instance of an entity. As with create, most entities support the delete command; however, some entities are deleted automatically by software, and so do not support the delete command. For example, entities that correspond to communications links are usually deleted dynamically as these links are closed. You cannot delete an entity if it has child entities; you must delete all child entities before you can delete the parent entity. It is usually, though not always, the case that you must disable an entity before you can delete it.

ncl> disable modem connect line line-1

This command line disables the entity to suspend its operation temporarily and suspends operation of the corresponding physical line.

Use the enable command to place the entity in its enabled (on) state. Most entities do not become operational immediately when you create them; you must use the enable command after the create command. If you disable an entity to modify its characteristics or to suspend its operation for a time, you must use the enable command to make the entity operational again.

ncl> set node 0 osi transport delay factor=6,delay weight=10

This command line modifies two characteristics of the OSI Transport entity. If you specify more than one characteristic in a set command, use a comma to separate each characteristic and its value.

ncl> set node 0 osi transport delay factor

ncl> set node 0 osi transport cons filters={filter_2,filter_3}

ncl> add node 0 osi transport cons filters={filter_2,filter_3}

The set command gives the cons filters characteristic a set value with two components: filter_2 and filter_3; if the set previously had other values, these are lost. The add command, on the other hand, adds the values filter_2 and filter_3 to whatever values the characteristic already has; any other current values are retained.

To specify the empty set (that is, a set with no values), specify { } as the value.

You can change the set of attributes called characteristics only by direct management commands and not by the system or indirect commands. For example, you can change characteristics by the set command, but not by the create or enable commands. However, some characteristics are read-only and never change. Each entity section gives complete information about the entity's characteristics, if any, and explains if and how they are modified.

Sequences, sets, and similar constructed data types must be explicitly stated in a set command.

ncl> show entity-name attribute-specifier,...

ncl> show node 0 ddcmp link link-5 protocol, transmit underruns, state

ncl> show node 0 ddcmp link link-5 all counters, all status

ncl> show node 0 ddcmp link link-5 protocol, all counters

This example displays the value of the characteristic protocol and the value of all counters.

There are a few attributes whose value cannot be displayed. These are usually attributes that represent secure information, such as passwords.

node 0 routing circuit ether-1 reachable address foo

Node 0 is a class/instance pair for the global Node entity. Node 0 is a designation for the local system and is the default value for NCL commands. The "node node-name" element in an NCL command is thus not required when the operation to be performed is for an entity on the local system.

Certain NCL commands, such as show, can include one or more attribute specifiers. The following sections describe the five basic attribute specifiers.

Certain NCL commands have required or optional arguments. Arguments can indicate values to be set, data to be operated on, or instructions for performing a specified task.

Most NCL commands accept two types of prepositional phrases:

You can specify one or both prepositional phrases in any NCL command that accepts them. Separate the prepositional phrases by a comma. See individual command descriptions to determine which commands support the use of prepositional phrases.

ncl> show node 0 session control application *, with maximum instances>0

ncl> show 0 session control port *, with send queue > 0

Node 0 Session Control Port %XCC354000
AT 1991-11-13-16:32:03.249-05:00I0.269

Status

     Send Queue = 0

All NCL commands are made up of the same components: keywords, values, and punctuation. Keywords and punctuation are the parts of the NCL syntax that remain the same for every network; values are the parts that change depending on the particular configuration of a network. Values include entity instance identifiers and attribute/argument values. In general, you cannot abbreviate values, but you can abbreviate keywords as long as the abbreviation is unique. A misspelling may cause NCL to treat an entity name as if it were an attribute name. However, if spelled correctly, it recognizes multiword keywords.

For example, the following command lines are equivalent:

ncl> show node finance routing circuit *
ncl> sho no finance ro ci *

ncl> show node finance name
ncl> show node f name

The latter command tries to communicate with node f, not node finance.

ncl> s n finance r c * probe rate

The command is ambiguous because the abbreviation s could stand for either the set or show command.

However, if the value itself consists of keywords, then it can be abbreviated. For example, the data type EntityClass, by definition, contains keywords representing the various entity class names. These keywords can be abbreviated in the same way as normal keywords, as long as the abbreviations are unique (unambiguous). See Appendix B for more information on data types and keywords.

ncl> pass ev d out s local_stream gl f ((r), all)
ncl> pass event dispatcher outbound stream local_stream global filter -
_ncl> (( routing ), all)

You can substitute an unqualified name for a full name in an NCL command only when the remote node specified in the command and the local node use the same primary naming service and their full names are identical except for the unqualified names themselves.

                      LOCAL NODE           REMOTE NODE

Full name:            ns:.lkg.localnode    ns:.lkg.remotenode
Unqualified name:     localnode            remotenode
Synonym:              locnod               remnod

Full name:            local:.localnode     local:.remotenode
Unqualified name:     localnode            remotenode
Synonym:              locnod               remnod

ncl> set event dispatcher outbound stream ost_1 sink node remote node

                      LOCAL NODE             REMOTE NODE

Full name:            ns:.uct.localnode      ns:.lkg.remotenode
Unqualified name:     localnode              remotenode
Synonym:              locnod                 remnod

Full name:            ns:.localnode          local:.remotenode
Unqualified name:     localnode              remotenode
Synonym:              locnod                 remnod

Full name:            local:.uct.localnode   local:.remotenode
Unqualified name:     localnode              remotenode
Synonym:              locnod                 remnod

ncl> set event dispatcher outbound stream ost_1 -
_ncl> sink node ns:.lkg.remotenode

ncl> set session control proxy dth source end user = -
_ncl> { [ node=local:.remotenode , end user=uic=[0,0]dan ] }

You cannot substitute the node synonym for a full name in the NCL command. However, in most cases, because the unqualified name and the node synonym are usually identical, it may appear that the synonym substitution was successful.

You must use the %X format to specify hex strings in NCL foreign commands. You can issue commands using the ’’H format for hex strings only at the ncl> prompt.

Using an asterisk (*) as a wildcard character in an NCL command is helpful when the target of a command, particularly a show command, is not easily identifiable. The asterisk wildcard represents one or more characters. You can also use a question mark (?) as a wildcard. This represents a single character, and can only be used in certain data types, such as simplename.

To recall previously entered NCL commands, press the up-arrow key. After recalling an NCL command, modify it by using Ctrl/A to switch between insert and overstrike modes of editing. You can also use the Delete key to edit a command line. Re-enter the command by pressing the Return key. Press the down-arrow key to recall the next (most recent) command in the NCL command recall buffer.

After you enter a command, the system responds with a display that includes a summary of the command you entered, the UID of the entity (if enabled) referred to in the command, and a timestamp showing when the command was executed. With some commands (for example, show), the output also includes a display of certain values.

ncl> show nsp all

Node 0 NSP
AT 1992-06-03-10:35:12.234-04:00I0.277

Status

    UID                               = 9AF8477A-407E-11CB-800B-AA000400784D
    State                             = On
    Currently Active Connections      = 14

Characteristics

    Maximum Transport Connections     = 200
    Maximum Receive Buffers           = 2000
    Delay Weight                      = 3
    Delay Factor                      = 2
    Maximum Window                    = 8
    DNA Version                       = T4.2.1
    Acknowledgment Delay Time         = 3
    Maximum Remote NSAPS              = 201
    NSAP Selector                     = 32
    Keepalive Time                    = 60
    Retransmit Threshold              = 5
    Congestion Avoidance              = False

ncl>

A command that executes appropriately and completes its assigned task produces a success response. Success responses are not documented in the command description sections of this book unless the success response contains arguments or the response indicates that something other than the expected action has occurred.

Any entity that has counters or generates events is assigned a unique identification (UID) value. A UID is a 16-byte entity attribute that is unique throughout the network and for all time; that is, because the creation time of the entity is included as a portion of the UID, no two identical UIDs will ever be created.

A UID identifies a unique instance of an entity. For network management, UIDs provide a guaranteed way to track the characteristic sand status of that precise entity instance. Each entity having counter attributes also has a creation timestamp identifying when the entity was created.

The UID is included in any response or event from an entity that has a UID. Any entity that generates events or has counters must have a UID, which is also visible as a status attribute.

Both the UID and the creation timestamp are included in any event logging report that returns one or more counters in its argument list.

The UID value for an entity is not always needed and can clutter a show display or an event-logging report. By default, UID values are not displayed. Use the enable ncl uid display command if you wish to see this attribute. To turn UID displays back off, type disable ncl uid display.

The use of proxy accounts is a more manageable method of establishing access control schemes between two systems. The VSI DECnet-Plus for OpenVMS Network Management Guide contains more information about controlling remote network access through the use of proxy accounts.

ncl> set ncl default entity node .mfg.cadcam session control
ncl> show ncl default entity
ncl default entity = node .mfg.cadcam session control

ncl> ! on node .admin.finance
ncl> set ncl default access by user=j_smith, password=DoNotUse
ncl> show ncl default access

ncl Default access = user name=j_smith
       account=
       proxy=false

ncl> show node .admin.artists session control application -
_ncl> graphics_exchange all counters

The set ncl default access overrides an access control string specified with an entity.

ncl> set ncl default entity -
_ncl> node nodename"username password" [subentity | subentities]

ncl> set ncl default entity node nodename [subentity | subentities], -
_ncl> access by user=username, Password=password

ncl> set ncl default access by user=username, password=password

ncl> set ncl default entity [subentity | subentities], -
_ncl> access by user=username, password=password

ncl> show ncl default

No NCL Default Access has been set
NCL Default Entity ()

ncl> set ncl default access by user=user1, password=goodpassword
ncl> show ncl default

NCL Default Access by User user1, Password xxx
NCL Default Entity ()

ncl> set ncl default entity node remnod
ncl> show ncl default
NCL Default Access by User user1, Password xxx
NCL Default Entity Node remnod

ncl> set ncl default entity session control
ncl> show ncl default
NCL Default Access by User user1, Password xxx
NCL Default Entity Node remnod Session Control

ncl> set ncl default entity application fal
%NCL-E-INVALIDCOMMAND, unrecognized command
SET NCL DEFAULT ENTITY \Application\ fal
ncl> show ncl default
NCL Default Access by User user1, Password xxx
NCL Default Entity Node remnod Session Control

ncl> set ncl default entity session control application fal
ncl> show ncl default
NCL Default Access by User user1, Password xxx
NCL Default Entity Node remnod Session Control Application fal

ncl> set ncl default entity session control application *
ncl> show ncl default
NCL Default Access by User user1, Password xxx
NCL Default Entity Node remnod Session Control Application *

ncl> set ncl default access by user=user2, password=badpassword,
_ncl> entity session control
ncl> show ncl default
NCL Default Access by User user2, Password xxx
NCL Default Entity Node remnod Session Control Application *

ncl> set ncl default entity node remnod
%NCL-E-REQUESTFAILED, command failed due to:
-CML-E-SESSPROB, error returned from session control
-IPC-E-BADUSER, access control rejection
-NET-F-REMOTEDISCONN, connection disconnected by remote user
%NCL-E-NOCONNECTION, cannot establish CMIP connection to remote node
set ncl default entity node remnod

ncl> show ncl default
NCL Default Access by User user2, Password xxx
NCL Default Entity ()

$ @sys$examples:setup_ncl_keypad

This command file creates Keypad definitions files for NCL
to be used with the DECnet-Plus for OpenVMS products.  It creates
files in SYS$MANAGER: and SYS$HELP:.  All files begin with
NCL$KEYDEF.  A copy of this file will be made in SYS$UPDATE:

In a cluster environment, NCL scripts are created in SYS$SPECIFIC:
directories for each node on this system disk.

This file may be copied to any system running DECnet-Plus for
OpenVMS.

Note: Please add
"$ DEFINE/SYSTEM NCL$KEYDEF SYS$MANAGER:NCL$KEYDEF.INIT"
to your OpenVMS startup procedure.

Continue? [Y/N Def: Y]:
Creating NCL Key Definition Init File...
Creating NCL Key Definition Help Text Files...
Installing in a cluster environment.  Scripts created for each member...
%SYSMAN-I-ENV, current command environment:
        Clusterwide on local cluster
        Username SYSTEM       will be used on nonlocal nodes

%SYSMAN-I-OUTPUT, command execution on node NODEA
NSP Show Nodes Complete...
OSI Show Nodes Complete...
Show Routing Adjacencies Complete...
%SYSMAN-I-OUTPUT, command execution on node NODEB
NSP Show Nodes Complete...
OSI Show Nodes Complete...
Show Routing Adjacencies Complete...
%SYSMAN-I-OUTPUT, command execution on node NODEA
%SYSMAN-I-OUTPUT, command execution on node NODEB
$

Once in NCL, keypad PF4 displays an introduction and keypad PF2 provides help on the keypad layout.

Commands that manage a node entity specify the node using this format:

node node-id

Node being managed by the command.

If you want to operate on the local node, you can either omit the node identifier in your NCL command, or you can specify node 0, which identifies the local node.

enable

Turns on the node entity with or without the address watcher.

rename

Changes the node's name within the node and does not affect the name server directly. It uses the new name and an immediate keep me here transaction with the name servers which then update themselves based on the node's new name.

function function

new name full-name

Specifies the new name to be assigned to the node.

implementation

Particular DECnet implementation of the node. You cannot modify this characteristic.

listener template (Tru64 UNIX)

Name of the OSI Transport template to be passed through the CMIP listener to Session Control. You cannot modify this characteristic.

maximum listeners (Tru64 UNIX)

Maximum number of CMIP listeners that the node supports. Zero specifies an unlimited number of listeners. You cannot modify this characteristic.

version

Version number of the network management architecture specification to which the implementation conforms. You cannot modify this characteristic.

changes of address

Number of times the node's address has changed.

changes of id

Number of times the node's ID has changed.

creation time

Time at which the entity was created. This time reflects the time at which the node was first booted.

idrom check failures

Number of times an IDROM was checked for consistency and was found to be in error.

renames

Number of times the node has been renamed (see the rename command).

address

Set of protocol towers that together form a Session Control application address for the node's CMIP listener.

name

Full name of the node as it is registered in your namespace; name is the primary identifier.

functions enabled

Functions that are currently enabled for the node (see the enable command).

id

Indicates the unique 48-bit ID of the node.

state

uid

Node's unique identifier, which is generated when the node is created.

address changed

Generated each time the node address changes.

id changed

Generated each time the node's ID status attribute changes value.

idrom check failure

Generated each time an IDROM was checked and failed the test.

renamed

Generated each time the node's name changes.

For rename:

update of backtranslation soft links failed

Update of backtranslation soft links failed on the rename directive.

update of new name failed

New name update has failed on the rename directive.

unregistered name

The attempt to rename the node failed because the name and/or UID were not registered in DNS.

creation time

Specifies the time at which the entity was created.

For create:

already exists

An alias entity already exists.

wrong node type

An alias entity cannot be created on an alias node.

For delete:

module enabled

Disable the alias entity before trying to delete it.

shut

Places the specified alias port entity in the shut state. Note that other nodes participating in the alias will continue to accept connections for the alias after this command is executed.

node id

The LAN address to assign to the alias. Use the node id argument for the first cluster member to create the alias. Omit the argument for subsequent cluster members.

outgoing default

Specifies whether this alias should be used as the default alias for this node. If set to true, this alias name is used for connect requests on all outgoing connections from session control applications with their outgoing alias attribute set to true. Only one alias port can have this characteristic set to true.

selection weight

The number of sequential incoming connects to be passed to this member node in the round-robin sequence before proceeding to the next member node in the sequence. A value of zero means this node is not eligible to receive incoming connections to this alias address. Selection weight is used to apportion incoming alias connections according to the capacity of each alias member. Nodes with greater capacity should have larger values of selection weight, while local area OpenVMS cluster satellites should generally have a value of zero. Setting the selection weight to a very low non-zero number, such as 1, encourages needless connection delay because each incoming connection is treated in a round-robin fashion. That is, as each new connection comes in, it must be passed to the next cluster member. We recommend values between 5 and 10.

creation time

Specifies the time at which the entity was created.

name

This string is the port identifier and is also the DECdns-registered node object name of the Alias psuedo-node.

node-id

The 6-byte node-id field in the Alias pseudo-node's NSAP.

state

For create:

already exists

An alias port entity already exists.

too many alias port entities

The maximum number of alias port entities has been exceeded.

For delete:

cannot delete the entity while it is enabled

Disable the alias port entity before trying to delete it.

version

Default: Current version number

Version number of the CSMA-CD data link architecture specification to which the implementation conforms. You cannot modify this characteristic.

For create:

already exists

A csma-cd entity already exists.

For delete:

has children (Tru64 UNIX)

Cannot delete while subentities exist.

cannot delete while subentities exist (OpenVMS)

Cannot delete while subentities exist.

Unless stated otherwise, counts include both normal and multicast traffic and all protocol types, service access points (SAPs), and protocol identifiers.

creation time

Time at which the port was created.

multicast octets received

Number of multicast data octets that were received successfully and made available to the port user. The count is the number of octets in the CSMA-CD user data field and does not include MAC (media access control, a sublayer of the CSMA-CD Data Link layer) headers. Comparing this count to the octets received count yields the gross percentage of bandwidth that was consumed (over time) by multicast PDUs received by the port.

multicast octets sent

Number of multicast data octets that were sent successfully through the port. The count is the number of octets in the MAC user data field, including any padding or length fields; it does not include MAC headers. Comparing this count to the octets sent count yields the gross percentage of bandwidth that was consumed (over time) by multicast PDUs transmitted by the port.

multicast pdus received

Number of multicast PDUs that were received successfully and made available to the port user. Counted PDUs passed address and protocol filtering and were received without errors. Comparing this count to the pdus received count yields a gross percentage of CSMA-CD usage for multicast pdus received by this port.

multicast pdus sent

Number of multicast PDUs that were sent successfully through the port. Comparing this count to the pdus sent count yields a gross percentage of CSMA-CD usage for multicast pdus sent by this port.

octets received

Total number of MAC user data octets that were received successfully and made available to the port user. Counted frames passed address and protocol filtering for both individual and multicast MAC addresses and were received without errors. The count is the number of octets in the CSMA-CD user data field plus any padding, Ethernet length fields, or logical link control (LLC) header fields; it does not include MAC headers. Adding the octets received count to the protocol overhead calculated from the pdus received count yields the amount of CSMA-CD bandwidth consumed by frames received by the port.

octets sent

Total number of user data octets that were sent successfully through the port. The count is the number of octets in the MAC user data field including any padding or length fields; it does not include MAC headers. Adding the octets sent count to the protocol overhead calculated from the pdus sent count yields the amount of CSMA-CD bandwidth consumed (over time) by frames sent by the port.

pdus received

Total number of PDUs that were received successfully and made available to the port user. Counted PDUs passed address and protocol filtering and were received without errors. The count provides a gross measurement of incoming CSMA-CD usage by the port.

pdus sent

Total number of PDUs that were sent successfully through the port. The count provides a gross measurement of outgoing CSMA-CD usage by the port.

unavailable user buffers

Number of times that no user buffer was available at the port for an incoming frame that passed all filtering for the port. Used in conjunction with the pdus received count, this counter can indicate the rate of user buffer receive problems.

name

Simple name assigned to the port when it is created.

client

Name specified by the data link user when the port was opened.

ethernet protocol types

Set of Ethernet protocol types that are currently recognized for this port.

length present

llc sap addresses

Set of individual and group logical link control (LLC) service access point (SAP) addresses that are currently recognized for this port.

llc service

mac addresses

Set of individual and multicast MAC (medium access control) addresses that are currently recognized for this port.

receive mode

snap protocol identifiers

Set of subnetwork access protocol (SNAP) identifiers that are currently recognized for this port.

station

Name of the station associated with this port as specified by the user when the port was opened.

uid

Entity's unique identifier, which is generated when the port is created.

communication port

The system device name assigned to this station.

On OpenVMS systems, the name must be in the format ddc, where dd is the OpenVMS device name prefix and c is the controller letter. For a complete list of CSMA-CD devices and their OpenVMS device names, see the DECnet-Plus for OpenVMS Release Notes.

On Tru64 UNIX systems, the name must be in the format ddn, where dd is the Tru64 UNIX device name prefix and n is the device number.

This argument determines the value of the communication port characteristic and is required.

mac address

Individual medium access control (MAC) address for the station. If you do not specify a MAC address, the network uses the address specified in the first EnableMacAddress user interface call directed to this station.

Number of receive buffers reserved for the station. You cannot modify this characteristic.

Unless stated otherwise, counts include both normal and multicast traffic and all protocol types, service access points (SAPs), and protocol identifiers.

alignment errors

Number of times a received frame did not contain an integral number of octets.

carrier check failures

Number of times the data link did not sense the receive carrier signal or detected an error in the receive carrier signal during transmission of a frame.

collision detect check failures

Number of times the collision detect test signal was not sensed after a transmission. If this count approximates the number of frames sent, either the collision detect circuitry is not working correctly or the test signal is not implemented.

creation time

Time at which the station was created.

data overruns

Number of times the hardware lost one or more consecutive, partially complete, incoming frames because it could not keep up with the incoming frame rate. Used in conjunction with pdus received, this count provides a measure of hardware resource and bandwidth failures.

excessive collisions

Number of times a transmission failed because the maximum allowable number of retransmission attempts all culminated in collisions.

frame check errors

Number of times a received frame containing an integral number of octets failed the frame check sequence (FCS).

frame size errors

Number of times the user requested transmission of a frame outside the range of valid frame sizes.

frames too long

Number of times a received frame exceeded the maximum length allowed by CSMA-CD medium access control.

initially deferred pdus sent

Number of times a PDU was deferred by the station access algorithm on the first attempt at transmission, but was then transmitted successfully without collision. Used in conjunction with pdus sent, this count measures the rate of CSMA-CD contention with no collisions.

late collisions

Number of times a collision was detected after the allotted time for collisions had expired.

multicast octets received

Number of multicast data octets that were received successfully. The count is the number of octets in the CSMA-CD user data field and does not include MAC headers. Comparing this count to the octets received count yields the gross percentage of bandwidth that was consumed (over time) by multicast frames received by the local system.

multicast octets sent

Number of multicast data octets that were sent successfully. The count is the number of octets in the MAC user data field, including any padding or length fields; it does not include MAC headers. Comparing this count to the octets sent count yields the gross percentage of bandwidth that was consumed (over time) by multicast frames transmitted by the local system.

multicast pdus received

Number of multicast PDUs that were received successfully. Comparing this count to the pdus received count yields a gross percentage of CSMA-CD usage for multicast PDUs received by this system.

multicast pdus sent

Number of multicast PDUs that were sent successfully. Comparing this count to the pdus sent count yields a gross percentage of CSMA-CD usage for multicast PDUs sent by this system.

multiple collisions pdus sent

Number of times a PDU was transmitted successfully on the third or later attempt by the station access algorithm after normal collisions on previous attempts. Used in conjunction with pdus sent, this count provides a measure of CSMA-CD media contention at a level where there are collisions and the backoff algorithm no longer works efficiently.

octets received

Total number of MAC user data octets that were received successfully from frames that passed address and protocol filtering for both individual and multicast MAC addresses. The count is the number of octets in the CSMA-CD user data field plus any padding, Ethernet length fields, or LLC header fields; it does not include MAC headers. Adding the octets received count to the protocol overhead calculated from the pdus received count yields the amount of CSMA-CD bandwidth consumed by frames received by the local system.

octets sent

Total number of user data octets that were sent successfully. The count is the number of octets in the MAC user data field including any padding or length fields; it does not include MAC headers. Adding the octets sent count to the protocol overhead calculated from the pdus sent count yields the amount of CSMA-CD bandwidth consumed (over time) by frames sent by the local system.

pdus received

Total number of PDUs that passed address and protocol filtering and were received without errors. The count provides a gross measurement of incoming CSMA-CD usage by the local system; this information can be used with other counters to approximate the average receive frame size or to determine the ratio of errors to successful receives.

pdus sent

Total number of PDUs successfully sent. The count provides a gross measurement of outgoing CSMA-CD usage by the local system; this information can be used with other counters to approximate the average transmit frame size or to determine the ratio of errors to successful transmissions.

receive data length errors

Number of times a frame was received with a length field value that was invalid for the number of octets actually received by medium access control.

send data length errors

Number of times the user requested transmission of an 802.3 frame with a length field value that was not valid for the number of octets actually passed.

single collision pdus sent

Number of times a PDU was successfully transmitted on the second attempt by the station access algorithm after a normal collision occurred on the first attempt. Used in conjunction with pdus sent, this count provides a measure of CSMA-CD media contention at a level where there are collisions, but the backoff algorithm still works efficiently.

station failures

Number of times the station self-testing procedures reported failure.

unavailable station buffers

Number of times a complete, fully received PDU was discarded because no station buffer was available. Used with pdus received, this count provides a measure of receive problems related to the station buffer.

unavailable user buffers

Number of times no user buffer was available for an incoming frame that passed all filtering for the port. Used with the pdus received count, this counter can indicate the rate of user buffer receive problems.

unrecognized individual destination pdus

Number of times a received PDU with an individual destination MAC address was discarded because there was no port with the correct Ethernet protocol type, SNAP protocol identifier, or link logical control SAP address enabled.

unrecognized multicast destination pdus

Number of times a received PDU with a multicast destination MAC address was discarded because there was no port with the correct Ethernet protocol type, SNAP protocol identifier, or link logical control SAP address enabled.

name

Simple name assigned to the station when it is created.

address filters

All individual MAC addresses currently enabled by any of the ports on the station.

communication port

DECnet-Plus device name for the station.

hardware address

Individual medium access control (MAC) address that was assigned during manufacture of the communications hardware that is associated with the station.

mac address

Current MAC address (if any) of the station. For more information about the MAC address, refer to the enable command.

receive mode

state

For more information on station states, refer to the appropriate network management guide.

uid

Entity's unique identifier, which is generated when the station is created.

alignment error

This event is generated whenever an incoming frame does not contain an integral number of octets. This error can be caused by several conditions, such as electromagnetic interference, late collisions, or improperly set hardware parameters (for example, receiver squelch).

carrier check failure

This event is generated on a transmission that failed, either because the data link did not sense the receive carrier signal that must accompany transmission of a frame, or because the data link did not detect an error. This error indicates a failure in either the transmitting or receiving hardware, such as the transceiver or transceiver cable.

data overrun

This event is generated whenever an incoming frame is lost because of a hardware resource failure such as insufficient hardware buffers or insufficient CPU time.

excessive collision

This event is generated whenever a transmission fails because the medium access algorithm reached the maximum number of allowable retransmission attempts resulting from collisions. This error can occur when too many systems are trying to transmit at the same time or when there are cable problems.

frame check error

This event is generated whenever an incoming frame fails the frame check sequence (FCS) test. This error can be caused by several conditions, such as electromagnetic interference, late collisions, or improperly set hardware parameters (for example, receiver squelch).

frame too long

This event is generated whenever a remote system sends a frame that exceeds the CSMA-CD MAC maximum length.

late collision

This event is generated whenever a transmission fails because a collision was detected after the allowed window for collisions had elapsed. This error indicates either a problem with another system's carrier sense or a weak local transmitter.

receive data length error

This event is generated whenever a remote system sends an 802.3 frame having a length field value that is not valid for the number of octets actually received by the MAC.

unavailable station buffer

This event is generated whenever an incoming frame is discarded because there is no station buffer available to receive it. This error indicates a lack of local station buffers; that is, a lack of buffers between the cable and the user buffers.

unavailable user buffer

This event is generated whenever an incoming frame is discarded because there is no user buffer queued to the appropriate port to receive it. This error indicates a lack of buffers in the user process; that is, the buffers supplied by the user for the Receive function.

unrecognized individual destination pdu

This event is generated whenever an incoming frame that matches an enabled individual MAC address is discarded because the frame does not satisfy the filter criteria of any port. This error indicates that a remote system is using a protocol that is locally unsupported or that the local system has not enabled a protocol type, protocol identifier, or LLC SAP address that it should have.

unrecognized multicast destination pdu

This event is generated whenever an incoming frame that matches an enabled multicast MAC address is discarded because the frame does not satisfy the filter criteria of any port. This error indicates that the local system has not enabled an Ethernet protocol type, SNAP identifier, or LLC SAP address that it should have, or that a remote system is sending traffic that is invalid for the combination of multicast and the currently specified protocol type, SNAP identifier, or LLC SAP.

For create:

already exists

A csma-cd station entity already exists.

communication port in use

Failure to create the csma-cd station entity because the communications port is already reserved by another entity.

invalid communications port

Failure to create the csma-cd station entity because you cannot run CSMA-CD data link on this communications port.

For delete:

station in use (UNIX)

Attempt to delete the csma-cd station entity failed because there is at least one active port still associated with this station. You must wait until the ports go away to delete this station.

wrong state

Failure to delete the csma-cd station because the station must be disabled before deletion.

dna version

Version number of the DCMP architecture specification to which the implementation conforms. You cannot modify this characteristic.

For create:

already exists

A DCMP entity already exists.

protocol protocol-type

Specifies the delay, in milliseconds, between polls of one of the set of dead tributaries. This attribute is supported only if the characteristic protocol is set to control.

Specifies the minimum delay, in milliseconds, between polls. You can use this timer to limit the effect of a fast control station on slower tributaries. A value of 0 means that no delay is added. This attribute is supported only if the characteristic protocol is set to control.

Name of the Physical layer entity over which the link operates. A value for this characteristic must be set before the link entity is enabled. You can modify this characteristic only when the entity is disabled.

Protocol mode used by the local station. You cannot modify this characteristic.

The value of this characteristic is a copy of the protocol argument specified when the dcmp link entity is created. The default value is point and is the only permissible value.

Number of receive buffers reserved for the link. You can modify this characteristic only when the entity is disabled. Also, you can only increase the characteristic value.

Maximum time, in milliseconds, to wait between sending a message and receiving a valid response. If this time expires, the local station takes error recovery action. On full-duplex point-to-point links, the timer is started immediately when a message is sent.

Time, in milliseconds, between the recalculation of tributary polling priorities. This attribute is supported only if the characteristic protocol is set to control.

Time, in milliseconds, for which a tributary or the remote station (on a half-duplex, point-to-point link) can hold the line. This characteristic is not supported if the characteristic protocol is set to tributary.

creation time

Time at which this entity was created.

naks received indicating message header format error

Number of NAK messages received that report errors in message headers sent from the local station.

naks received indicating receive overrun

Number of NAK messages received that report a receive overrun at the remote station.

pdus received with message header format error

Number of times the local station detected an error in a message header.

receive overruns

Number of times the local station detected a receive overrun.

selection address errors

Number of times the controller of a multipoint link received a message with an address other than that of the currently selected station. This counter is supported only if the characteristic protocol is set to control.

streaming tributaries

Number of times the remote station (or a tributary station) exceeded the maximum transmission interval without releasing the line, or failed to release the line after sending a message with the select flag set. This counter is present only on half-duplex, point-to-point links, or when the local station is a controller of a multipoint link. This counter is not supported if the protocol characteristic is set to tributary.

transmit underruns

Number of times the local station detected a transmit underrun.

name

Simple name assigned to the link when it is created.

physical port

Name of the port entity in the Physical layer returned when the port is opened. If this is null, the port is not open.

state

In addition, the link is disabled and its state is set to off if the Physical layer port that the link uses is deleted.

uid

Entity's unique identifier, which is generated when the entity is created.

pdu received with header format error

selection address error

Generated each time the controller of a multipoint link receives a message that contains an address other than that of the currently selected tributary. This event is supported only on half-duplex, point-to-point links, or if the protocol characteristic is set to tributary.

streaming tributary

For create:

already exists

A dcmp link entity already exists.

For delete:

cannot delete while subentities exist

Cannot delete while subentities exist.

wrong state

Failure to delete the dcmp link entity because the link must be disabled before deletion.

For enable:

device constraint

The value of an attribute is not supported by the type of device used on the communications line. Modify the attribute to a suitable value, and retry the operation.

open physical port failed

The opening of the port in the Physical layer failed. The exception includes an argument that gives more information about the failure.

Base priority to which an active tributary is reset after it has been polled.

This characteristic is supported only if the characteristic protocol of the owning dcmp link entity is set to control.

Value to be added to the active tributary priority each time the scheduling timer expires.

This characteristic is supported only if the characteristic protocol of the owning dcmp link entity is set to control.

Data link address of the remote station or tributary. You can modify this characteristic only when the entity is disabled.

Time, in milliseconds, for which a selected tributary or remote station is allowed to transmit. This characteristic is not used on full-duplex links.

This characteristic is not supported if the characteristic protocol of the owning dcmp link entity is set to tributary.

This characteristic is supported only if the characteristic protocol of the owning dcmp link entity is set to control. You can modify this characteristic only when the entity is disabled.

Number of times an active, inactive, or dying tributary is polled before its status attribute polling substate is changed to dead because of receive timeouts.

This characteristic is supported only if the characteristic protocol of the owning dcmp link entity is set to control.

Base priority to which a dying tributary is reset after being polled.

This characteristic is supported only if the characteristic protocol of the owning dcmp link entity is set to control.

Value to be added to a dying tributary's priority each time the scheduling timer expires.

This characteristic is supported only if the characteristic protocol of the owning dcmp link entity is set to control.

Number of times an active or inactive tributary is polled before its status attribute polling substate is changed to dying because of receive timeouts.

This characteristic is supported only if the characteristic protocol of the owning dcmp link entity is set to control.

Maximum time, in milliseconds, that the local station can delay acknowledging a received message if there is no data to send.

The value of this characteristic is linked to the retransmit timer used on the remote station. A suggested value is between 10% and 20% of that timer. However, the actual values you can use may be limited by the communications product.

The default value indicates that no holdback is used and the local station must acknowledge immediately.

Specifies the priority to which an inactive tributary is reset after it has been polled.

This characteristic is supported only if the characteristic protocol of the owning dcmp link entity is set to control.

Value to be added to an inactive tributary's priority each time the scheduling timer expires.

This characteristic is supported only if the characteristic protocol of the owning dcmp link entity is set to control.

Number of times an active tributary is polled before its status attribute polling substate is changed to inactive because of no data response.

This characteristic is supported only if the characteristic protocol of the owning dcmp link entity is set to control.

Maximum number of buffers that a tributary can use from the common buffer pool. A value of 0 means that there is no limit to the number of buffers that can be used. This characteristic is supported only if the buffer source characteristic is set to common pool.

This characteristic is supported only if the characteristic protocol of the owning dcmp link entity is set to control. You can modify this characteristic only when the entity is disabled. Also, you can only increase the characteristic value.

Maximum number of messages that a tributary or a remote half-duplex station can send at one time. The value of this characteristic must be greater than or equal to that of transmit window on the selected station.

You cannot modify this characteristic.

This characteristic is supported only if the characteristic protocol of the owning dcmp link entity is set to control.

Time, in milliseconds, that the local station waits between data transmissions.

This characteristic is supported only if the characteristic protocol of the owning dcmp link entity is set to control.

Maximum number of data messages that the local station can send without receiving an acknowledgment. This characteristic applies only when the remote station is a control station or on a half-duplex, point-to-point link. The value of this characteristic must be less than or equal to the equivalent of the maximum transmit characteristic on the control station or remote station.

buffers temporarily unavailable

Number of times the local station could not service messages from the remote station because there were no receive buffers available.

buffers too small

Number of times the local station could not service messages from the remote station because the receive buffers were not large enough.

creation time

Time at which this entity was created.

incomplete replies to select

Number of selection intervals that were not properly terminated (that is, by a message with the Select bit set in the header), during which a transmission was received or an attempt at transmission was detected.

This counter is supported only if the protocol characteristic of the owning dcmp link entity is set to control, or when the link is a half-duplex, point-to-point link.

local reply timeouts

Number of times the local station failed to receive an acknowledgment before the reply timer expired.

locally initiated state changes

Number of times the station protocol state changed through action of the local station.

naks received indicating buffer too small

Number of times the remote station reported that it could not service a message because the receive buffer was not large enough.

naks received indicating buffers temporarily unavailable

Number of times the remote station reported that it could not service a message because no receive buffer was available.

naks received indicating data field block check error

Number of times the remote station reported that a block check error was detected in the data field of an incoming message.

naks received indicating header block check error

Number of times the remote station reported that a block check error was detected in the header block of an incoming message.

naks received indicating rep response

Number of times the remote station reported that it did not receive all the messages sent from the local station.

naks sent with rep response

Number of times the local station detected that not all of the messages sent from the remote station were received correctly.

no replies to select

This counter is supported only if the protocol characteristic of the owning dcmp link entity is set to control, or when the link is a half-duplex, point-to-point link.

pdus received with data field check block error

Number of messages received with a check error in the data field.

pdus received with header block check error

Number of messages received with a check error in the header block.

receive error thresholds reached

Number of times the receive error threshold has been reached.

remote reply timeouts

Number of times the local station received a REP message and sent an acknowledgment in return. This sequence indicates that all messages sent from the remote station have been correctly received.

remotely initiated state changes

Number of changes in the station protocol state caused by action of the remote station.

sdu octets received

Number of data octets received from the remote station.

sdu octets sent

Number of data octets sent to the remote station.

sdus received

Number of data messages received from the remote station (not including retransmissions).

sdus sent

Number of data messages sent to the remote station (not including retransmissions).

selection error thresholds reached

Number of times the selection error threshold has been reached.

This counter is not supported if the characteristic protocol of the owning dcmp link entity is set to tributary.

selection intervals

Number of times the local station selected the remote or a tributary station. The counter does not appear if the link uses the tributary protocol. In addition, the counter appears only when the local station is the control station for a number of tributaries, or is operating over a half-duplex, point-to-point link.

This counter is supported only if the protocol characteristic of the owning dcmp link entity is set to control, or when the link is a half-duplex, point-to-point link.

send error thresholds reached

Number of times the send error threshold has been reached.

strts received while in maintenance

Number of times the local station received a STRT protocol message while in the Maintenance state.

name

Simple name assigned to the link logical station when it is created.

polling substate

protocol state

state

uid

Entity's unique identifier, which is generated when the entity is created.

buffer too small

Generated each time a message is received whose data field is larger than the buffers available on the local station.

locally initiated state change

Generated each time the state of the local station changes as a result of action on the local node.

receive error threshold reached

Generated each time the number of consecutive receive-related errors reaches the receive error threshold limit of 7.

remotely initiated state change

Generated each time the state of the link changes as a result of action on the remote node.

selection error threshold reached

Generated each time the number of consecutive selection-related errors reaches the selection error threshold limit of 7. This event is supported only when the protocol characteristic of the owning dcmp link entity is set to control, or when the link is half-duplex, point-to-point.

send error threshold reached

Generated each time the number of consecutive transmit-related errors reaches the transmit error threshold limit of 7.

strt received while in maintenance

Generated each time a strt message is received while the value of the status attribute protocol state of the local station is set to maintenance.

For create:

already exists

A dcmp link logical station entity already exists.

maximum stations exceeded

The station cannot be created because there are already the maximum stations defined for this link. This can occur when there is already one logical station defined for that link.

For delete:

wrong state

Failure to delete the DCMP link logical station because the logical station must be disabled before deletion.

name

Simple name assigned to the port when it is created.

client

Name of the client entity.

link

Name of the DCMP link that the client is using.

logical station

Name of the DCMP link logical station supplied by the client when the port was opened.

state

type

version

Version of the device architecture to which the implementation conforms. You cannot modify this characteristic.

uid

Entity's unique identifier, which is generated when the entity is created.

For create:

already exists

A device entity already exists.

For delete:

has children

Cannot delete while subentities exist.

dump

Dumps the device corresponding to the unit subentity.

load

Loads the device corresponding to the unit subentity.

name device-name

The physical device this device unit entity controls.

Specifies whether the device should try to load its microcode without management intervention. Autoloading would occur after initialization, a failure, or a dump.

device

Physical device to which this device unit entity is related. The value of this characteristic is a copy of the name argument specified when this entity is created.

dump destination

File specification to hold the contents of the device's microcode when a dump occurs.

Whether a device should try to dump its microcode after a device failure. Set this characteristic only for those devices that support the dump operation.

File specification that contains the device's microcode. This is used during a load operation.

creation time

Time at which this entity was created.

device failures

Number of times the unit has failed.

failed dumps

Number of times an attempt to dump the device's microcode has failed.

failed loads

Number of times an attempt to load the device's microcode has failed.

forced dumps

Number of times the dump command has been used to force the device to dump its microcode.

forced loads

Number of times the load command has been used to load the device's microcode.

successful dumps

Number of times the device has successfully dump edits microcode.

successful loads

Number of times the device has successfully loaded its microcode.

name

Simple name assigned to the device unit when it is created.

firmware identifier

Implementation-specific string that identifies the firmware loaded into a device.

operational communication port (OpenVMS)

Specifies which channels of a multiple-line device unit are determined to be working by the module self-test. Each name identifies a working device communication port. Channels that are not named are not operational.

state

uid

Entity's unique identifier, which is generated when the entity is created.

device failure

Generated each time a failure is detected on a device.

failed dump

Generated each time there is a failure to dump the device's microcode.

failed load

Generated each time there is a failure to load the device's microcode.

successful load

Generated each time the device's microcode is loaded successfully.

For dump:

dump failure

The dump operation failed.

illegal dump destination

The value of the dump destination characteristic is not a valid file specification. Check the value of the character, correct as necessary, and reissue the dump command.

For load:

illegal load source

The value of the load source characteristic is not a valid file specification. Check the value of the characteristic, correct as necessary, and reissue the load command.

load failure

The load operation failed.

test

The test command is used by the manager to request that an event be logged to test the entire event logging subsystem. This directive tests the complete event logging system from entity to manager and causes the test requested event to be logged.

NA version

Default: Current version number

Version number of the NA event-logging architecture specification to which the implementation conforms. You cannot modify this characteristic.

creation time

Time at which this entity was created.

events lost

Number of events lost at the event dispatcher queue.

test requested (UNIX)

Number of events being generated with the test directive.

state

uid

Entity's unique identifier, which is generated when the entity is created.

events lost

Generated whenever the event dispatcher cannot allocate resources to queue more events for processing. The event-logging function guarantees that this event cannot be lost. Also, you cannot block this event unless all events for all modules are blocked.

This event is placed at the end of the queue. If another event cannot be queued because of resource limitations while this event is still the last event in the queue, the number argument is updated to reflect the latest total of lost events.

test requested

Logged when the test directive is issued.

For enable:

children in wrong state

Another Event Dispatcher module entity is still enabled. Retry the command after you have disabled all of these entities:

block

Sets the filters to block the specified events for the entity instance or class. It causes the named events to be blocked.

connect

Causes the outbound stream entity to request a connection to its sink partner. This directive causes the entity to issue a single session connect request to its sink partner, unless the state is already On Connected, in which case the directive has no effect and returns the success response.

disconnect

Disconnects the outbound stream connection to its sink partner. The disconnect directive aborts the entity's outbound stream connection to the sink.

ignore

Sets the filters to ignore the specified events for the entity instance or class. The ignore directive causes the named events to be ignored.

pass

Sets the filter to pass the specified events for the entity instance or class. The pass directive causes the named events to be passed.

reset

Resets the catch all, specific and global filters to the default value. It causes these filters to be reset to the values they had when the entity was created. It is equivalent to setting the values for these filters to their defaults.

shutdown

Requests an orderly shutdown of the connection to the sink partner. The shutdown directive attempts an orderly shutdown of the connection in cooperation with the sink.

testevent

Tests the filter action state for the specified event. This directive applies the filtering algorithm to the named event instance returning the applicable Filter Action, and an indication of whether the search was resolved by the Specific Filter, Global Filter, or Catch All Filter attribute.

global filter, class-name, event-name

Specifies a global event filter. The class-name variable specifies a class name, excluding all instance names (for example, node, mop, circuit), The event-name variable identifies the event to be blocked, ignored, or passed. To block, ignore, or pass all events for the class, specify all instead of an individual event.

maximum buffer size integer

Optional argument that specifies the maximum number of octets to be used for event processing of this stream. The current value is displayed in the buffer size status attribute. You can specify a size smaller than the implementation's default, provided it is still sufficient to hold the events lost event. We recommend that you use the default buffer size.

method method