HP OpenVMS Systems Documentation
Content starts here

DECnet-Plus for OpenVMS
Network Management
Previous Contents Index

Appendix E
decnet_register Commands

This appendix describes decnet_register, the DECnet-Plus node registration tool, and its command line interface. Using decnet_register you can register and manage DECnet Phase V node names in the DECdns distributed name service, the local namespace, and the Phase IV node database. See Chapter 5 for information about using decnet_register to perform tasks and about the decnet_register forms interface.

E.1 The Command Line Interface

The decnet_register command line interface supports the following commands:

add
attach
deregister
do
exit
export
import
manage
modify
register
remove
rename
repair
reset
set
show
spawn
update

E.1.1 Running decnet_register on OpenVMS Systems

There are several ways to invoke decnet_register:

  • From a video terminal, enter RUN SYS$SYSTEM:DECNET_REGISTER at the system prompt: 


    $ run sys$system:decnet_register

    By default from a video terminal, decnet_register starts in forms mode.
  • From a hardcopy terminal, enter RUN SYS$SYSTEM:DECNET_REGISTER at the system prompt: 


    $ run sys$system:decnet_register

    By default from a hardcopy terminal, decnet_register starts in command mode. Once invoked in this manner, decnet_register continues to accept commands until you exit the tool.
  • Define a symbol at the system prompt (or insert the symbol in your login file) and then type the symbol name at the system prompt, as in the following example, which defines the symbol netreg: 


    $ netreg :== $sys$system:decnet_register
$ netreg
netreg>
  • If you have defined a foreign command symbol as described above, you can enter a decnet_register command line at the system prompt: 


    $ netreg show node MyNode

    After the command executes, you return to the system prompt.
  • When you invoke decnet_register from a command file, it runs in command mode until it encounters an exit command.

You can change this startup behavior in two ways:

  • Permanently, by defining a logical name.
  • For one invocation only, by using the /c and /f qualifiers on the command line.

To change the default behavior permanently, define one of the following logical names:

  • The following command forces default use of the command line interface until you remove the logical name: 


     $ define decnet_register_commands 1
  • The following command forces default use of the forms interface until you remove the logical name: 


    $ define decnet_register_forms 1

To change the default behavior for the current invocation only, use one of the following qualifiers:

  • The following command forces use of the command line interface for the current invocation only: 


    $ decnet_register /c
  • The following command forces use of the forms interface for the current invocation only. 


    $ /usr/sbin/decnet_register /f

Note
The decnet_register tool is not supported on a system booted MINIMUM.

add

The add command adds a new address tower to a node registration. When a new address tower is available for a node, this command adds the addressing information to the node registration in the specified name service.

Syntax

add node node-name towers {t-set} [directory_service dir-service | phaseIV_prefix addr-prefix | reverse_directory r-dir-name]

Arguments

node-name

Specifies the fully specified name (full name) of the node whose address towers are to be added. (The full name includes any directories.) The syntax for a full name depends on the name service used by the node:
Name Service Node Full Name
DECdns MyCo:.Sales.MailHub
Local file MailHub
Phase IV MLHUB

t-set

Specifies the set of one or more address towers to add to the node registration. Separate multiple address towers with commas. Include the set of address towers within braces.

Each address tower in the set has the following format: transport/address

You can omit fields from left to right, and assume a default value as follows:

Table E-1
Field Possible Values Default Value
transport TP4, TP4=tsel, or NSP For an N-Sel value of 20, the default is NSP. Otherwise, the default is TP4.
address NSAP value or Phase IV address value For a Phase IV address, an NSAP is constructed using the specified address and the Phase IV prefix value. The N-Sel value is always 20.

For a Phase IV address prefix value of 49::, example address towers follow:

Table E-2
Abbreviated Address Tower Fully Specified Address Tower
1.5  
  NSP/49::01:AA0004000504:20
1.5+39:840  
  NSP/39:840:01:AA0004000504:20
39:840:01:AA0004000504:20  
  NSP/39:840:01:AA0004000504:20
39:840:01:AA0004000504:21  
  TP4=DEC0/39:840:01:AA0004000504:21
TP4/39:840:01:AA0004000504:21  
  TP4=DEC0/39:840:01:AA0004000504:21
TP4=A1/39:840:01:AA0004000504:21  
  TP4=A1/39:840:01:AA0004000504:21

An example address tower for a DECnet Phase IV node using normal default values follows:
TOWERS={1.5}

An example address tower for a DECnet Phase V node using normal default values follows:
TOWERS={2.54, 39:840:01:080043A751F4:20, 39:840:01:080043A751F4:21}

dir-service

Optional. Specifies the name service that contains the node registration. The dir-service must be one of the following:
Name Service Keyword
DECdns decdns
Local file local
Phase IV phaseiv

If you do not specify a name service, the default name service specified with the set default command is used.

addr-prefix

Specifies the AFI, IDI, and preDSP to use when constructing an NSAP from a Phase IV address. The addr-prefix is used when a Phase IV address is specified in an address tower.

If you do not specify a phaseiv_prefix, the default Phase IV prefix specified with the set default command is used.

r-dir-name

Optional. Specifies the base directory or name entry to use when creating the reverse address mapping links to the node_name. (Reverse address mapping links are also referred to as backtranslation links.) The links created under this directory are used to map NSAP values to their respective node names (node-name). These directories are used only for the DECdns name service.

If you do not specify a reverse_directory, the default reverse directory specified with the set default command is used.

attach

The attach command attaches the terminal to another process. This transfers control from your current process (running decnet_register) to the specified process. Your current process is placed in a hibernation state.

Syntax

attach [process-name]

Arguments

process-name

Optional. Specifies a process to attach to. You can use the OpenVMS show process and show system commands to determine process names.

If you do not specify a process-name, the terminal is attached to the parent (owner) process for the current process.

deregister

The deregister command removes a node registration from a name service. When a node is no longer available on the network, use the deregister command to remove the node registration from the name service.

Syntax

deregister node node-id [directory_service dir-service | phaseiv_prefixaddr-prefix | reverse_directory r-dir-name | synonym_directory s-dir-name]

Arguments

node-id

Identifies the node to deregister. The node-id can be one of the following:
  • The fully specified name for the node in the name service. The syntax for a fully specified node name depends on the name service where the name is registered.
  • The Phase IV synonym for the node.
  • One of the NET or NSAP addresses for the node.
  • The Phase IV address (and optional Phase IV prefix) for the node.

The syntax for a fully specified name (full name) depends on the name service where the node is registered:

Name Service Node Full Name
DECdns MyCo:.Sales.MailHub
Local file MailHub
Phase IV MLHUB

An example Phase IV synonym for all the previously mentioned full names follows: MLHUB.

You can use a single asterisk (*) wildcard character anywhere in the last part of the name as follows:

Name Service Node Full Name with Wildcard Character
DECdns MyCo:.Sales.Mail*
Local file node Mail*
Phase IV node ML*

You can specify a node's address by using one of its NETs or NSAPs, or its Phase IV address.

A NET is an NSAP address value with an N-Sel value of "00" (indicating that it is independent of the type of transport service in use on the node). If you specify an NSAP instead of a NET, it is converted to an NET before it is used.

DNA format: <afi>:<idi>:<predsp>-<locarea>:<nodeid>:00
OSI format: <afi><idi>+<predsp><locarea><nodeid>00

If the node has a Phase IV address, you can use it instead of a NET:

Format: <area>.<nodeid>
  <area>.<nodeid>+<prefix>

The Phase IV address is internally converted to a NET, using the Phase IV prefix value. The Phase IV prefix value can be specified with the Phase IV address or the PhaseIV_prefix parameter, or set using the set default command.

You can use the asterisk (*) wildcard character in the NET or Phase IV address. The wildcard character must replace either the node-id or the local area and the node-id. If you specify a NET containing a wildcard character, do not also specify an N-Sel value.

NET Wildcard the node-id: 39:840:0001:*
  Wildcard the local area and node-id: 39:840:*
Phase IV Wildcard the node-id: 1.*
  Wildcard the area and node-id: *.*

dir-service

Optional. Specifies the name service from which the node is to be removed.

The dir-service must be one of the following:

Name Service Keyword
DECdns decdns
Local file local
Phase IV phaseiv

If you do not specify dir-service, the default name service specified with the set default command is used.

addr-prefix

Optional. Specifies the AFI, IDI, and preDSP to use when constructing an NSAP from a Phase IV address. The addr-prefix is used only when a Phase IV address is specified for the node-id.

As an alternative, you can add the Phase IV prefix to the Phase IV address specification.

If you do not specify a phaseiv_prefix, the default Phase IV prefix specified with the set default command is used.

r-dir-name

Optional. Specifies the base directory or name entry to use when deleting the reverse address mapping links to the node name.

s-dir-name

Optional. Specifies the base directory or name entry to use when deleting the synonym mapping link to the node name.

If you do not specify a s-dir-name, the default synonym directory specified with the set default command is used.

do

The do command executes a named file containing decnet_register commands. Within the command file, the commands must appear as if entered at the decnet_register> prompt. One command file can reference another command file. Commands are processed in order until the end of the file is reached or until a command error occurs.

Syntax

do command-file-name

An alternative form of the do command is:

@command-file-name

Arguments

command-file-name

Specifies the name of the file containing decnet_register commands to execute.

exit

The exit command exits the decnet_register utility.

You can also use the quit command.

Syntax

exit

For an OpenVMS system, you can also use the following key sequence: Ctrl/Z

export

The export command extracts node registration information for a specified set of nodes and writes it to a text file, the export/import file.

Once the information has been extracted to the export/import file, it can be:

  • Used for reporting or database maintenance.
  • Used to make networkwide changes, such as modifying the NSAP IDP value by first editing the export/import file and then using the MODIFY feature of the import command.
  • Used to move node information from one name service to another using the REGISTER or UPDATE features of the import command.
  • Used to verify that the addressing information in one name service is the same as in another name service, using the VERIFY feature of the import command.
  • Used to remove node information from a name service, using the DEREGISTER feature of the import command.

Syntax

export node node-id file file-name [directory_service dir-service | phaseiv_prefix addr-prefix | reverse_directory r-dir-name | synonym_directory s-dir-name | nsap_format addr-format]

Arguments

node-id

Identifies the nodes to export. The node-id can be one of the following:
  • The fully specified name for the node in the name service
  • The Phase IV synonym for the node
  • One of the NET or NSAP addresses for the node, or its Phase IV address
  • The Phase IV address (and optional Phase IV prefix) for the node

The syntax for a fully specified name depends on the name service where the node is registered. Example formats for fully specified names follow:

Name Service Node Full Name
DECdns MyCo:.Sales.MailHub
Local file node MailHub
Phase IV node MLHUB

An example Phase IV synonym for all the previously mentioned full names follows: node MLHUB.

You can use a single asterisk (*) wildcard character anywhere in the last part of the name as follows:

Name Service Node Full Name with Wildcard Character
DECdns MyCo:.Sales.Mail*
Local file node Mail*
Phase IV node ML*

You can specify a node's address by using one of its NETs or NSAPs, or its Phase IV address.

A NET is an NSAP address value with an N-Sel value of "00" (indicating that it is independent of the type of transport service in use on the node). If you specify an NSAP instead of a NET, it is converted to an NET before it is used.

DNA format: <afi>:<idi>:<predsp>-<locarea>:<nodeid>:00
OSI format: <afi><idi>+<predsp><locarea><nodeid>00

If the node has a Phase IV address, you can use it instead of a NET:

Format: <area>.<nodeid>
  <area>.<nodeid> +<prefix>

The Phase IV address is internally converted to a NET, using the Phase IV prefix value. The Phase IV prefix value can be specified with the Phase IV address or the PhaseIV_prefix parameter, or set using the set default command.

You can use the asterisk (*) wildcard character in the NET or Phase IV address. The wildcard character must replace either the node-id or the local area and the node-id. If you specify a NET containing a wildcard character, do not also specify an N-Sel value.

NET Wildcard the node-id: 39:840:0001:*
  Wildcard the local area and node-id: 39:840:0001:*
Phase IV Wildcard the node-id: 1.*
  Wildcard the area and node-id: *.*

file-name

Names the text file to contain the exported information.

dir-service

Optional. Specifies the name service from which node information is to be exported. The dir-service must be one of the following:
Name Service Keyword
DECdns decdns
Local file local
Phase IV phaseiv

If you do not specify dir-service, the default service specified with the set default command is used.

addr-prefix

Optional. Specifies the AFI, IDI, and preDSP to use when constructing an NSAP from a Phase IV address. The addr-prefix is used only when a Phase IV address is specified for the node-id.

As an alternative, you can add the Phase IV prefix to the Phase IV address specification.

If you do not specify a phaseiv_prefix, the default Phase IV prefix specified with the set default command is used.

r-dir-name

Optional. Specifies the base directory or name entry to use when exporting the reverse address mapping links to the node name. (These links are also called the backtranslation links.)

The links under this directory are used to map NSAP values to their respective node names. Reverse address mapping links are used only by the DECdns name service.

If you do not specify a reverse_directory, the default reverse_directory specified with the set default command is used.

s-dir-name

Optional. Specifies the base directory or name entry to use when exporting the synonym mapping link to the node name. The links under this directory are used to map Phase IV synonyms to their respective node names. Synonym mapping links are used only by the DECdns name service.

If you do not specify a synonym_directory, the default synonym directory specified with the set default command is used.

addr-format

Optional. Specifies the format to use when converting NSAP addresses to their text representation in the export file.

The addr-format must be one of the following:

For DNA: dna
For OSI: osi

This causes the appropriate format to be used:

DNA format:
<afi>:<idi>:<predsp>-<locarea>:<nodeid>:00
OSI format: <afi><idi>+<predsp><locarea><nodeid>00

If you do not specify an nsap_format, the default nsap_format specified with the set default command is used.

Previous Next Contents Index