[Digital logo]
[HR]

DECnet-Plus
Network Control Language Reference


Previous | Contents

Figure 17-1 shows the hierarchical relationship of the entities that constitute the MOP module.

Figure 17-1 Hierarchy of MOP Module Entities



17.1 mop

The mop entity is the top-level entity in the hierarchy of entities belonging to the MOP module.
create [node node-id] mop
delete [node node-id] mop
disable [node node-id] mop
enable [node node-id] mop
show [node node-id] mop [all [attributes] | all characteristics | all status ]

17.1.1 Characteristic Attributes

supported functions

MOP components supported on the system. This is a read-only attribute.
configuration monitor load server
console requester loop requester
dump server query requester
load requester (Digital UNIX) test requester

version

Default: Current version number
Version number of the Maintenance Operations Protocol specification to which the implementation conforms. This is a read-only attribute.

17.1.2 Status Attributes

state

State of the mop entity. This is a read-only attribute.
off The mop entity is disabled.
on The mop entity is enabled.

17.1.3 Exception Messages

For create:

already exists

A mop module already exists.

For delete:

has children

Cannot delete while subentities exist.

17.2 mop circuit

A mop circuit entity is a data link circuit on which MOP services are available. The status attribute functions specifies the services enabled on the circuit. The circuit-name refers to the circuit managed by this command.
boot [node node-id] mop circuit circuit-name {address lan-address | client client-name | device string | script id string | software id string | verification hex-string }
create [node node-id] mop circuit circuit-name type type-1
delete [node node-id] mop circuit circuit-name
disable [node node-id] mop circuit circuit-name functions [func_name1, func_name2...]
enable [node node-id] mop circuit circuit-name functions [func_name1, func_name2...]
load [node node-id] mop circuit circuit-name {address lan-address | client client-name | management image filespec | script file filespec | secondary loader filespec | system image filespec | tertiary loader filespec | verification hex-string }
loop [node node-id] mop circuit circuit-name {address lan-address | assistance type help-type | assistant address lan-address | assistant system client-name | client client-name | count integer | format octet | length integer }
query [node node-id] mop circuit circuit-name {address lan-address | client client-name | sap octet }
set [node node-id] mop circuit circuit-name {known clients only boolean | link name data-link-entity-name | retransmit timer seconds }
show [node node-id] mop circuit circuit-name [all [attributes] | all characteristics | all counters | all identifiers | all status ]
test [node node-id] mop circuit circuit-name {address lan-address | client client-name | count integer | format octet | length integer | sap octet }

17.2.1 Commands

boot

Causes the system specified by node-id to send a boot message to an adjacent system.

load

Initiates a downline load from the system specified by node-id to a target system specified by the arguments or by a client.

loop

Performs a loop operation with another system.

query

Initiates an XID exchange between the system specified by node-id and the system specified by the arguments or a client.

test

Initiates an XID test between the system specified by the arguments or by a client.

17.2.2 Arguments

For a complete list of arguments, refer to the corresponding command in the mop client description.

functions func_name1, func_name2...

Which optional MOP functions are currently enabled for this circuit (see the enable command).
configuration monitor load server
console requester loop requester
dump server query requester
load requester (Digital UNIX) test requester

type type-1

Circuit type, which is set when the circuit is created (see the create command). You cannot modify this characteristic.

17.2.3 Characteristic Attributes

known clients only

Default: False Value: True or false
Specifies whether MOP attempts to service load requests from remote systems that do not have a corresponding client entity. Some network servers are designed to request specific software by name, and in such a case there is no need for a client entity to exist. By default, MOP tries to process requests for named software from unknown clients. Set this attribute to true if you wish MOP to ignore such requests.

link name

Default: No name Value: Data Link entity name
Name of a station entity in the Data Link layer module indicated by the type characteristic. This name is passed to the Data Link layer module when MOP opens a portal for the circuit.

retransmit timer

Default: 4 Value: 1--30
Time, in seconds, to wait for a response before retransmitting a MOP message.

type

Specifies the circuit type. This characteristic is set when the circuit is created (see the create command). The possible types are CSMA-CD, FDDI, HDLC (Digital UNIX loop only), DDCMP (OpenVMS only), and LAPB (OpenVMS only). You cannot modify this characteristic.

17.2.4 Counter Attributes

creation time

Time this entity was created.

dump requests completed

Number of dump service requests that completed successfully.

failed dump requests

Number of dump service requests that could not be completed.

failed load requests

Number of load service requests that could not be completed.

load requests completed

Number of load service requests that completed successfully.

unrecognized dump clients

Number of dump service requests that could not be processed because a required client database entry could not be found.

unrecognized load clients

Number of load service requests that could not be processed because a required client database entry could not be found.

17.2.5 Identifier Attributes

name

Simple name assigned to the circuit when it is created.

17.2.6 Status Attributes

functions

Which optional MOP functions are currently enabled for this circuit (see the functions argument).

uid

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

17.2.7 Event Messages

dump request completed

Generated each time a remote dump service request completes successfully.

Arguments: See the address, client, and file arguments described under the load request failed event.

dump request failed

Generated each time a remote dump request tries and fails. When a request is never started because of insufficient client information, the unrecognized dump client event is reported.

Arguments: See the address, client, file, and reason arguments described under the load request failed event.

load request completed

Generated each time a remote load service request completes successfully.

Arguments: See the address, client, file, and program type arguments described under the load request failed event.

load request failed

Generated each time a remote load request tries and fails. When a request is never started because of insufficient client information, the unrecognized load client event is reported.

Arguments:
address Data link address of the remote system. This argument is supplied only for LAN data links.
client Name of the client that corresponds to the remote system.
file Name of the file being dumped or loaded.
program type Program type requested by the remote system on a load operation.
cmip script A file containing initialization data encoded as network management directives in CMIP form.
diagnostic A file containing diagnostic test procedures.
management A file containing initialization data encoded in a product-specific format.
secondary loader A secondary file containing software to be downline loaded.
system The primary file containing the system image to be downline loaded.
tertiary loader A third file containing software to be downline loaded.
reason Reason for the failure.
file i/o error Unable to read load file or write dump file.
file open error Unable to open load or dump file requested.
no resources Insufficient network management or system resources.
operation aborted Unexpected error prevents completion of request.
protocol error A violation of MOP occurred.
receive error Error or timeout receiving data from the network.
transmit error Error reading data to the network.
unknown client Client requesting load or dump is not found in MOP client database.

unrecognized dump client

Generated each time a remote dump service request was not accepted because a required client database entry could not be found.

Argument: See the address argument described under the load request failed event.

unrecognized load client

Generated each time a remote load service request was not accepted because a required client database entry could not be found.

Arguments: See the address and program type arguments described under the load request failed event.

17.2.8 Exception Messages

For create:

already exists

A mop circuit subentity already exists.

unsupported circuit type

Type of argument value is not supported in this implementation.

For delete:

has children

Cannot delete while subentities exist.

For enable:

non-existent data link

Specified data link entity does not exist.

open port failed

Open port operation failed.

unsupported

Specified function is not supported by this system.

For boot, load, loop, test, and query:

data link error

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

unrecognized circuit

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

unrecognized client

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

For loop:

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.

unrecognized assistant

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

For load, loop, test and query:

data link error

An error was reported by the Data Link layer.

timeout

Operation has timed out on the loop command.

unrecognized client

There is no client with the specified identification.

For load:

protocol error

A protocol error occurred during the load.

17.3 mop circuit operation

The mop circuit operation entities are created automatically by MOP for all operations, including those initiated by NCL action directives and those initiated by automatic load and dump service. They are deleted when the corresponding operation is complete.
show [node node-id] mop circuit circuit-name operation operation-name [all [attributes] | all identifiers | all status ]

17.3.1 Identifier Attributes

name

Simple name of the operation entity that is generated automatically by MOP. The simple name is derived from the operation being performed (load or dump) and a numeric suffix added to ensure uniqueness.

17.3.2 Status Attributes

address

For LANs only, specifies the address of the client system.

client

Client name of the client entity associated with the operation, if such an entity exists.

operation

The operation being performed (boot, dump, load, loop, query, or test).

17.4 mop circuit station

The mop circuit station entities are created automatically by the Configuration Monitor. They are deleted when the circuit entity is deleted.

Note

The Configuration Monitor function must be enabled to obtain the status information used by the show mop circuit station command.


show [node node-id] mop circuit circuit-name station station-name [all [attributes] | all identifiers | all status ]

17.4.1 Identifier Attributes

name

Name of the station entity, generated automatically by the Configuration Monitor. The name is identical to the source LAN address for the System ID message.

17.4.2 Status Attributes

command size

Maximum acceptable console command size. A zero value means it is not applicable.

console user

LAN address of the system that currently has the console reserved; all zeroes if the console is not in use.

data link

Data Link protocol used by the remote station.

device

Type of communication device used by the remote station.

dsdu size

Maximum allowed size for a MOP message, not including data link protocol overhead.

functions

The set of functions supported: loop server, dump requester, primary loader, secondary loader, boot, console carrier, and counters.

hardware address

Default data link address for the circuit on which the system ID was transmitted by the remote station.

last report

Time at which the most recent system ID message was received.

mop version

Highest version of the MOP supported by the remote station.

node id

Node ID for the remote station. If not reported, the null ID (00-00-00-00-00-00) is displayed.

node name

Node name for the remote station, as a DECdns full name. If not reported by the remote station, the null name is used; this is displayed as "0:.".

reservation timer

Console reservation timer, in seconds. A zero values means it is not applicable.

response size

Maximum acceptable console response size. A zero value means it is not applicable.

17.5 mop client

A mop client entity is a set of default characteristics used by several MOP functions: dump/load server, load requester, loop requester, and console requester. When a command or a request for one of these services does not supply all of the required arguments, the values stored by the client are used to perform the operation. The client-name refers to the client managed by this command.
add [node node-id] mop client client-name {addresses {lan-address[,lan-address...]} | device types {type[,type...]} }
boot [node node-id] mop client client-name {address lan-address | circuit circuit-id | device string | script id string | software id string | verification hex-string }
create [node node-id] mop client client-name
delete [node node-id] mop client client-name
load [node node-id] mop client client-name {address lan-address | circuit circuit-name | management image filespec | script file filespec | secondary loader filespec | system image filespec | tertiary loader filespec | verification hex-string }
loop [node node-id] mop client client-name {address lan-address | assistance type help-type | assistant address lan-address | assistant system client-name | circuit circuit-name | count integer | format octet | length integer }
query [node node-id] mop client client-name {address lan-address | circuit circuit-name | sap octet }
set [node node-id] mop client client-name {addresses {lan-address[,lan-address...]} | circuit circuit-name | device types {type[,type...]} (OpenVMS) | diagnostic image filespec | dump address integer | dump file filespec | management image filespec | phase iv client address phase4-address | phase iv client name phase4-name | phase iv host address phase4-address | phase iv host name phase4-name | script file filespec | secondary loader filespec | system image filespec | tertiary loader filespec | verification hex-string }
show [node node-id] mop client client-name [all [attributes] | all characteristics | all identifiers ]
test [node node-id] mop client client-name {address lan-address | circuit circuit-name | count integer | format octet | length integer | sap octet }

17.5.1 Commands

boot

Causes the system specified by node-id to send a boot message to an adjacent system.

load

Initiates a downline load from the system specified by node-id to a target system specified by the arguments or by a client.

loop

Performs a loop operation with another system.

query

Initiates an XID exchange between the system specified by node-id and the system specified by the arguments or a client.

test

Initiates an XID test between the system specified by the arguments or by a client.

17.5.2 Arguments

address lan-address

LAN address of the circuit named in the circuit argument. This argument is required for LAN circuits. If you do not supply this information as an argument for this command, you must specify a client set of parameters to provide this data (see the client argument).

assistance type help-type

Degree of loopback assistance required, for LAN circuits only. Valid values are none, transmit, receive, and full.

assistant address lan-address

LAN address to be used as a loopback assistant. The involvement of the assistant depends on the assistance type parameter. For assistance of type none, no assistant is needed, and is ignored if specified. For other values, an assistant is required. If not specified, an assistant is located by first sending a request to the loopback assistant multicast address.

assistant system client-name

A client entity, from which an assistant address is obtained. Meaningful for LAN circuits only, see assistant address.

circuit circuit-id

A client entity to be used for this operation. This parameter must be specified, either directly or via the client entity. For boot, specifies the name of the circuit over which the boot operation is to occur. For load, specifies the name of the MOP circuit over which the downline load is to take place. This information is required.

client client-name

A client entity to be used for this operation. The client is used to provide defaults for address, circuit, and verification parameters.

count integer

Number of messages to be looped. Note, on failure of the loop test, NCL will display the count of messages successfully looped.

device string

Provides some information required by the target system for the boot operation.

device types type (OpenVMS)

Specifies one or more device types associated with this client. Use device type and omit the address if you want to set up a generic client entity. The entity will be used for any incoming load and dump requests that specify a matching communication device type.

format octet

Value of each byte in the test data part of each loop message. The default results in alternating 0 and 1 bits.

length integer

Length of the test data part of each loop message. The maximum and minimum permitted values depend on the particular data link in use.

management image filespec

A file containing initialization data for the node; data is encoded in a product-specific format. (Also see the script file argument.) This argument may be required by the target system.

sap octet

The service access point (on the target system) to which the XID message is to be sent.

script file filespec

A file containing initialization data for the node; data is encoded as a sequence of network management commands in CMIP form. (Also see the management image argument.) This argument may be required by the target system.

script id string

Script file required by the target system for boot.

secondary loader filespec

The name of a second file containing the software to be downline loaded. This argument may be required by the target system.

software id string

System image required by the target system for boot.

system image filespec

The file containing the system image to be downline loaded. This argument is required for LAN circuits. If you do not supply this information as an argument for this command, you must specify a client set of parameters to provide this data. See the client argument.

tertiary loader filespec

The name of a third file containing the software to be downline loaded. This argument may be required by the target system.

verification hex-string

A string that must match a verification code at the receiving system in order to trigger the bootstrap mechanism so that the downline load can be performed (default: %x00-00-00-00-00-00-00-00). The value must have an even number of digits from 2 to 16.

17.5.3 Characteristic Attributes

addresses

Default: Empty set Value: Set of LAN addresses
Set of LAN addresses for this client on the circuit specified by the circuit characteristic.

For OpenVMS, Phase IV nodes can use an extended DECnet LAN address in addition to their hardware address, so you must include both of these addresses in the addresses set. To calculate the extended DECnet address, express the Phase IV node address as a four-digit hex integer, then add the prefix AA-00-04-00.


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

[HR]

  NCL_PROFILE_015.HTML
  OSSG Documentation
   2-DEC-1996 12:48:10.60

Copyright © Digital Equipment Corporation 1996. All Rights Reserved.

Legal