CONTENTS Title Page Copyright Page Preface 1 Introduction 1.1 The BASEstar Open Command Language Interface 1.2 Requesting BASEstar Open Services 1.3 The Permanent and Volatile Object Databases PART I General Purpose and Configuration Management Services 2 General Purpose Commands 2.1 Invoking and Exiting the BASEstar Open CLI 2.1.1 Setting the Global Variables 2.1.2 Activating the Startup Command File 2.1.3 Issuing Commands in Interactive Mode 2.1.4 Immediate Command Execution 2.1.5 Executing a Command File 2.1.6 Checking a Command File 2.2 CLI Command Syntax 2.2.1 Command Keywords and User Tokens 2.2.2 Strings and Lists 2.3 Wildcard Characters 2.4 Level-by-Level Prompting 2.5 Getting Help Through BASEstar Open CLI 2.5.1 "OSF/1 Only" 2.5.2 "OpenVMS Only" 2.5.3 DESCRIBE TOKEN Utility 2.6 Analysis of Returned Messages 2.6.1 Parsing Errors 2.6.2 Execution Errors 2.7 History and Line Editing Facility 2.7.1 "OSF/1 Only" 2.7.2 "OpenVMS Only" 2.8 Preparing a Command File 2.9 Setting the Database Scope 2.10 Setting the Context 2.11 Executing Platform-Dependent Command Interpreter Commands 3 General Purpose Commands Reference DESCRIBE TOKEN EXIT GET CONTEXT GET SCOPE HELP ("OSF/1 Only") HELP ("OpenVMS Only") MAN QUIT RUN SET CONTEXT SET PROMPT SET SCOPE SHELL SOURCE SPAWN WRITE 4 Configuration and Activation of an Overall Application 4.1 Configuration and Activation Procedures 4.1.1 Using PODB Object Definitions 4.1.2 Using Objects Directly Created in the VODB 4.2 Management of Snapshot Configurations 4.2.1 Snapshot Configurations and Snapshot Configuration Versions 4.2.2 Snapshot Configuration Management Commands 4.2.2.1 Creating and Upgrading a Snapshot Configuration 4.2.2.2 Purging and Resetting a Snapshot Configuration 4.2.3 Loading the Configuration 5 Configuration Management Commands Reference DUMP SNAPSHOT GENERATE SNAPSHOT GET INFO SNAPSHOT LOAD CONFIGURATION PURGE SNAPSHOT RESET SNAPSHOT UPGRADE SNAPSHOT PART II Common Services 6 Common Services Commands 6.1 Operations on Realms 6.2 Operations on Objects 6.2.1 Creating an Object 6.2.2 Displaying Object Attributes 6.2.3 Deleting an Object 6.2.4 Modifying an Object 6.2.5 Renaming an Object 6.3 Operations on Domains 6.3.1 Creating Domains 6.3.2 Getting the List of Components and Children 6.4 Object Names 6.5 Operations on Datatypes 6.5.1 Simple_Datatypes 6.5.2 Array_Datatypes and Structure_Datatypes 6.5.3 Entering and Displaying Datatype Compatible Values 6.6 Managing Object Statistics 7 Common Services Commands Reference CREATE ARRAY_DATATYPE CREATE DOMAIN CREATE STRUCTURE_DATATYPE DELETE class DISABLE STATISTICS class ENABLE STATISTICS class GET STATISTICS class MODIFY class MOVE DOMAIN RENAME class RESET STATISTICS class SHOW ARRAY_DATATYPE SHOW CHILDREN DOMAIN SHOW COMPONENTS DOMAIN SHOW DOMAIN SHOW OBJECTS REALM SHOW STRUCTURE_DATATYPE PART III Event Services 8 Event Services Commands 8.1 Creating and Deleting an Event Subscription 8.2 Declaring an Event 8.3 Connecting to an Enbox and Receiving Notifications 8.3.1 Flushing a System Buffering Enbox 8.4 Operating on Event_Sets 9 Event Services Commands Reference ADD COMPONENTS EVENT_SET ADD SUBSCRIPTION EVENT ADD SUBSCRIPTION EVENT_SET CONNECT ENBOX CREATE ENBOX CREATE EVENT CREATE EVENT_SET DECLARE EVENT DISABLE SUBSCRIPTION EVENT DISABLE SUBSCRIPTION EVENT_SET DISCONNECT ENBOX ENABLE SUBSCRIPTION EVENT ENABLE SUBSCRIPTION EVENT_SET GET INFO ENBOX RECEIVE NOTIFICATION ENBOX REMOVE COMPONENTS EVENT_SET REMOVE SUBSCRIPTION EVENT REMOVE SUBSCRIPTION EVENT_SET SHOW ENBOX SHOW EVENT SHOW EVENT_SET SHOW SUBSCRIPTIONS ENBOX SHOW SUBSCRIPTIONS EVENT SHOW SUBSCRIPTIONS EVENT_SET PART IV Packet Services 10 Packet Services Commands 10.1 Sending a Packet 10.2 Connecting to a Port 10.2.1 Flushing a SYSTEM_BUFFERING Port 10.3 Receiving Packet Notifications 10.4 Managing Packet Notifications Requiring a reply 11 Packet Services Commands Reference CONNECT PORT CREATE PACKET CREATE PORT DISCONNECT PORT GET INFO PORT RECEIVE PACKET PORT SEND PACKET PORT SHOW PACKET SHOW PORT PART V Data Services 12 Data Services Commands 12.1 Operations on Data_Points 12.1.1 Reading and Writing Data_Point Values 12.1.2 Locking and Unlocking Data_Points or Data_Point_Sets 12.1.3 Enabling and Disabling Triggers 12.1.4 Linking Data_points 12.1.5 Displaying the Status of a Data_Point 12.2 Operations on Device_Data_Points 12.3 Creating Mapped_Data_Points 12.4 Versioning 13 Data Services Commands Reference ADD COMPONENTS DATA_POINT_SET CREATE DATA_POINT CREATE DATA_POINT_SET CREATE DEVICE_DATA_POINT CREATE FILTER CREATE MAPPED_DATA_POINT CREATE TRIGGER DISABLE TRIGGER ENABLE TRIGGER GET STATUS DATA_POINT GET VALUE DATA_POINT LINK DATA_POINT LOCK DATA_POINT LOCK DATA_POINT_SET PUT VALUE DATA_POINT REMOVE COMPONENTS DATA_POINT_SET RESET CACHE DATA_POINT SHOW DATA_POINT SHOW DATA_POINT_SET SHOW DEVICE_DATA_POINT SHOW FILTER SHOW MAPPED_DATA_POINT SHOW TRIGGER UNLINK DATA_POINT UNLOCK DATA_POINT UNLOCK DATA_POINT_SET PART VI Device Services 14 Device Services Commands 14.1 Creating VMDs 14.1.1 Access Points 14.1.2 Using the BASEstar Open/MMS Protocol 14.2 Creating Variables 14.3 Creating Polling_Sets 14.4 Operating Devices Through the Device Services CLI 14.5 Examples 14.5.1 General Information about the Examples 14.5.1.1 Used Protocol_Profile 14.5.1.2 DEComni Directory Services (ODS) 14.5.2 Example 1, Access to a Device through a Device Services Server Using the Device Services CLI 14.5.2.1 Creating Device Services Objects 14.5.2.2 Creating ODS Definitions 14.5.2.3 Running and Using the CLI 14.5.3 Example 2, Access to a Device through a Device Services Server Using the Data Services CLI 14.5.3.1 Creating Data Services Objects 14.5.3.2 Running and Using the CLI 14.5.4 Example 3, Direct Access to a Device Using the Device Services CLI 14.5.4.1 Creating PODB Definitions 14.5.4.2 Creating ODS Definitions 14.5.4.3 Running and Using the CLI 14.5.5 Specifying the Calling VMD 14.5.5.1 Specifying the Calling VMD for the Device Services Server 14.5.5.2 Specifying the Calling VMD for the CLI 15 Device Services Commands Reference ADD COMPONENTS POLLING_SET CREATE MESSAGE CREATE NAMED_VARIABLE CREATE POLLING_SET CREATE PROTOCOL_PROFILE CREATE UNNAMED_VARIABLE CREATE VMD CREATE VMD_EXTENSION_PARAM DISABLE POLLING_SET ENABLE POLLING_SET GET VALUE NAMED_VARIABLE GET VALUE UNNAMED_VARIABLE PUT VALUE NAMED_VARIABLE PUT VALUE UNNAMED_VARIABLE REMOVE COMPONENTS POLLING_SET SHOW MESSAGE SHOW NAMED_VARIABLE SHOW OBJECTS VMD SHOW POLLING_SET SHOW PROTOCOL_PROFILE SHOW UNNAMED_VARIABLE SHOW VMD SHOW VMD_EXTENSION_PARAM PART VII Application Services 16 Application Services Commands 16.1 Configuring Realm Application Components 16.2 Configuring Realm Application Components 16.2.1 Application Services Compliant Applications 16.2.2 Encapsulated Applications 16.2.3 BASEstar Open Supplied Servers 16.2.3.1 Configuring Data Services Servers 16.2.3.2 Configuring Event Services Servers 16.2.3.3 Configuring Packet Services Servers 16.2.3.4 Configuring Device Services Servers 16.2.3.5 Configuring Application Services Servers 16.3 Enabling and Disabling Nodes 16.4 Adding Nodes to and Removing Nodes from an Activity 16.5 Displaying the Values of Activities Attributes and Monitoring Status Changes 16.6 Operations on Actors 16.6.1 Execute 16.6.2 Terminate 16.6.3 Suspending the Component Activities 16.6.4 Resuming the Component Activities 16.7 Synchronization with Pending Service Requests 16.7.1 Returned Messages 16.8 Specifying Pathnames with Global Variables 17 Application Services Commands Reference ADD NODES ACTIVITY CREATE ACTIVITY CREATE ACTOR CREATE NODE CREATE PROGRAM DISABLE NODE ENABLE NODE EXECUTE ACTOR GET INFO ACTIVITY GET INFO ACTOR MOVE ACTOR REMOVE NODES ACTIVITY RESUME ACTOR SHOW ACTIVITY SHOW ACTOR SHOW CHILDREN ACTOR SHOW COMPONENTS ACTOR SHOW NODE SHOW PROGRAM SUSPEND ACTOR TERMINATE ACTOR WAIT PART VIII Appendixes A Mapping BASEstar Open Types EXAMPLES 8-1 Receiving Event Notifications 10-1 Sending a Packet Notification 10-2 Receiving a Packet Notification 10-3 Sending a Packet Notification with Reply Requested 10-4 Receiving and Handling a Packet Notification with Reply Requested 14-1 Creating PODB Definitions (Access to a Device through a Device Services Server from Device Services CLI) 14-2 Creating ODS Definitions (Access to a Device through the Device Services Server from Device Services CLI) 14-3 Creating PODB Definitions (Access to a Device through a Device Services Server from Data Services CLI) 14-4 Creating PODB Definitions (Direct Access to a Device from Device Services CLI) 14-5 Creating ODS Definitions (Direct Access to a Device from Device Services CLI) 14-6 Creating PODB Definitions (Direct Access to a Device from Device Services CLI) 14-7 Creating ODS Definitions (Calling VMD for the Device Services server) 14-8 Creating PODB Definitions (Calling VMD for the CLI Process) 14-9 Creating ODS Definitions (Calling VMD for the CLI Process) FIGURES 1-1 The BASEstar Open Command Language Interface 1-2 Requesting BASEstar Open Services through the CLI 1-3 BASEstar Open CLI and Databases 4-1 Snapshot Configurations 14-1 Example Summary 14-2 Access to a Device through a Device Services Server Using the Device Services CLI 14-3 Access to a Device through a Device Services Server Using the Data Services CLI 14-4 Direct Access to a Device from Device Services CLI TABLES 1 Documentation Conventions 2-1 Wildcard Characters 2-2 Command Editor Functions 2-3 Commands for Database Scope Management 2-4 Commands for Context Operations 4-1 Commands for Snapshot Operations 4-2 Application Services Commands 6-1 Commands for Operations on Realms 6-2 Common Services Commands 6-3 Common Services Commands and Corresponding Messages and Classes 6-4 Commands for Operations on Domains 6-5 Domain Commands and Corresponding Messages and Classes 6-6 BASEstar Open Datatypes and Legal Values 6-7 Commands for Operations on Structure_Datatypes and Array_Datatypes 6-8 Statistics Commands 6-9 Statistics Procedures and Corresponding Messages and Classes 7-1 Conditions for Deleting Objects or Object Definitions 7-2 Conditions for Modifying Objects Referred to by Another Object 8-1 Event Services Commands 8-2 Event Services Commands and their Corresponding Messages and Classes 10-1 Packet Services Commands 10-2 Packet Services Commands and their Corresponding Messages and Classes 12-1 Data Services Commands 12-2 Data Services Commands and their Corresponding Messages and Classes 14-1 Device Services Commands 14-2 Device Services Commands and their Corresponding Messages and Classes 16-1 Application Services Commands 16-2 Application Services Commands and their Corresponding Messages and Classes A-1 BASEstar Open to MMS Types