Please read the following topics to gain an understanding of: - how to use this help utility, - the organization of topics within this help utility, - how manageable components of the network are organized in a logical hierarchy (the entity hierarchy), and - how that entity hierarchy is used as a framework for network management using NCL, the Network Command Language.
1 – Using NCL Help
To access online NCL help, type help at the ncl> prompt. Type the name of the command or topic for which you need help. When selecting help topics, you may abbreviate help topic names, provided that the abbreviation uniquely identifies the help topic. Type a question mark (?) to obtain a list of available topics. For OpenVMS, press Return at the "Topic:" prompt to go up a level in the hierarchy, and to exit help. You can also exit NCL help by pressing Ctrl/Z in response to any prompt. For DEC OSF/1, press Ctrl-D at the "Topic" prompt to go up a level in the hierarchy, and to exit help.
2 – Overview of NCL Help
Besides listing all the NCL command and control verbs, the top level of NCL help includes the following topics: NCL_Introduction - Describes the syntax and usage of the Network Control Language. Subtopics provide help on: o Invoking NCL o Creating NCL log files o Commonly used NCL commands (create/delete, enable/disable, set/show, and add/remove) o Abbreviating NCL commands o NCL Syntax, with explanations of valid data types, verbs, entity names, attributes, required and optional command arguments, and node-id specification. Also describes the usage of prepositional phrases and wildcards. o Recalling previously entered NCL commands o Interpreting NCL command output o Specifying access control for a single NCL command o Setting default entity and access control context to be used for a series of NCL commands o Using snapshot commands to monitor counters o Methods of customizing the NCL environment Entity_Hierarchy - Describes most network components manageable using NCL. Includes diagrams showing each entity's location within the management hierarchy. Network_Management - Describes network management concepts and tools. Subtopics include: o Access control methods and policies o Management of naming services o Managing remote Phase IV and Phase V nodes o Logical names (OpenVMS) o Startup NCL Scripts (OpenVMS) o Shutting down and restarting DECnet (OpenVMS) o Managing MOP (OpenVMS) o Managing the Event Dispatcher (OpenVMS) o Running Over TCP/IP o The Tools subtopic includes descriptions of: - the Console Carrier - Network Management GUI - Decnet_migrate - Decnet_register - Configuration Monitor - NCP Emulator (OpenVMS) - DNS$Control (OpenVMS) - NET$Configure (OpenVMS) Event_Messages - Details possible event messages for each entity. Directory_Module - Describes the X.500 Directory Service module and NCL commands to manage the Directory System Agent (DSA) and its subentities. SNA_Peer_ Describes the SNA Peer Server Module and Server_Module - applicable NCL commands.
3 – Entity Organization
Because DECnet-Plus software has so many manageable components, these entities must be organized into a logical structure. The organization defined is a hierarchical one where there are top-level entities and subordinate entities. Each computer system in a DECnet-Plus network is a global entity which is represented by the node entity. Each computer is given a name that is unique throughout the network. That name is then represented in NCL commands as the "node node-id". (The default node-id is 0, which represents the local node.) Below the node entity are modules, or entity classes, such as CSMA-CD, OSI Transport, Routing, etc. You may type HELP ENTITY_HIERARCHY for a diagram of the modules beneath the node entity. To obtain a description of any of those modules, you may use the HELP ENTITY <module_name> command. For example, to obtain a description of the Routing module, type: ncl> help entity routing To obtain a diagram of the subentities beneath a module, use the HELP ENTITY <module_name> SUBENTITIES command. For example, to see a diagram and descriptions of the Routing subentities, type: ncl> help entity routing subentities
4 – Managing Entities Using NCL
Once you are comfortable with the concept of the entity hierarchy, you may wish to browse the NCL_INTRODUCTION help topic to become familiar with how NCL is used to manage those entities. The NCL SYNTAX help topic will be particularly helpful if you are not yet familiar with NCL.