DECnet-Plus
Network Control Language Reference

Arguments:

current time	Specifies the current system time.
update time	Specifies the new, updated system time.

This chapter describes all the commands you can use to manage the entities that constitute the Event Dispatcher module. The event dispatcher is an integral component of the Digital Network Architecture (DNA) that processes events generated by entities in the network. Each component layer architecture of the Phase V DNA architecture, such as Routing, NSP, and ISO Transport, may define certain occurrences, actions, transitions, or conditions as events that are reported and may be logged to assist network or system management. The Event Dispatcher module allows these conditions to be logged and monitored to allow a system manager to view the state of the network. Individual messages are listed and described throughout this manual with the entities that produce them.

Figure 9-1 shows the hierarchical relationship of the entities that constitute the Event Dispatcher module.

Figure 9-1 Hierarchy of Event Dispatcher Module Entities

The event dispatcher entity is the top-level entity in the hierarchy of entities belonging to the Event Dispatcher module. Each DNA node must implement an event dispatcher.
create [node node-id] event dispatcher
disable [node node-id] event dispatcher
enable [node node-id] event dispatcher
show [node node-id] event dispatcher [all [attributes] | all characteristics | all counters | all status ]
test [node node-id] event dispatcher

9.1.1 Commands

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.

DNA version

Default: Current version number

Version number of the DNA 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 (Digital UNIX)

Number of events being generated with the test directive.

state

Status of the event dispatcher entity.

off	The event dispatcher entity is disabled.
on	The event dispatcher entity is enabled.

uid

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

9.1.5 Event Messages

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.

Argument:

number

Number of consecutive events lost.

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:

• event dispatcher outbound stream
• event dispatcher relay
• event dispatcher relay logging
• event dispatcher sink
• event dispatcher sink inbound stream

9.2 event dispatcher outbound stream

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 OnConnected, 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 catchall, 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 FilterAction, and an indication of whether the search was resolved by the SpecificFilter, GlobalFilter, or CatchAllFilter attribute.

class-name

Specifies the class name. The user may or may not include the node name.

event-name

Specifies all (for all events) or a specific event to be filtered for the specified class or instance.

global filter

A class name, excluding all instance names (for example, node, mop, circuit), and 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.

instance-name

A full entity name, including the node name and including a specific instance.

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. Digital recommends that you use the default buffer size.

method method

Specifies whether an existing connection should be aborted immediately or shut down in an orderly fashion.

abort	The stream calls the disconnect operation to abort the connection immediately. (This process is described under the disconnect command.)
orderly	The stream calls the shutdown operation to perform an orderly shutdown of the connection. (This process is described under the shutdown command.) The default method is orderly.

specific filter

Specifies an entity, including instance names and names of 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.

catch all filter

Default: Pass

Value: Block or pass

Action to take if neither the specific filter nor the global filter contains an entry that matches an event.

block	Discard the event.
pass	Report the event.

connect retry timer

Default: 120

Value: 0--65535

Number of seconds to wait after a disconnect or connection reject before reattempting a connection. Connection attempts continue until a connection is made or until the connect timer enabled attribute is set to false or the outbound stream is disabled. If the outbound stream is already connected to the sink when the timer expires, no connection is attempted at that time. The timer resets and connection attempts continue whenever the timer expires.

connect timer enabled

Default: True

Value: True or false

Specifies whether the connect timer is operational (see connect retry timer).

disconnect timer

Default: 0; see description

Value: 0--4294967295

Number of seconds to wait before disconnecting an idle connection. Zero indicates that there is no disconnect timer and connections are never automatically disconnected.

global filter

Current global filter as it has been constructed by block, ignore, and pass commands for this stream. By default, the global filter is set to block all events for the following entities: event dispatcher, event dispatcher sink, and event dispatcher sink inbound stream and to pass all events for the event dispatcher outbound stream entity.

sink address

Default: No address

Value: Sink address tower set

Sink address tower for this stream. Modifying this characteristic affects only subsequent connect requests; existing connections are unaffected.

sink end-user

Default: Number = 82

Value: End-user-specification

Sink Session Control end-user specification for this stream.

sink node

Default: Local node

Value: Full-name

Full DNS node name of the sink for this stream. Modifying this characteristic affects only subsequent connect requests; existing connections are unaffected. This full name is used in combination with the sink end-user characteristic to establish the sink connection.

sink object

Default: No sink object

Value: Full-name

Full DNS object name of the sink for this stream. Modifying this characteristic affects only subsequent connect requests; existing connections are unaffected. This full name should match the object name characteristic of the target sink.

specific filter

Default: No specific filter

Current specific filter for this stream.

template (Digital UNIX)

Default: No template

Value: Simple-name

Transport template (see osi transport template) for this stream's connections.

confidence changes

Number of times the confidence variable has changed while connections were in the open state.

connect requests

Number of times a connection to a remote node was requested by this stream, either by an explicit command or by the connection timer.

connections accepted

Number of times an outbound connection request was accepted by the sink partner.

creation time

Time at which this entity was created.

disabled

Number of disable events for this stream.

enabled

Number of enable events for this stream.

events lost

Number of events lost because of outbound stream buffer overrun.

filter changes

Number of times the filter has changed.

shutdowns

Number of times a shutdown command or operation was issued.

name

Simple name assigned to the outbound stream when it was created.

buffer size

Maximum number of octets allowed for event processing of this stream. This value is defined in the create command for the stream.

state

Status of the outbound stream.

off	The stream is disabled.
on	The stream is enabled.
onconnected	The stream is enabled and has an established connection.
onconnecting	The stream is enabled and is in the process of establishing a connection.
ondisconnecting	The stream is enabled, but is in the process of disconnecting from a connection.
onshutdownrequested	The stream is enabled and has an established connection, but is in the process of shutting down; the stream will disconnect after it transmits all events that were outstanding when the shutdown command was issued.

uid

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

change confidence

Generated each time the transport service detects a change in the connection's confidence value. (The confidence value indicates whether the Transport layer expects a transmit operation to succeed.) This event suggests a change in the connectivity between the outbound stream and the sink.

Argument:

confidence	New transport confidence value.
	false	It is unlikely that a transmit operation would succeed under the current circumstances.
	true	It is likely that a transmit operation would succeed under the current circumstances.

change filter

Generated each time the filter for a stream is changed, whether it is changed by a block, ignore, or pass command or by using set to change the value of the catch all filter characteristic. The initial values of the filters for a stream are reported as arguments in the enable stream event. A filter change event is filtered according to its new values.

Arguments: (for OpenVMS)

new catch all filter	Current catch-all filter setting.
new global filter	Current global filter setting.
new specific filter	Current specific filter setting.
old catch all filter	Previous catch-all filter setting.
old global filter	Previous global filter setting.
old specific filter	Previous specific filter setting.

disable

Generated each time an outbound stream is disabled by a disable command.

disconnect

Generated each time a connection is closed on an outbound stream. The disconnect can be caused by the event dispatcher closing idle connections, a management command, a network failure, a sink crash, or a sink disconnect.

Arguments:

disconnect data	Identifies the cause of the disconnect.
	0	remote disconnect
	2	shutdown requested (OpenVMS)
	3	management directive
reason	Session Control layer reason for the disconnect.

enable

Generated each time an outbound stream is enabled by an enable command.

Arguments:

catch all filter	Value of the catch-all filter when the stream is enabled.
global filter (optional)	Value of the global filter when the stream is enabled.
specific filter (optional)	Value of the specific filter when the stream is enabled.

events lost

Generated whenever the outbound stream cannot allocate resources for event transmission. 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.

Argument:

number

Number of consecutive events lost.

shutdown

Generated each time a shutdown operation results in an orderly disconnect. You cannot block shutdown events for an outbound stream.

Arguments:

reason	canceled	The shutdown was "neutralized" by an intervening disconnect; therefore, the receiver should not shut down.
	disconnect timer	The shutdown was caused by the disconnect timer.
	disable directive	The shutdown was caused by a disable command that specified an orderly shutdown.
	shutdown directive	The shutdown was caused by a shutdown command.

For connect:

connection failed

The connection attempt failed. The exception may include additional arguments that give more information about the failure.

Arguments:

reason	The connection failed at the Session Control layer.
data	This field can include optional data that describes the reason the connection attempt failed.

no sink specified

All of the sink specifier attributes are null.

wrong state

The operation failed because the entity was not in off, onconnecting, or ondisconnecting state.

For block and ignore:

illegal block

The attempted block operation is illegal; for example, the command attempted to block the event dispatcher outbound stream events lost or shutdown events.

illegal element

The command did not include a class-name or instance-name argument, or an argument contained one of the following illegal elements: wildcard, node name, node class, illegal class.

For delete:

wrong state

The operation failed because the entity was not in an off state.

For disable:

incomplete

Orderly disable could not be completed due to lack of transport confidence.

9.3 event dispatcher relay

state

Status of the event dispatcher relay entity.

off	The event dispatcher relay entity is disabled.
on	The event dispatcher relay entity is enabled.

For delete:

entity has children

Cannot delete while subentities exist.

wrong state

Failure to delete the event dispatcher relay entity because the relay must be disabled before deletion.

9.4 event dispatcher relay logging

creation time

Time at which this entity was created.

events relayed

Number of Phase IV events relayed for this logging type.

name

Logging type is console, monitor, or file.

state

Status of the event dispatcher relay logging entity.

off	The event dispatcher logging entity is disabled.
on	The event dispatcher logging entity is enabled.

uid

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

event relayed

Generated whenever a Phase IV event is received. It relays the Phase IV event into the DECnet-Plus Event Logging Architecture. The entire DECnet-Plus NICE message is encapsulated into the NICE (Network Information and Control Exchange) data argument.

---

Previous | Next | Contents | [Home] | [Comments] | [Ordering info] | [Help]

---

  NCL_PROFILE_007.HTML
  OSSG Documentation
   2-DEC-1996 12:47:49.70

Copyright © Digital Equipment Corporation 1996. All Rights Reserved.

Legal