NAME

mirc − Managed Information Repository (MIR) Compiler utility component of the POLYCENTER Common Agent

SYNOPSIS

/usr/sbin/mirc [options] input_file [input_file ...]

Arguments

input_file
At least one input_file parameter must be specified on the mirc command line.  The input_file must be either a MIB specification file (file extension .mib) or an MSL file (file extension .ms).  Refer to the POLYCENTER Common Agent Managed Object Module Developer’s Guide for more information on input file types.  The mirc utility treats an input_file specification as a MIB file unless the input file specification ends in .ms, in which case it is treated as an MSL file.  Note that you must specify the Internet MOM management specification file (/usr/ccs/lib/eca/rfc1213.ms) when you first create a MIR File. 

For syntax help using mirc, enter the /usr/sbin/mirc command with no options or arguments specified on the command line. 

FLAGS

-oMIR_file
Create a MIR file with the file specification you give for MIR_file.  If the -o option is omitted entirely, then mirc creates a binary output datafile by default with the name "mir.dat" if no errors are encountered during compilation. 

-oThe -o option without a MIR File specification suppresses binary MIR file output (i.e., no MIR file is created).  This option performs diagnostic checking only. 

-d[debug_file_name]
Generate a symbolic dump upon error-free output.  You may optionally specify a debug_file_name file specification to store the symbolic dump output. 

-kkeyword
Specify a keyword for INCLUDE statements in MSL files.  Specifying the keyword allows the INCLUDE file to be compiled.  You may specify any number of these -k switches on the command line. 

-Iinclude_path
Specify an alternate path to a directory where include files can be found.  If the search for an include file in the current directory fails, the include_path is searched.  If more than one -I switch is specified on the mirc command line, the last -I switch specified is in effect for each input_file following that -I switch until another -I switch is encountered.  The -I switch may be embedded in a file_list file (see description of -f). 

-bMIR_file
Specify a single binary MIR file to be used as input. Only one binary MIR file may be specified with the -b switch per mirc command.  See the Entity-Class Definition-Ordering Rule section for more information. 

-ffile_list
Specify a file that contains a list of files to be used as input to mirc.  You may use more than one -f switch on the mirc command line.  Wildcards may not be used in the file_list file specification.  Use ’#’ or ’!’ characters to comment lines in the file_list file.  Specify only one filename per line in the file_list file.  You may also use the -I and -r switches in the file_list, one to a line. 

-rEntity_class_OID
Specify the Object Id (OID) of an entity class (and its children) to be removed.  There should be no spaces between the -r switch and the Entity_class_OID Object Id.  The arcs of the Entity_class_OID may be separated by a ’.’ or by a blank.  This switch may be used within a file_list file (see -f). 

-mfilename
Specify an input file filename to be compiled in "merge" mode instead of "normal" mode.  In "merge" mode, the compiler ignores syntax in a "merge-mode" file that describes any MIR object that has already been compiled (either in a previously compiled input_file, or by way of a binary MIR file specified using the -b switch).  Only new definitions in the "merge" filename are merged into the compilation run. 

The definition of each CHILD Entity (supplied in an MSL or MIB file) must follow the definitions of all of its parent entities.  See the Entity-Class Definition-Ordering Rule section for more information. 

DESCRIPTION

The mirc utility is used to populate the POLYCENTER Common Agent’s Management Information Repository (MIR) with information about managed object classes, directives, notifications, and attributes.  The MIR is used by the SNMP protocol engine to decode and encode management requests.  The mirc utility takes this information from the MIB extensions and POLYCENTER Framework Management Specification Language (MSL) files you write for your managed objects. 

Entity-Class Definition-Ordering Rule

The mirc compiler requires that the definition of each CHILD Entity (supplied in an MSL or MIB file) must follow the definitions of all its parent entities. 

This implies all of the following:

       •One or more parent definitions may precede a CHILD entity definition inside one MSL or MIB file, in which case the CHILD entity definition will actually be nested inside the parent definitions in the file. 

       •The parent definitions may be contained in one or more MSL or MIB files processed by the compiler before the MSL or MIB file containing the CHILD entity is processed. 

       •The parent definitions may be contained in the input binary MIR database file (specified with the -b switch). 

       •Parent definitions may be defined by any combination of the above three methods. 

       •If no input binary MIR database file is specified, then the first file supplied MUST be an MSL or MIB file for a global entity.  All succeeding filenames supplied must be for child entities of the global entity or must define another global entity. 

EXAMPLES

The following example compiles two global entities (global0.ms and global1.mib) and their child entities into one MIR output file named mir.dat (named by default). 

# /usr/sbin/mirc global0.ms  ∗0.ms  global1.mib  ∗1.ms

The following example compiles global entity MSL file global.ms into output file mir.dat (named by default) and produces a symbolic dump in file mir.dmp (named by derivation and triggered by -d). 

# /usr/sbin/mirc -d global.ms

The following example compiles global entity MSL file global1.ms into output file msl1.dat (named explicitly) and produces a symbolic dump in file msl1.dmp (named by derivation). 

# /usr/sbin/mirc -omsl1.dat -d global1.ms

The following example compiles global entity MSL file node.ms and all the child entity files into output file dna.dat (named explicitly) with symbolic dump in dna.dmp (named by derivation). 

# /usr/sbin/mirc -d -odna.dat node.ms ∗.ms

The following example compiles global entity MSL file node.ms and all the child entity files.  Only diagnostics are produced to stderr since the output file creation is suppressed. 

# /usr/sbin/mirc -o node.ms child∗.ms

The following example reads in the existing binary MIR database file oldmir.dat and then compiles ascii.ms.  The output file mir.dat (named by default) receives the contents of oldmir.dat along with that of ascii.ms.  Any INCLUDE files specified within the body of ascii.ms will be sought first in the current working directory and failing that in the place specified by prepending the string /usr/include/ to the front of the Include file name.  Note that the trailing backslash (/) must be specified.  The -d switch causes the creation of a symbolic dump, directed to file mir.dmp (named by derivation). 

# /usr/sbin/mirc -d -boldmir.dat -I/usr/include/ ascii.ms

The following example reads in the existing binary MIR database file oldmir.dat and then compiles ascii0.ms while searching for INCLUDE files in directory /usr/include/.  The INCLUDE directory is then switched to /usr/header/ and ascii1.ms is compiled.  Binary output is produced to mir.dat, no symbolic dump is produced. 

# /usr/sbin/mirc -boldmir.dat -I/usr/include/ ascii0.ms -I/usr/header/ \
ascii1.ms

The following example accomplishes the same result as the previous example but through the use of a file_list file. 

# /usr/sbin/mirc -boldmir.dat -fmsl.list

For this example the msl.list contains the following:

#
# File List file "msl.list"           --comments
#
! Specify current INCLUDE directory   --more comments
-I/usr/include/
! Specify ASCII MSL file to compile
ascii0.ms
! Switch INCLUDE directory to new place
-I/usr/header/
! Specify the last ASCII MSL file to compile
ascii1.ms

The following example reads in the existing binary MIR database file oldmir.dat and removes the three Entity-Classes specified by OID using the -r switch.  The binary output is generated to mir.dat (named by default) and contains whatever remains from oldmir.dat after the Entity-Classes have been removed. 

# /usr/sbin/mirc -boldmir.dat -fremove.list

For this example remove.list contains the following:

#
# Removal specified for the following Entity-Classes:
#
-r1.3.12.2.1011.2.1.1
-r1.3.12.2.1011.2.2.1.4.0.126.0
-r1.3.12.2.1011.2.2.1.126.1

RELATED INFORMATION

Commands: mtu(8), snmpsetup(8)

Daemons: fddi_mom(8), internet_mom(8), mold(8), snmp_pe(8), trn_mom(8)

A Simple Network Management Protocol (RFC 1157)