3—Program Descriptions

3 Program Descriptions
This section describes how to operate the programs and shell scripts that are
part of OPNET Modeler. The documentation describes the external interface of
the programs, including the preferences that the programs accept.

The following programs are described:

• op_binin on page EI-3-3

• op_clrtmp on page EI-3-4

• op_comptype on page EI-3-5

• op_cvanim on page EI-3-6

• op_cvos on page EI-3-9

• op_cvov on page EI-3-12

• op_flse on page EI-3-18

• op_install on page EI-3-19

• op_license_manager on page EI-3-21

• op_license_server on page EI-3-22

• op_license_util on page EI-3-23

• op_manfile on page EI-3-25

• op_mkema on page EI-3-35

• op_mko on page EI-3-38

• op_mksim on page EI-3-42

• op_mkso on page EI-3-45

• op_runsim on page EI-3-51

• op_sim_restart on page EI-3-78

• op_ver on page EI-3-79

• op_vuerr on page EI-3-80

• op_xml_export on page EI-3-84

• op_xml_import on page EI-3-86

• opnet on page EI-3-88

OPNET Modeler/Release 16.1 EI-3-1

3—Program Descriptions

For use of the main OPNET Modeler program (modeler), see Modeling
Concepts and Editors Reference.

EI-3-2 OPNET Modeler/Release 16.1

 3—Program Descriptions

op_binin
Program that adds trace information to model code.

Description
op_binin pre-processes C source code developed as part of a model, and adds
useful trace information. This trace information can be seen as part of the error
trace generated by op_vuerr. By default, all compilation that takes place within
opnet, op_mksim, op_runsim, or via op_mko, will include this extra trace
information. To compile without the extra trace information, set the
comp_trace_info preference to FALSE. op_binin is not intended to be a
stand-alone utility, and should only be invoked by OPNET Modeler.

Preferences
None

OPNET Modeler/Release 16.1 EI-3-3

3—Program Descriptions

op_clrtmp
The op_clrtmp shell script and op_clrtmp.bat batch file remove all files from the
temporary file directory in your administration directory
(<HOME>/op_admin/tmp).

Description
Several OPNET Modeler programs generate temporary files in the course of
executing. These files are stored in the temporary file directory
<HOME>/op_admin/tmp, as described in Chapter 1 System Environment on
page EI-1-1). Some temporary files are removed as soon as the program that
created them completes execution. Other temporary files remain in this
directory until they are explicitly removed.

After many invocations of OPNET Modeler programs or many print operations,

the temporary file directory can grow large, containing many files. When this
occurs, all directory files can be removed via the Linux command rm *.
However, issuing this command is risky, because it does not verify that the user
is actually in the proper directory. Thus, an incorrect assumption about which
directory is current can lead to accidental removal of valuable files.

A more reliable way to remove the files in the temporary directory is provided by
the op_clrtmp shell script (Linux) and op_clrtmp.bat batch file (Windows). These
utilities can be invoked from any directory and will remove all the files from
<HOME>/op_admin/tmp, without risk of removing files in any other directory.

Preferences
The op_clrtmp and op_clrtmp.bat utilities use no preferences.

Example Usage

% ls <HOME>/op_admin/tmp
prtdoc.268.0.ps prtdoc.5170.1.ps prgfx.23542.0.ps
prtdoc.268.1.ps prrep.136.0.ps prgfx.23570.0.ps
prtdoc.268.2.ps prgfx.136.1.ps ptc_29273.0
prtdoc.5170.0.ps ndgfx.136.2.ps

% op_clrtmp

% ls <HOME>/op_admin/tmp

EI-3-4 OPNET Modeler/Release 16.1

 3—Program Descriptions

op_comptype
A utility used by the installation scripts that prints out a string describing the host
environment, including the host computer manufacturer, CPU architecture, and
operating system.

Description
Several C Shell scripts execute different commands depending on the type of
workstation on which they are running. In order for these scripts to distinguish
the type of the host workstation, they use the op_comptype program. This
program prints out a string that describes the host environment, with the format
shown below:
Host Environment String Format

<manufacturer>_<architecture>_<OS>

The possible printed output values include:

• pc_intel_win32

• pc_amd_win64

• pc_intel_linux

• pc_intel_linux64

The op_comptype program will almost never be executed directly, except

perhaps in situations where a user has logged into a remote workstation of
unknown type and wants to determine the type.

Preferences
No preferences are supported by op_comptype.

Example Usage

% op_comptype
pc_intel_linux%

Note—Note in the above example that the output of this program is a single
word that is not delimited by a newline character. This has the effect of causing
the next C Shell prompt to be concatenated to the end of the output.

OPNET Modeler/Release 16.1 EI-3-5

3—Program Descriptions

op_cvanim
A utility that performs conversion between animation script and history files.

Description
Animations created by simulations are stored in animation history files (file type
suffix “.ah”), which encode animation requests in binary form. Sometimes it is
useful to analyze or modify the exact sequence of animation requests that have
been issued by a simulation. In this case, an animation script file (file type suffix
“.as”) is useful because it stores files in ASCII (i.e., editable) form. After editing,
animation script files are typically converted back into history files (also using
op_cvanim), because the animation viewer program (op_vuanim) can read the
files in binary form only.

Animation script files may contain literal constant values which represent
information specific to models and objects. These constants are associated with
animation requests generated via the KPs op_anim_ime_npath_traverse(),
op_anim_ime_nobj_update(), and op_anim_ime_nmod_draw(). See the
Discrete Event Simulation API for more information on these KPs.

EI-3-6 OPNET Modeler/Release 16.1

 3—Program Descriptions

The constant values are listed in the following tables:

Table 3-1 Object Types

Object Type Script Constant

subnet 0

node 1

simplex link 2

duplex link 3

bus link 4

tap 5

module 6

packet stream 7

statistic wire 8

process state 9

process transition 10

Table 3-2 Model Types

Model Type Script Constant

network 0

node 1

process 2

Preferences
This program supports the following preference sets:

• Standard Preferences

• Diagnostics preferences

• User Lock preferences

This program also supports the following additional preferences.

OPNET Modeler/Release 16.1 EI-3-7

3—Program Descriptions

m
Specifies the name of the animation to be converted. This preference may refer
to an animation history file or an animation script file, depending on the value of
the “reverse” preference. The animation name should not include the file type
suffix.

This preference is required.

Type string

Default Value “”

reverse
Specifies that the normal conversion performed by op_cvanim be reversed, so
that an animation script file is produced from an animation history file. If this
preference is disabled, normal conversion from an animation script file to an
animation history file will be performed.

Type boolean

Default Value FALSE

Example Usage
The following example uses op_cvanim and the example animation, my_anim
to demonstrate:

• converting an animation history file to a script file using the -reverse

command-line flag,

• editing the animation script via the Linux text editor, vi

• converting the animation script back to a history file.

% op_cvanim -m my_anim -reverse

% vi my_anim.as

% op_cvanim -m my_anim

EI-3-8 OPNET Modeler/Release 16.1

 3—Program Descriptions

op_cvos
A utility that converts the contents of a scalar output file (file type suffix .os) into
a user-editable ASCII text file; op_cvos can also perform the reverse
conversion.

Description
Prior to release 12.0, output scalar files were used to record and store scalar
statistic values from multiple simulations. The op_cvos utility program converts
an output scalar file to an ASCII format General Data File (GDF, file type suffix
.gdf), and vice versa. This allows users to manually extract data points from an
existing output scalar file, or insert new data points. Users are free to edit the
resulting ASCII version of the data in the GDF using a text editor or a
OPNET Modeler editing pad. Although op_cvos is typically used for patching
operations on output scalar files, it can also be used to obtain scalar data in
ASCII format for inclusion in reports.

The format of the generated GDF files, as well as an example of such a file,
appear on the next page. In the format, the term block corresponds to a single
simulation run. The scalar statistic values recorded during a particular
simulation run are grouped together in a common block. This example includes
two simulation runs of the model qnet.

Figure 3-1 op_cvos-Generated GDF Files

File Format File Example

total number of blocks: <#_blocks> total number of blocks: 2

BEGIN_BLOCK BEGIN_BLOCK
model: <network_name_1> model: qnet
seed: <seed_value> seed: 0
-------------------- --------------------
number of scalar records: <#_records> number of scalar records: 3
<stat_name_0>: <stat_val_0> traffic_irate: 0.1
<stat_name_1>: <stat_val_1> avg_delay: 45.102
<...continued scalar statistic values...> avg_qsize: 5.71
BEGIN_BLOCK BEGIN_BLOCK
model: <network_name_2> model: qnet
seed: <seed_value> seed: 0
-------------------- --------------------
number of scalar records: <#_records> number of scalar records: 3
<stat_name_0>: <stat_value_0> traffic_irate: 0.25
<stat_name_1>: <stat_value_1> avg_delay: 84.102
<...continued scalar statistic values...> avg_qsize: 9.2

<...continued blocks...> EOS

EOS

OPNET Modeler/Release 16.1 EI-3-9

3—Program Descriptions

Preferences
This program supports the following preference sets:

• Standard Preferences

• Diagnostics preferences

• User Lock preferences

This program also supports the following additional preferences.

from_text
Specifies that the reverse conversion of a General Data File (file type suffix
.gdf) into an output scalar file (file type suffix .os) is to be performed. The base
name of the GDF is specified via the m preference; the resulting output scalar
file name is based on this value. This preference is mutually exclusive with the
to_text preference (either from_text or to_text should be set to TRUE, but not
both).

Type boolean

Default Value FALSE

m
Specifies the base name of the file to be converted (either an output scalar file
or a GDF). The file path or file type suffix should not be included in the value of
this preference. If the to_text preference is set to TRUE, the m preference
specifies the name of the output scalar file that is to be converted to a GDF. If
the from_text preference is set to TRUE, the m preference specifies the name
of the GDF that is to be converted to an output scalar file.

This preference is required and can be entered only from the command line.

Type string

Default Value none

EI-3-10 OPNET Modeler/Release 16.1

 3—Program Descriptions

sort_key
Specifies the name of a scalar statistic within the input file (either an output
scalar file, or a GDF, depending on the direction of conversion). The specified
statistic will be used as the sort key for the generated output file. Blocks
(simulation runs) will be arranged in order of ascending values of the
sort_key-identified statistic.

Type string

Default Value “”

to_text
Specifies that the forward conversion of an output scalar file (file type suffix .os)
into a General Data File (file type suffix .gdf) is to be performed. The name of
the scalar output file is specified via the m preference; the resulting GDF name
is based on this value. This preference is mutually exclusive with the from_text
preference (either from_text or to_text should be set to TRUE, but not both).

Type boolean

Default Value FALSE

Example Usage

% op_cvos -to_text -m gmc_net

Reading Input File
Converting...
Writing Output File
Done.

This example converts the scalar file, gmc_net, to an editable ASCII file. The
new file will appear in the models directory as gmc_net.gdf.

OPNET Modeler/Release 16.1 EI-3-11

3—Program Descriptions

op_cvov
A utility that extracts scalar and vector information from an output vector file (file
type suffix .ov) into a tab-delimited text file (.csv) so that it can be imported into
a spreadsheet and analyzed.

Description
Exporting data from the Results Browser might be inconvenient when dealing
with a very large number of vectors. You can use op_cvov to extract selected
information from one or more output vector files. For example, you can

• Get a list of all the vectors “names” (list of hierarchical names, possibly
restricted by some regular expression)

• Extract data for selected vectors (based on a list of vector names)

• Extract scalar data

Preferences
This program supports the following preference sets:

• Standard Preferences

• Development preferences

• Diagnostics preferences

• User Lock preferences

This program also supports the following additional preferences.

data_precision
Specifies the maximum number of decimal digits for data values.

Type integer

Default Value 12

m
Specifies a list of files to extract statistics from. Files can be specified in three
ways:

• “<project-scenario>-DES-<run#>” refers to a specific output file

• “<project-scenario>” refers to all output files for that scenario

• “<project>” refers to all output files for all scenarios in that project

EI-3-12 OPNET Modeler/Release 16.1

 3—Program Descriptions

This preference is required and can be entered only from the command line.

Type string list

Default Value <empty>

nosymbols
Specifies whether symbolic values should be used in the output. When TRUE,
symbolic values will not be used when a numerical value is available.

Type boolean

Default Value FALSE

output_file_path
Specifies the name of the output file for output data (tab-separated). The file
path and file type suffix must be included in the value of this preference. This
preference is required and can be entered only from the command line.

Type string

Default Value none

scalar
Specifies whether scalar information should be extracted from the specified
files. When TRUE, scalar information is extracted. This preference can be
entered only from the command line.

Type boolean

Default Value FALSE

thousand_separator
Specifies whether the thousands separator for the current locale should be
included in numbers. When TRUE, the thousands separator is included.

Type boolean

Default Value FALSE

OPNET Modeler/Release 16.1 EI-3-13

3—Program Descriptions

time_precision
Specifies the maximum number of decimal digits for time values.

Type integer

Default Value 12

vector_data
Specifies whether vector information should be extracted from the specified
files. When TRUE, vector information is extracted. This preference can be
entered only from the command line.

Type boolean

Default Value FALSE

vector_data_format
Specifies which data rows to generate for each statistic before the time/data
portion of the output. The rows are generated in the order of the characters in
the string. The string value for this preference uses the following characters:

• H – hierarchical name

• O – object name

• S – statistic name

• R – report

• F – file name

• d – date

• h – hour/min/sec

• a – annotation

• # – number of elements

Type string

Default Value “HOSRFdha#”

EI-3-14 OPNET Modeler/Release 16.1

 3—Program Descriptions

vector_header
Specifies whether vector header information should be extracted from the
specified files. When TRUE, vector header information is extracted. This
preference can be entered only from the command line.

Type boolean

Default Value FALSE

vector_header_format
Specifies which data columns to generate for each statistic header entry after
the file name. The columns are generated in the order of the characters in the
string. The string value for this preference uses the following characters:

• ‘ ’ – (space or tab): extra column

• H – hierarchical name

• O – object name

• S – statistic name

• R – report

• F – file name (required to display the following elements)

• d – date

• h – hour/min/sec

• a – annotation

• # – number of elements

• t – min time

• T – max time

• m – min value

• M – max value

• [ – first value

• ] – last value

• e – expected value

• - – sample mean

• v – variance

• s – standarddev

OPNET Modeler/Release 16.1 EI-3-15

3—Program Descriptions

H, O, S, R information is only printed for the first file.

Type string

Default Value “HOSRFdha#tTnM[]e-vs”

vector_max_time
Specifies the maximum simulation time for reporting data. Statistic data
generated after this time is not extracted from the output vector file. Negative
values indicate the end-of-simulation time. This preference can be entered only
from the command line.

Type double

Default Value –1

vector_min_time
Specifies the minimum simulation time for reporting data. Statistic data
generated before this time is not extracted from the output vector file. This
preference can be entered only from the command line.

Type double

Default Value 0

vector_patterns
Restricts the vector output to statistics that match one of the specified
hierarchical patterns. The patterns can contain the following tokens:

• * – can be used to represent any item in the full hierarchical name

• … – can be placed at the beginning or end of a pattern to indicate,

respectively, any prefix or suffix to the rest of the pattern

This preference is required and can be entered only from the command line.

Type string list

Default Value “”

EI-3-16 OPNET Modeler/Release 16.1

 3—Program Descriptions

verbose
Specifies whether op_cvov should generate progress information as it runs.
When TRUE, progress information is generated. This preference can be
entered only from the command line.

Type boolean

Default Value FALSE

Example Usage
Example of output for a scenario with 4 runs (just one statistic from the group):

% op_cvov -output_file_path /home/abc/mydata.txt -vector_header -vector_data -m

s89050-modeling_approach_purely_micro_simulation

Hierarchical Name Annotation Statistic Report File Start Date Start Time Annotation # elements Min Time Max Time
Max Val 1st Val Last Val Expected Value Sample Mean Variance Standard Deviation
Dallas <-> Atlanta [0].point-to-point.queuing delay (sec) --> Dallas <-> Atlanta [0] --> point-to-point.queuing
delay (sec) s89050-modeling_approach_purely_micro_simulation-DES-1 101 0 1500 0.000008179012 0.000005709877
0.000003858025 0.000003900892 0.000003900892 0 0.000000504719
s89050-modeling_approach_purely_micro_simulation-DES-2 101 0 1500 0.000008179012 0.000005709877 0.000003858025
0.000003900892 0.000003900892 0 0.000000504719
s89050-modeling_approach_purely_micro_simulation-DES-3 101 0 1500 0.000008179012 0.000005709877 0.000003858025
0.000003900892 0.000003900892 0 0.000000504719
s89050-modeling_approach_purely_micro_simulation-DES-4 101 0 1500 0.000008179012 0.000005709877 0.000003858025
0.000003900892 0.000003900892 0 0.000000504719
...

Hierarchical name Dallas <-> Atlanta [0].point-to-point.queuing delay (sec) -->

Object Dallas <-> Atlanta [0] -->
Statistic point-to-point.queuing delay (sec)
Report
File s89050-modeling_approach_purely_micro_simulation-DES-4
s89050-modeling_approach_purely_micro_simulation-DES-4 s89050-modeling_approach_purely_micro_simulation-DES-4
s89050-modeling_approach_purely_micro_simulation-DES-4
Start date unspecified unspecified unspecified unspecified
Start time unspecified unspecified unspecified unspecified
Annotation
Number of values 101 101 101 101
Sim time Value Value Value Value
0 0.000005709877 0.000005709877 0.000005709877 0.000005709877
15 0.000008179012 0.000008179012 0.000008179012 0.000008179012
30 0.000003858025 0.000003858025 0.000003858025 0.000003858025
45 0.000003858025 0.000003858025 0.000003858025 0.000003858025
60 0.000003858025 0.000003858025 0.000003858025 0.000003858025

...
1485 0.000003858025 0.000003858025 0.000003858025 0.000003858025
1500 Vector end Vector end Vector end Vector end

OPNET Modeler/Release 16.1 EI-3-17

3—Program Descriptions

op_flse
A program that is executed as a background process by license-controlled
applications, op_flse releases licenses back to op_license_server upon exit of
the applications.

Description
The op_flse program is executed as a background process by all licensed
applications. It is the component of the licensing system that is responsible for
releasing licenses back to the License Manager. The op_flse program releases
licenses and not the applications themselves because the applications may
occasionally exit in uncontrolled circumstances, and so lock up a license.

A license represents the right to use the application for one session. The status
of licenses is stored within the license file, stored in the following paths:

• Windows: <primary_hard_drive>:\OPNET_license

• Linux: /opt/OPNET_license

For more information, see Chapter 3 Licensing on page AG-3-1.

When a licensed application exits, the corresponding op_flse process running

in the background detects the application process’s death and sends a
message to op_license_server indicating that the application’s license is now
free. Upon receipt, op_license_server changes the status of the license,
allowing it to be reissued.

The op_flse program is not intended for direct execution by users.

Note—Do not kill op_flse processes. If you do, the associated licenses are
never returned to op_license_server.

Preferences
This program supports the following preference sets:

• Standard Preferences

• Diagnostics preferences

The unique preferences of this program are not documented, because they are
only for use by licensed applications.

EI-3-18 OPNET Modeler/Release 16.1

 3—Program Descriptions

op_install
Provides a method for automating installation.

Description
op_install is a script that guides you through the installation process. It should
be run from the installation CDs.

Procedure
For detailed instructions, refer to the installation sheets that came with the CDs
or the technical support area of the OPNET Technologies web site.

Preferences
None, because this is a C Shell script.

Example Usage

% op_install
------------------------------------------
op_install: Program installation script
------------------------------------------

--> Select installation starting point:

-----------------------------------------
1) Download files from cd
2) Configure Floating License System
3) Start Floating License Supervisor
4) Register permits to run applications
5) none (or type "quit")
-----------------------------------------

Installation start [1-6]]> 3

--------------------------------------
op_install: FL Supervisor start-up
--------------------------------------

--> This section of op_install will start up the FL Supervisor.

The communication port (port_a, port_b or port_c) for the
FL Supervisor is not set. If port is known, then enter
the value below. Otherwise, enter "quit" and run the FL
Manager program (op_license_util) to determine on what host
and port the FL Supervisor should be running.

Select the FL Supervisor’s port:

FL Supervisor port [port_a, port_b, port_c (or "quit")]> port_a

The FL Supervisor will run on host "solar2" and port_a.

Start FL Supervisor? [yes, no]> yes

----------------------------------------------
op_install: end of FL Supervisor start-up
----------------------------------------------

--> Continue to next step?

Register Permits [yes, no]> no

--------------------------------------

OPNET Modeler/Release 16.1 EI-3-19

3—Program Descriptions

op_install: installation complete

--------------------------------------

Delete installation script and temporary archive files? [yes, no]> yes
-----------------------------
op_install: end of script
-----------------------------

EI-3-20 OPNET Modeler/Release 16.1

 3—Program Descriptions

op_license_manager
Opens opnet in the manage license mode.

Description
When opnet opens in the manage license mode, it does not use a license, but
offers limited functionality. You can perform license management tasks, but no
other operations. The mode is useful for a few reasons:

• You can perform license management tasks without depriving others of a

license.

• You can reliably delete a particular license. If you launch opnet and then
open the License Manager, you may find that the license you have been
allocated is the one you wished to delete. You cannot delete an in-use
license.

You can also open opnet in this mode by launching it with the manage_licenses
preference.

Preferences
None; this is a C-Shell script.

OPNET Modeler/Release 16.1 EI-3-21

3—Program Descriptions

op_license_server
A program that runs as a service (on Windows platforms) or as a daemon
process (on Linux platforms), issuing licenses to licensed applications. A
daemon process is one that executes continuously without being attached to a
user shell.

op_license_server manages the allocation of licenses. See License Manager on

page AG-3-9.

EI-3-22 OPNET Modeler/Release 16.1

 3—Program Descriptions

op_license_util
A utility that performs management operations for license servers.

op_license_util supports the following single-operation modes. These are

specified by invoking op_license_util with the corresponding preferences, as
listed below.

• Check the status of a server’s ports (-port_check)

• Kill a license server (-license_server_kill)

Preferences
This program supports the following preference sets:

• Standard Preferences

• Diagnostics preferences

• Licensing Preferences

This program also supports the following additional preferences.

license_server_kill
Specifies that the license server process be killed. This operation sends a
message to the license server, causing it to log its status just before exiting. This
operation prevents op_license_util from presenting an interactive user interface.
Only a user account that has write permissions on the license file can perform
this operation. The values of the preferences -license_server and license_port
are used to determine the location of the license server process. If these
attributes are not set, the license file is checked for the location of the license
server.

This preference can be entered only from the command line.

Type boolean

Default Value FALSE

portchk
Specifies that the status of the three UDP/IP ports potentially used by the
licensing system be checked for availability on the local host computer. A list of
the three ports and their statuses is printed on the standard output device.

This operation prevents op_license_util from presenting an interactive user

interface.

OPNET Modeler/Release 16.1 EI-3-23

3—Program Descriptions

This preference can be entered only from the command line.

Type boolean

Default Value FALSE

session_id
Specifies that the opnet session ID be printed to the standard output device. The
session ID is a time-varying value that provides installation reference
information to Technical Support.

This preference can be entered only from the command line.

Type boolean

Default Value FALSE

Example Usage

% op_license_util -port_check

The status of the ports on "titan"

usable for the license server:
port_a: unavailable
port_b: available
port_c: available

% op_license_util -license_server_kill TRUE -license_server unreliable -license_port

port_b
%

EI-3-24 OPNET Modeler/Release 16.1

 3—Program Descriptions

op_manfile
A utility that performs management operations related to the tracking and
identification of model files, including file location, locks, security
protection/registration, and header contents.

Description
The op_manfile program provides a number of operations for viewing and
modifying the file header and comments of a model file, in addition to operations
related to locating files.

Model files have three portions: (1) a file header; (2) file comments; (3) model
data. The header portion of model files contains tracking and identification
information for the file, such as the time at which the file was created. The
comment portion of model files contains user-entered text descriptions of the
file’s data contents and modification history. Model-derived object code files
also contain embedded, non-modifiable file headers.

The header portion of model files contains the following information about the
file:

• model type

• creation time and date

• name and release of the creating OPNET application

• earliest release of the creating OPNET application that is compatible with the
file’s format

• last modification time and date

• version number of the file (i.e., the number of times the file has been written
to disk)

• user account name and host computer name associated with the last
modification

• status of the file’s edit lock (edit locks are automatically set by OPNET
applications that are editing a model file, to prevent concurrent editing of the
same file)

• status of the file’s user lock (user locks are manually set by users to indicate
temporary ownership and prevent other users from modifying the model
during a development phase)

• model security access information (status, number of registered sites,

access level of the local site, and world access status)

• model suite information (suite name and description, often including the
model vendor’s name and contact information)

OPNET Modeler/Release 16.1 EI-3-25

3—Program Descriptions

The above information can be very useful in establishing the background

information of a model file. OPNET applications that manipulate model files can
modify the above information, but the only way to view the above information is
via op_manfile.

The op_manfile program provides the following operations; each operation is

specified by the preference indicated within parentheses. Only one operation
can be performed per op_manfile session.

• find one or more models based on the file base name (-find)

• print the file header (-header_print)

• repair the file header (-header_repair)

• update the file header (-header_update)

• set the file version number (-version_set)

• add comments to a file (-comments_add)

• delete comments from a file (-comments_del)

• print file comments (-comments_print)

• set or release the edit lock (-edit_lock and -edit_unlock,

respectively)

• set or release the user lock (-user_lock and -user_unlock,

respectively)

• display a file’s checksums (-checksum)

• protect a model from unauthorized use (-protect)

• register a model to gain or grant access (-register)

All op_manfile operations require a least one target model file, to which they are
applied (some operations can support multiple target files). The target model file
of op_manfile is specified by one of several preferences, including m, mf, and f.
Some commands (such as register) also take an optional source model file,
which is specified by the preferences from, from_f, or from_mf.

EI-3-26 OPNET Modeler/Release 16.1

 3—Program Descriptions

Preferences
This program supports the following preference sets:

• Standard Preferencess

• Diagnostics preferences

• Licensing Preferences

• User Lock preferences

This program also supports the following additional preferences.

all
Specifies that the selected operation be expanded in its scope, in an
operation-specific manner. This flag serves as a operation modifier and can be
used in conjunction with the following operations: -edit_lock, -edit_unlock, -find,
-header_print, -user_lock, and -user_unlock.

For a lock-related operation, the -all modifier causes the operation to be applied
to all model files located in the model directories (i.e., specific files do not need
to be specified by the f, m, or mf preferences).

For the -find operation, the -all modifier causes all models with duplicate names
in different model directories to be found (normally a model found in a
higher-precedence model directory will override and effectively hide duplicate
models found in lower-precedence model directories).

For the -print_header operation, the -all modifier causes the printing of multiple
headers present within a file, instead of just the first header in the file (only
simulations can contain multiple headers, due to the headers associated with
each model-derived object code module in the simulation file).

Type boolean

Default Value FALSE

app_name
Specifies the name of the application identified in the target file header as the
creator of the file. This preference’s value is used by op_manfile when a file
header is created by the -header_add operation, or when a file header is
updated by the -header_update operation.

Type string

Default Value “”

OPNET Modeler/Release 16.1 EI-3-27

3—Program Descriptions

backup_max_count
Specifies the maximum quantity of numbered version backups kept for a given
file. Each time you save a model with the same name, the overwritten file is
stored in your op_admin/bk directory with a name of the form:
<model_name>.v<vers_num>.<mdl_type>.m. The most recent file versions are
kept; when the maximum count of backups would be exceeded by a new
version, the earliest version is removed from the bk directory.

Type integer

Default Value 10

checksum
Specifies that the checksum numbers of the target file be computed and printed.
This operation can be applied to any type of file via the f preference, including
program executables. The output of the operation is two integer checksum
numbers, identified as “Add” and “Xor” because of their respective computation
methods. File checksum numbers are used to determine whether a release file
has been corrupted. Users must contact technical support to compare their
checksum values with the expected values.

Type boolean

Default Value FALSE

comments_add
Specifies that a single comment be added to the target file. The text of the
comment is entered by the user after a prompt that appears on the standard
output device. Comments are limited to one line of text; pressing the <Return>
key completes the comment. Comments are tagged with the date, user account
name, and file version associated with their addition to the file.

Type boolean

Default Value FALSE

comments_del
Specifies that all comments contained in the target file be deleted.

Type boolean

Default Value FALSE

EI-3-28 OPNET Modeler/Release 16.1

 3—Program Descriptions

comments_print
Specifies that all comments contained in the target file be printed to the standard
output device. Each comment is separated by a line of underscores, and is
tagged with the date, user account name, and file version number associated
with the comment’s addition to the file.

Type boolean

Default Value FALSE

dir
Specifies that the requested security protection be applied to all files in the
current directory. This argument is used by the author with the protect
argument.

Type boolean

Default Value FALSE

edit_lock
Specifies that the target file’s edit lock be set, as if the file were being edited by
the OPNET program. This tags the files as “read-only” and prevents all OPNET
programs from modifying it. This operation is not typically used; instead, a user
may temporarily lock a file using the -user_lock operation.

Type boolean

Default Value FALSE

edit_unlock
Specifies that the target file’s edit lock be reset, thus allowing modification by
OPNET programs. If the OPNET program exits abnormally due to a program
abort, files that were being edited by the program may retain edit locks. This
situation can be rectified by the -edit_unlock operation.

Type boolean

Default Value FALSE

OPNET Modeler/Release 16.1 EI-3-29

3—Program Descriptions

f
Specifies the full name and path of the target file on which operations will be
performed. The file names must include file type suffixes, and absolute or
relative paths.

Type string

Default Value “”

find
Specifies that the target file(s) be found within the model directories, and
information on their location be printed on the standard output device. This
operation does not request the selection of a single target file if multiple model
files match a base name specified by the m preference, and it locates all model
files that satisfy the target name. This operation is not compatible with the f
preference. The location information includes the target file’s names (with
suffix), types, and model directories.

Type boolean

Default Value FALSE

from
Specifies the base name of the source model from which to copy protection
information (that is, the model name without the file suffix or path). The
op_manfile program locates the specified model file in the model directories. If
more than one model file is found with this base name and the specified
operation requires a single source file, op_manfile will request the selection of
a single file from a menu of options printed on the standard output device.

Type string

Default Value “”

from_f
Specifies the full name and path of the source model from which to copy
protection information. The file name must include file suffix and absolute or
relative path.

Type string

Default Value “”

EI-3-30 OPNET Modeler/Release 16.1

 3—Program Descriptions

from_mf
Specifies the full name and file suffix of the source model from which to copy
protection information. The file name should not include a path (the specified
model file will be located in the model directories).

Type string

Default Value “”

header_add
Specifies that header information be added to the target file. This operation is
rarely used.

Type boolean

Default Value FALSE

header_print
Specifies that the header information of the target file be printed on the standard
output device. The header information is printed in a tabular format.

Type boolean

Default Value FALSE

header_repair
Specifies that the header information of the target file be repaired. If the OPNET
program issues an error message indicating that a model file is corrupted, this
operation may be able to repair the damage if it is limited to the header.

Type boolean

Default Value FALSE

OPNET Modeler/Release 16.1 EI-3-31

3—Program Descriptions

header_update
Specifies that the header information of the target file be updated. An update
modifies all of the “last modification” fields of the header, including date, version
number, user account name, and host computer name. The creating application
name is also modified if the app_name preference is set.

Type boolean

Default Value FALSE

m
Specifies the base name of the target files on which operations will be
performed (i.e., the model name without the file type suffix or path). The
specified model file(s) are located in the model directories. If more than one
model file is found with this base name, and the specified operation requires a
single target file, op_manfile will request the selection of a single target file from
a menu of options printed on the standard output device.

Type string

Default Value “”

mf
Specifies the full name of the target file on which operations will be performed
(i.e., the model name with file type suffix). The file name should not include a
path; the specified model file is located in the model directories.

Type string

Default Value “”

protect
Protects a model file from unauthorized access. The author specifies the pass
phrase used as the encryption key. For more information see
Chapter 4 Security on page EI-4-1.

Type boolean

Default Value FALSE

EI-3-32 OPNET Modeler/Release 16.1

 3—Program Descriptions

register
Registers a protected model file. Registration allows access to the model by
users at a specified site (OPNET installation). For more information see
Chapter 4 Security on page EI-4-1.

Type boolean

Default Value FALSE

suite
Specifies that all model files in the same suite as the specified model should be
registered. The suite preference must be used with the register preference.

Type boolean

Default Value FALSE

user_lock
Specifies that the target file’s user lock be set. This tags the file as belonging to
the user account that set the lock, and prevents OPNET programs being run by
other user accounts from modifying the file.

Type boolean

Default Value FALSE

user_unlock
Specifies that the target file’s user lock be reset, thus allowing modification by
OPNET programs run by any user account.

Type boolean

Default Value FALSE

version_set
Specifies that the target file’s version number be set to the specified integer
value (the default value of -1 specifies that no change be made). This operation
allows the version number of a file to a correlated to user-defined sequence.

Type integer

Default Value -1

OPNET Modeler/Release 16.1 EI-3-33

3—Program Descriptions

world
Specifies that the model file be registered so that anyone can access it. This
argument is used by the author and with the register argument.

Type boolean

Default Value FALSE

Example Usage
The following example illustrates using the op_manfile program to print out
header information for a process model named “atm16_crossconn”.
User-entered information is shown in bold typeface.

% op_manfile -m atm16_crossconn -header_print

|-------------------------------------------------------------------|
|file path : /opnet/10.0.A/models/std/atm/atm16_crossconn.nd.d |
|-------------------------------------------------------------------|
|file type : Derived Node Model |
|-------------------------------------------------------------------|
|creation |
| date : Wed Feb 28 14:11:09 1996 |
| application : op_cvdlb2 |
| release : 10.0.A |
| file data v. : 8.5.A |
|-------------------------------------------------------------------|
|last modification |
| date : Sun Jun 15 19:40:01 2003 |
| version : 25 |
| user : opnet |
| host : bhornet |
|-------------------------------------------------------------------|
|edit lock |
| status : unlocked |
|-------------------------------------------------------------------|
|user lock |
| status : unlocked |
|-------------------------------------------------------------------|
|security |
| status : not protected |
|-------------------------------------------------------------------|
|suite info : (none available) |
|-------------------------------------------------------------------|

For examples of protecting and registering models, see Chapter 4 Security on

page EI-4-1.

EI-3-34 OPNET Modeler/Release 16.1

 3—Program Descriptions

op_mkema
A utility that compiles and links an application program that invokes functions
from the External Model Access (EMA) library.

Description
EMA is a library of procedures, supplied with the OPNET release, which are
useful for creating or querying models from an external program (EMA is
described in detail later in this manual). EMA-based applications are programs
which make calls to the EMA library in order to access models. For proper
construction of such applications, the following are required: (1) the application
C code must be compiled with access to EMA-related header files (that is,
opnet.h, ema.h, opnet_emadefs.h, and opnet_constants.h, contained in
<reldir>/sys/include); (2) the compiled form of the application must be
linked with the EMA library (which is named
<reldir>/sys/<arch>/lib/libm3ema.so). The op_mkema utility is
provided to conveniently prepare EMA applications so that they meet these
requirements.

The op_mkema utility is passed the name of an EMA application without the file
type suffix, and it performs the following tasks:

• adds the .em.c file type suffix to the name and locates the file in the model
directories

• compiles the application’s C file into an object code file, with the file type
suffix .em.o

• links the generated object code file with the EMA library, thereby producing
a complete program executable with the file type suffix .em.x

This process of compilation and linking is presented with greater detail in

External Model Access on page MFA-1-1.

op_mkema only compiles one C code file of an application, but additional object
code files or libraries can be linked into the application executable by
referencing them in the bind_libs preference. op_mkema can be conveniently
used in a makefile context.

Note—To use External Model Access in Windows, you must ensure that
<reldir>/sys/pc_intel_win32/bin is the first directory listed in your
PATH environment.

OPNET Modeler/Release 16.1 EI-3-35

3—Program Descriptions

Preferences
This program supports the following preference sets:

• Standard Preferences

• Diagnostics preferences (except diag_enable and rec_err_suppress)

• Development preferences

This program also supports the following additional preferences.

m
Specifies the base name of the Ema application to be compiled and linked. The
file path or file type suffix should not be included in the value of this preference.
The specified Ema-based application source code file must be located in the
model directories.

This preference is required and can be entered only from the command line.

Type string

Default Value none

num_err
Specifies the maximum number of error and/or warning messages to display on
standard output. op_mkema enters any error or warning messages in the log
files cc_err (compilation messages) and bind_err (linking messages),
which are located in your op_admin/tmp directory. This preference provides a
mechanism for viewing any messages generated by the current operation.

This preference can be entered only from the command line.

Type integer

Default Value 0

EI-3-36 OPNET Modeler/Release 16.1

 3—Program Descriptions

Example Usage

% op_mkema -m ring_build

--- op_mkema issued the following command: ---

/bin/sh -c "bind_gcc OP bind

IF /opnet/ref/16.1.A/models/std/ema_samp/ring_build.i1.em.o
OF /opnet/ref/16.1.A/models/std/ema_samp/ring_build.i1.em.x FL::
LD /opnet/ref/16.1.A/sys/pc_intel_linux/lib LB -lema -lsup -lvos
-lmdutl -lmdtab -lmdhdl -lobj -lorb
-lprg :: >/opnet/op_admin/tmp/bind_err 2>&1"

---------------------------------------------------------
Ema executable program (ring_build.i1.em.x) produced.

---------------------------------------------------------

OPNET Modeler/Release 16.1 EI-3-37

3—Program Descriptions

op_mko
A utility that translates a process model into C or C++ code form, and compiles
it into object code form. This utility also compiles pipeline stages, packet
conversion files, and external code files.

Description
Most models are created and modified using the modeler program, which is a
comprehensive interactive application with an easy-to-use graphical user
interface (GUI). However, the system also provides an alternative, external
interface for creating and modifying models, more in line with the Linux
philosophy of small, non-graphical tool programs that perform one particular
task.

Using the provided external interfaces, you can define a set of models
programmatically by invoking functions from the EMA Package (described in
Chapter 1 External Model Access on page MFA-1-1). After an EMA-based
application has completed executing, the models it specified will be stored in the
appropriate model directories. Network, node, and parameter models that have
been created in this way are ready to use in a simulation. However, process
models that have been created in this way must still be translated into C or C++
and compiled, so that they can later be linked into a simulation. One way to
accomplish the translation/compilation is to invoke the opnet program, open the
Process Editor, and perform the Compile Process Model operation. Invoking the
op_mko utility is the external alternative; it translates and compiles a process
model specified as an argument on its command line.

The following figure shows a schematic of the operation of op_mko; note the
Linux suffixes of the respective versions of the process model.

Figure 3-2 Schematic of the Operation of op_mko

invokes

op_mko cc (host C
x.pr.m OR x.pr.c x.pr.o
compiler)

process process process

model model model
(data form) (C form) (object form)

host C++
x.pr.cpp compiler

process
model
(C++ form)
invokes

EI-3-38 OPNET Modeler/Release 16.1

 3—Program Descriptions

Similarly, op_mko will compile either a pipeline stage or external code file using
the appropriate compiler for either C or C++, depending on the file specification
(.c for C and .cpp for C++). The kernel_type, m32, m64, and mt preferences
specify which simulation kernel to compile for.

Preferences
This program supports the following preference sets:

• Standard Preferences

• Diagnostics preferences

• Development preferences

• Licensing Preferences

This program also supports the following additional preferences.

all
Used alone, causes op_mko to recompile all process, external code, and
pipeline stages in the model directories. When used with the type preference,
compiles all files of the specified type (for example, op_mko -all -type ets
compiles all .ets.c and .ets.cpp files).

Type boolean

Default Value FALSE

gui
Specifies whether op_mko should generate a network visualization mapping
library for execution in the OPNET GUI (when TRUE) or during discrete event
simulation (when FALSE).

Note—This preference, when TRUE, causes op_mko to ignore the kernel_type

preference and generate a library that is linked with the necessary libraries for
use in the GUI. The simulation kernel is not linked against; thus, you cannot use
Kernel Procedures in code that will create a “gui” library.

Type boolean

Default Value FALSE

OPNET Modeler/Release 16.1 EI-3-39

3—Program Descriptions

m
Specifies the base name of the process model, pipeline stage, or external code
file that is to be compiled by op_mko. The file path or file type suffix should not
be included in the value of this preference.

Note—When compiling process models or wireless domain models,

OPNET Modeler maps any spaces in the model file name to underscore
characters in the function derived from that model. For these models, the
mapped name is the same as the interrupt function. For example,
my process model.pr.m would have my_process_model() as the name of
its interrupt function.

This preference is required and can be entered only from the command line.

Type string

Default Value none

raw_err
Specifies how compiler output should be handled. When FALSE, compiler
output is parsed and displayed in tabular form. When TRUE, the raw compiler
output is displayed.

This preference can be used only from the command line.

Type boolean

Default Value FALSE

type
Specifies the type of model to be compiled: “pr” for process, “ps” for pipeline
stage, “pfp” for overall packet conversion method files, “pff” for packet field
conversion method files, “ex” for external code file, “ets” for ETS code file. The
base name of the model is specified by the m preference.

This preference is required and can be entered only from the command line.

Type string

Default Value none

EI-3-40 OPNET Modeler/Release 16.1

 3—Program Descriptions

Example Usage

% op_mko -m router -type pr

------------------------------------------------
op_mko: process model object form
(/home/users/tsmith/op_models/router.pr.o) produced
------------------------------------------------

OPNET Modeler/Release 16.1 EI-3-41

3—Program Descriptions

op_mksim
A utility that binds a simulation together from its components: the simulation
object code file, the associated model archive, and the Simulation Kernel
libraries.

Description
Most OPNET Modeler models are created and run from within the main
program, which provides a comprehensive, interactive interface for this
purpose. However, OPNET Modeler also provides an alternative, external
interface for creating and modifying models when functions in external archive
libraries (.a files) must be linked into a simulation, as well as a mechanism for
running simulations in a source-level debugger.

There are separate OPNET Modeler tools available for externally

accomplishing each stage of constructing a simulation. The component models
of simulations (network, node, process, and parameter models) can be created
by external, Ema-based applications. Process models, pipeline stages, and
external code files can be compiled by the op_mko utility. Finally, the op_mksim
utility is used to generate .sim files, which can be executed as an external
simulation.

The purpose of op_mksim is to bind (link) together process model object code
files and the simulation kernel into an executable simulation program. The
simulation repository associated with the indicated network model is always
reconstructed before it binds the simulation.

Note—You must have an unexpired product license available to run

simulations. If a static executable built with op_mksim cannot find a valid license
installed on your system, it terminates with an error message. If you are running
static simulations in Windows, you must also ensure that
<reldir>/sys/pc_intel_win32/bin is the first directory listed in your
PATH environment.

Preferences
This program supports the following preference sets:

• Standard Preferences

• Diagnostics preferences (except diag_enable and rec_err_suppress)

• Development preferences

• Licensing Preferences

This program also supports the following additional preferences.

EI-3-42 OPNET Modeler/Release 16.1

 3—Program Descriptions

arch_prog
Specifies the ECI translation program or script to invoke to create a static library.
For more information, see Chapter 5 External Compiler Interface on
page EI-5-1.

Type string

Default Value “”

c
Specifies that all process models referenced by modules in the network model
are to be recompiled prior to binding the simulation. This preference implicitly
forces the option represented by the a preference, because the simulation
archive must be reconstructed to include all the recompiled process models.
This option is useful when a simulation needs to be comprehensively rebuilt
from its basic components, such as situations where it is not known which
process models have been changed since the last build.

Type boolean

Default Value FALSE

c_exclude_standard_models
Specifies that standard models should be excluded from a forced model
recompilation. When both this and the c preference are TRUE, all model files
within the OPNET Modeler installation directory tree (<install_dir>) will be
excluded from the forced recompile.

Type boolean

Default Value FALSE

net_name
Specifies the base name of the network model that is to be used as the basis of
the simulation. The file path or file type suffix should not be included in the value
of this preference.

This preference is required and can be entered only from the command line.

Type string

Default Value none

OPNET Modeler/Release 16.1 EI-3-43

3—Program Descriptions

raw_err
Specifies how compiler output should be handled. When FALSE, compiler
output is parsed and displayed in tabular form. When TRUE, the raw compiler
output is displayed.

This preference can be entered only from the command line.

Type boolean

Default Value FALSE

Example Usage

% op_mksim -net_name sample_net

----------------------------------------------
op_mksim: Simulation (/usr/fbasas/op_models/sample_net.sim) Produced
----------------------------------------------

EI-3-44 OPNET Modeler/Release 16.1

 3—Program Descriptions

op_mkso
A utility that builds shared object libraries from object files.

Description
op_mkso is used to build:

• Shared object libraries for use with internal execution ETS scripts

• Simulation repositories, which allow you to run simulations without a

compiler

• Design actions

• Network visualization libraries

• Antenna pattern libraries (for the optional Wireless functionality)

• Propagation models (for the optional Terrain Modeling Module functionality)

The inputs for an op_mkso build can be any object file, but are usually object
files that have been created with the op_mko utility.

The kernel_type, m32, m64, and mt preferences specify which simulation kernel
to build for. For example, for shared objects that can use either the development
or optimized simulation kernel (such as repositories and TMM propagation
models), use kernel_type to specify which type of shared object to build.

For variables and functions in one library to be visible in other libraries, they
must be declared with DLLEXPORT, as shown in the following examples:

DLLEXPORT int x;

DLLEXPORT void eth_mac_gen();

Under Windows, for an object library to use a variable that has been declared in
another library, the reference must be declared with IMPORT_GLOBAL:

extern IMPORT_GLOBAL int x;

Declarations using IMPORT_GLOBAL will have no unusual effects under Linux.

Preferences
This program supports the following preference sets:

• Standard Preferences

• Diagnostics preferences

• Development preferences

OPNET Modeler/Release 16.1 EI-3-45

3—Program Descriptions

This program also supports the following additional preferences.

all
Specifies that op_mkso should build all files of the specified type. This
preference applies only for design actions (type = da).

Type boolean

Default Value FALSE

c
Forces recompilation of the listed model files.

Type boolean

Default Value FALSE

c_exclude_standard_models
Specifies that standard models should be excluded from a forced model
recompilation. When both this and the c preference are TRUE, all model files
within the OPNET Modeler installation directory tree (<install_dir>) will be
excluded from the forced recompile.

Type boolean

Default Value FALSE

ets_files
List of ETS object files. “ALL” is interpreted as all files of this type.

Type string list

Default Value <empty>

ex_files
List of external object files. “ALL” is interpreted as all files of this type.

Type string list

Default Value <empty>

EI-3-46 OPNET Modeler/Release 16.1

 3—Program Descriptions

explicit_exports
When TRUE causes all functions and variables in the current library to be
exported. This may cause larger file sizes and degrade simulation performance.

Type boolean

Default Value FALSE

export_funcs
List of functions being exported by the library. This preference can be used on
Windows machines only.

Type string list

Default Value <empty>

f
Required list of object files that will be bound together into a library. File names
with full extensions are required.

Type string list

Default Value <empty>

gui
Specifies whether op_mkso should generate a network visualization mapping
library for execution in the OPNET GUI (when TRUE) or during discrete event
simulation (when FALSE).

Note—This preference, when TRUE, causes op_mkso to ignore the

kernel_type preference and generate a library that is linked with the necessary
libraries for use in the GUI. The simulation kernel is not linked against; thus, you
cannot use Kernel Procedures in code that will create a “gui” library.

Type boolean

Default Value FALSE

OPNET Modeler/Release 16.1 EI-3-47

3—Program Descriptions

m
Output library file name, with extensions. The extensions are not required for
repositories (type = repos).

Type string list

Default Value ”“

num_err
Specifies how many lines of error and warning messages to display.

Type integer

Default Value 10

pff_files
List of packet field conversion files. “ALL” is interpreted as all files of this type.

Type string list

Default Value <empty>

pfp_files
List of packet conversion files. “ALL” is interpreted as all files of this type.

Type string list

Default Value <empty>

pr_files
List of process models. “ALL” is interpreted as all files of this type.

Type string list

Default Value <empty>

EI-3-48 OPNET Modeler/Release 16.1

 3—Program Descriptions

ps_files
List of pipeline models. “ALL” is interpreted as all files of this type.

Type string list

Default Value <empty>

raw_err
Specifies how compiler output should be handled. When FALSE, compiler
output is parsed and displayed in tabular form. When TRUE, the raw compiler
output is displayed.

This preference can be entered only from the command line.

Type boolean

Default Value FALSE

type
Model type. The supported types are described in the following table.

Type Used to Create

ets ETS programs

repos simulation repositories

da design actions

nvism network visualization mapping library

antn antenna pattern libraries (Wireless functionality required)

tmm propagation models (Terrain Modeling Module functionality required)

Type string

Default Value “ets”

OPNET Modeler/Release 16.1 EI-3-49

3—Program Descriptions

verbose_exports
During compilation prints a list of all functions and variables being exported.
This preference can be used on Windows machines only.

Type boolean

Default Value FALSE

wdomain_files
List of wireless domain models. “ALL” is interpreted as all files of this type. (This
preference requires the Wireless functionality.)

Type string list

Default Value <empty>

Example Usage

% op_mkso -type ets -f test_event.ex.o test_dialog.ex.o test_interface.ex.o

-m example_library.so

-----------------------------------------------------
op_mkso: Shared library (example_library.so) produced
-----------------------------------------------------

EI-3-50 OPNET Modeler/Release 16.1

 3—Program Descriptions

op_runsim
Program to run simulations.

Description
There are two ways to run simulations. One way is to execute the simulation
executable program generated by op_mksim. The other way is to use
op_runsim from either the GUI (using DES menu commands) or from the
command line. op_runsim accepts the same preferences as a simulation
executable and has the advantage of automatically rebuilding the simulation
repository, which contains the model object code. Because op_runsim is not
tied to a specific network model, the network model must be specified via the
net_name preference. Also, if running simultaneous simulations of the same
network model from the command line, you must specify a unique execution ID
for each run with the exec_id preference.

Note—When you invoke op_runsim from the GUI, you can specify
command-line arguments from the Execution > Advanced > Application page of
the Configure/Run DES dialog box.

Running op_runsim invokes one of several simulation kernels. The

development kernels collect useful debugging information during the simulation,
and are therefore best used when developing models. They run more slowly
than the optimized kernels. The optimized kernels do not collect the debugging
information, but they do execute more quickly. Therefore, use a development
kernel when developing models and an optimized kernel after the models are
established.

The kernel_type, m32, m64, and mt preferences specify which simulation kernel
to use. Depending on the values of these preferences, op_runsim will invoke
one of the following programs (from the appropriate
sys\<architecture>\bin directory) to link and run simulations:

• op_runsim_dev

• op_runsim_opt

• op_runsim_mtdev

• op_runsim_mtopt

op_runsim and simulation executables created by op_mksim work similarly,

except that op_runsim dynamically rebuilds the network repository and
op_mksim will link static library information into the simulation executable.

Note—You must have an unexpired (free or in-use) simulation license in order

to run simulations. If op_runsim cannot find a valid license installed on your
system, it terminates with an error message.

OPNET Modeler/Release 16.1 EI-3-51

3—Program Descriptions

Simulation Preferences
Simulations accept a wide range of preferences that set parameters and
options. The standard sets accepted by simulations are listed below:

• Standard Preferences

• Development preferences

• Diagnostics preferences

• Licensing Preferences

• User Lock preferences

The specific static preferences accepted by simulations are listed in the

remainder of this section.

anim_attempts
Specifies the maximum number of times the simulation will attempt to send an
animation request packet to the animation viewer. If this count is exceeded, the
simulation will disable animation and will no longer transmit animation requests.
(For more information, see the related attributes anim_view and anim_timeout.)

Type Integer

Default Value 5

anim_hist
Specifies that animation be enabled within the simulation, and that animation
requests be captured in a file for later viewing by the animation viewer program.
The file will be given the name specified as this preference’s value, with the file
type suffix .ah (animation history). If no name is specified, the network name
will be used.

Type string

Default Value “”

EI-3-52 OPNET Modeler/Release 16.1

 3—Program Descriptions

anim_host
If animation is enabled, specifies a host computer running the animation viewer
to which the simulation will send animation request packets. The default value
indicates that the animation viewer is running on the same host as the
simulation. (For more information, see the related attributes anim_view and
anim_port.)

Type string

Default Value “localhost “

anim_port
Specifies an offset to be added to the default animation UDP/IP port number
(3211) when the simulation attempts to contact the animation viewer program.
This allows communication to be established between the simulation and the
animation viewer even if the default port is already in use. (For more information,
see the related attributes anim_view and anim_host.)

Type integer

Default Value 0

anim_timeout
If animation is enabled, specifies the timeout interval for animation request
packets; the simulation will wait this length of time for a response from the
animation viewer program before resending the request. (For more information,
see the related attributes anim_view and anim_attempts.)

Type double

Units seconds

Default Value 3.0

anim_view
Specifies that animation be enabled within the simulation, and that animation
requests be sent to a concurrently running animation viewer. (The anim_host
and anim_port attributes can also be set to specify the location of the animation
viewer program to which the animation requests will be sent.)

Type boolean

Default Value FALSE

OPNET Modeler/Release 16.1 EI-3-53

3—Program Descriptions

attr_reqs_file
Specifies an environment file in which to save promoted attribute requests.
When a simulation is run, it may initially prompt the user to enter values for
promoted object attributes. If this preference is set, these attribute assignments
are saved within an environment file with a name composed from the argument
value and the .ef file type suffix.

Type string

Default Value “”

c
Specifies that all object files referenced by the network model are to be
recompiled and the repository rebuilt prior to building the simulation. This option
is useful when a simulation needs to be comprehensively rebuilt from its basic
components, as in situations where it is not known which models have been
changed since the last build. (This argument is not valid for static simulations.)

Type boolean

Default Value FALSE

c_exclude_standard_models
Specifies that standard models should be excluded from a forced model
recompilation. When both this and the c preference are TRUE, all model files
within the OPNET Modeler installation directory tree (<install_dir>) will be
excluded from the forced recompile.

Type boolean

Default Value FALSE

child_id
Specifies the “child ID” of the simulation, which the simulation uses to identify
itself when communicating with the opnet program (simulations spawned by the
GUI are child processes of opnet). This preference is only used by opnet; it
should not be specified by users running simulations from a shell.

Type integer

Default Value -1

EI-3-54 OPNET Modeler/Release 16.1

 3—Program Descriptions

collect_model_deps_in_file
Specifies a file in which op_runsim will generate a list of model files referenced
during a simulation. If no file is specified, the dependency list is not generated.

This is a command-line-only preference whose value changes only at start-up.

Type string

Default Value “”

cosim
Specifies a simulation description file that op_runsim will use to find the other
simulators for a cosimulation. If no file is specified, cosimulation is not
performed. See Cosimulation on page MC-10-20 for more details.

This is a command-line-only preference whose value changes only at start-up.

Type string

Default Value “”

cosimulation_optimization_mode
Specifies whether the simulation will sleep while waiting for external events to
arrive. When set to “low-latency”, the simulation does not sleep. This reduces
latency at the expense of increased CPU usage.

Type enum

Default Value none

Constraints none, low-latency

debug
Specifies to execute the simulation under the control of the OPNET Simulation
Debugger (ODB), which provides a character-oriented command interpreter
shortly after execution commences.

Type boolean

Default Value FALSE

OPNET Modeler/Release 16.1 EI-3-55

3—Program Descriptions

des.checkpoint.autogen
When set, specifies when periodic checkpoints should be taken. The following
values are possible (where # represents a positive integer):

• “Event_#”—at event number #

• “Every_#”—every # events

• “Enter_#”—before entering # seconds

• “Leave_#”—leaving # seconds

• “Tenter_#”—entering every # seconds

• “Tleave_#”—leaving every # seconds

This preference has no effect unless des.checkpoint.enabled is TRUE. It is

available only on Linux.

Type string

Default Value “”

Constraints <empty>, Event_#, Every_#, Enter_#, Leave_#, Tenter_#,

Tleave_#

des.checkpoint.autogen_stop_after_restart
When TRUE, specifies that a restarted simulation will turn off any configured
auto-checkpoint generation. This allows a restarted simulation to run to
completion without being interrupted by additional checkpointing.

Type boolean

Default Value TRUE

des.checkpoint.continue
Specifies whether the simulation should continue after a checkpoint is taken.
When FALSE, the simulation terminates after the first checkpoint.

This preference has no effect unless des.checkpoint.enabled is TRUE. It is

available only on Linux.

Type boolean

Default Value TRUE

EI-3-56 OPNET Modeler/Release 16.1

 3—Program Descriptions

des.checkpoint.keep_last
Specifies how many checkpoints should be kept during a simulation run. When
set to 0, all checkpoints are kept. Otherwise, only the last n checkpoints are
kept.

This preference has no effect unless des.checkpoint.enabled is TRUE. It is

available only on Linux.

Type integer

Default Value 0

des.checkpoint.lowmem
Specifies whether a checkpoint should be taken when a memory allocation fails.
When TRUE, a checkpoint is taken.

This preference has no effect unless des.checkpoint.enabled is TRUE. It is

available only on Linux.

Type boolean

Default Value FALSE

des.checkpoint.verbose
Specifies whether to print the debug statements associated with checkpointing.
When TRUE, detailed messages are printed.

This preference has no effect unless des.checkpoint.enabled is TRUE. It is

available only on Linux.

Type boolean

Default Value FALSE

OPNET Modeler/Release 16.1 EI-3-57

3—Program Descriptions

duration
Specifies the intended duration of the simulation. The value of duration is
interpreted in terms of simulation time, rather than real execution time.
Simulation events scheduled for times later than the duration value will be
discarded when the simulation ends. A simulation may end before the duration
value is reached due to a program abort or process-requested termination.

Type double

Units seconds

Default Value 1000.0000

endsim_memstats
When TRUE, specifies that a memory statistic report will be automatically
generated when the simulation terminates. This report is similar to that
generated by the ODB memstats command. If the simulation was launched from
the OPNET GUI, the output is displayed on the Memory Stats page of the
Simulation Progress dialog box; otherwise, output goes to the console.

Type boolean

Default Value FALSE

etrace_diff
Causes op_runsim to compare the simulation execution trace of the current
simulation to a trace captured from another simulation. If any differences are
encountered, op_runsim will stop the current simulation and report the
differences in the simulation console. Use the etrace_dump preference to
capture the trace used for comparison. The value of the etrace_diff preference
is the path and name of the trace file to compare against.

This preference can be entered only from the command line.

Type string

Default Value “”

EI-3-58 OPNET Modeler/Release 16.1

 3—Program Descriptions

etrace_dump
Activates execution trace debugging, which causes op_runsim to capture a
simulation execution trace that can be feed into another simulation (with the
etrace_diff preference) to find the point at which simulation execution diverges.
You can reduce the size of the capture file with the etrace_start_time and
etrace_end_time preferences. The value of the etrace_dump preference is a
path and name for the capture file.

This preference can be entered only from the command line.

Type string

Default Value “”

etrace_end_time
Specifies the simulation end time for an etrace operation (etrace_dump or
etrace_diff. Any event after this time is not taken into account. When comparing
traces, the end time must match the end time of the comparison trace.

This preference can be entered only from the command line.

Type double

Default Value 1e+100

Constraints > 0 and > etrace_start_time

etrace_start_time
Specifies the simulation start time for an etrace operation (etrace_dump or
etrace_diff. Any event before this time is not taken into account. When
comparing traces, the start time must match the start time of the comparison
trace.

This preference can be entered only from the command line.

Type double

Default Value 0

Constraints >= 0

OPNET Modeler/Release 16.1 EI-3-59

3—Program Descriptions

event_order_method
Specifies how the processing order for events occurring at the same simulation
time is determined. If strict, events are ordered by the following keys:

1) Object (module) priority

2) Interrupt priority

3) Natural (event) order

If partial, events are ordered either by object priority (for events in different
objects) or interrupt priority (for events in the same object), with ties resolved by
event order in both cases.

See Event Prioritization for Simultaneous Event Execution on page MC-4-98 for
descriptions of these priority keys.

Type enum

Constraints strict, partial

Default Value strict

event_speed_parameter
Provides an advanced event management system that can be tuned to maintain
peak performance when simulating very large systems. Larger values will result
in faster simulations. The trade-off is that higher values of this preference
require additional memory.

At the end of each simulation, a value for this preference is calculated and
reported in the Simulation Log. Optimal values depend on the type and size of
models. You may want to experiment with different values and compare the
simulation's performance. In general, increasing this parameter will not yield
significant performance gains for small, lightly-loaded systems.

Type integer

Default Value 100,000

EI-3-60 OPNET Modeler/Release 16.1

 3—Program Descriptions

exec_id
Specifies the execution ID needed to generate distinct output files when
performing multiple simulation runs of the same network model. From the GUI,
a unique execution ID is set automatically for each run of a simulation set. From
the command line, however, you must use this preference to manually specify
a unique execution ID for each run. If you do not, new output files will overwrite
older ones. Also, simultaneous runs might try to write to the same file, potentially
causing warnings and errors.

This preference should be used only from the command line.

Type integer

Default Value 1

fully_serialized_event_ids
When TRUE, op_runsim replaces the event ID scheme (in which IDs are
serialized by module) with the global serialization used prior to OPNET 10.0.

Type boolean

Default Value TRUE for sequential kernels;

FALSE for parallel kernels

fully_serialized_event_execution_ids
When TRUE, op_runsim replaces the event ID scheme (in which IDs are
serialized by module) with the global serialization used prior to OPNET 10.0.

Type boolean

Default Value TRUE for sequential kernels;

FALSE for parallel kernels

fully_serialized_ici_ids
When TRUE, op_runsim replaces the ICI ID scheme (in which IDs are serialized
by module) with the global serialization used prior to OPNET 10.0.

Type boolean

Default Value TRUE for sequential kernels;

FALSE for parallel kernels

OPNET Modeler/Release 16.1 EI-3-61

3—Program Descriptions

fully_serialized_packet_ids
When TRUE, op_runsim replaces the packet ID scheme (in which IDs are
serialized by module) with the global serialization used prior to OPNET 10.0.

Type boolean

Default Value TRUE for sequential kernels;

FALSE for parallel kernels

jitd_cmd_line
Specifies a command line to use for launching a just-in-time debugger (Linux
only).

Type string

Default Value “xterm -T OPNET_JITD -e gdb -c %d”

jitd_enable
When TRUE, enables just-in-time debugging (Linux only).

Type boolean

Default Value FALSE

livelock_thresh
Specifies the threshold used to determine when a process model has entered a
livelock condition (i.e., the process model is continually making transitions
without reaching an unforced state). The threshold value is in effect a maximum
count for the number of transitions which can be performed on a single process
model invocation without causing a warning.

Type integer

Units transitions

Default Value 8192

EI-3-62 OPNET Modeler/Release 16.1

 3—Program Descriptions

log_endsim_perf
Specifies whether to generate a DES log entry based on the final performance
report.

Type boolean

Default Value FALSE

log_file
Specifies the name of the DES log file. If no name is specified, the network
name will be used.

Type string

Default Value “”

log_time_precision
Specifies the number of decimal places recorded for simulation times in the
DES log.

Type integer

Default Value 12

Constraints >= 0

max_log_entries
Specifies the maximum number of entries in the DES log.

Type integer

Default Value 200

OPNET Modeler/Release 16.1 EI-3-63

3—Program Descriptions

mem_track
Specifies whether the memory allocation and deallocation tracking features of
the Simulation Kernel should be enabled for use within ODB. When mem_track
is TRUE, the ODB commands memsrc and memsnk can be used to obtain lists
of the allocation sources and deallocation sinks within a simulation.

Note—This preference is part of the Development preference set, but is also

documented here due to its special role in simulations.

Type boolean

Default Value FALSE

mem_track_object
Specifies the name of a particular object for which to track memory allocation
and deallocation. Specifying an object allows for efficient tracking if only one
object is of interest. Used when mem_track is TRUE.

Note—This preference is part of the Development preference set, but is also

documented here due to its special role in simulations.

Type string

Default Value “”

memstat_autogen
Specifies how often a simulation will generate memory statistics. When the
simulation is run from the GUI, updates go to the Memory Stats tabbed page of
the Simulation Progress dialog box. When the simulation is run from the
command line, a memstats table is printed to the console. The following values
are possible (where F represents a positive float and N represents a positive
integer):

• “progress” —when a progress report is generated

• “enter_0” —at time 0, before the first event is executed

• “leave_0” —at time 0, after all events have been executed

• “enter_F”—every time F, before events are executed

• “leave_F”—every time F, after all events in the timecell are executed

EI-3-64 OPNET Modeler/Release 16.1

 3—Program Descriptions

• “every_N”—every N events

Type string

Default Value “”

memtag_all
Specifies whether the simulation should tag memory allocations for tracing on
the Memory Sources tabbed page of the Simulation Progress dialog box. When
TRUE, all allocations are tagged. When FALSE, no allocations are tagged. See
Using Memory Source Tracing on page DES-3-21 for details.

Type boolean

Default Value FALSE

memtag_list
Specifies a list of memory categories for which the simulation should tag
memory allocations. This tagging is used for memory source tracing on the
Memory Sources tabbed page of the Simulation Progress dialog box. See Using
Memory Source Tracing on page DES-3-21 for details.

Type string list

Default Value “”

net_name
Specifies the name of the network model that will be loaded by the simulation.
For static simulations, this preference can be left unset (in which case, it defaults
to the name of the static simulation). The value of net_name is used as a default
for the anim_hist, ef, log_file, os_file, ov_file, and probe preferences when they
are specified without a value.

This preference (or seq) is required, and can be used only from the command
line. net_name and seq are mutually exclusive and cannot be used together.

Type string

Default Value “”

OPNET Modeler/Release 16.1 EI-3-65

3—Program Descriptions

num_collect_values
Specifies the default maximum number of values to collect for each statistic
during a simulation. This value can be changed for a given scenario in the
Configure/Run DES dialog box.

Type integer

Default Value 100

opnet_port
Specifies the IPC port used by the opnet program to communicate with
spawned simulations. This preference is for internal opnet use only, and should
not be modified or set by the user.

Type integer

Default Value 0

ov_file
Specifies the name of the output vector file to be used to record vector statistic
values from the executing simulation. The .ov suffix of the file should not be
included in the preference value. If no name is specified, the network name will
be used.

Type string

Default Value “”

ov_mem_size
Specifies the maximum size of the output vector data buffer in megabytes.
When a buffer reaches the specified limit, its entries are written to disk, and it
resumes the collection of new values. Setting this preference to larger values
than the default trades off less writes to disk versus more memory usage. If
fragments are allowed to grow too large, the simulation may need to use swap
space which will reduce execution speed.

Type integer

Default Value 4

EI-3-66 OPNET Modeler/Release 16.1

 3—Program Descriptions

parallel_sim.serialization_level
Specifies the serialization level used by the parallel kernel. Depending on this
preference, only one event per node or one event per module can be executed
at any time. See Parallel Simulation Concepts on page MC-10-34 for details.

Type enum

Default Value node

Constraints node, module

parallel_sim.event_execution_time_window
Specifies a window of simulation time for executing events in parallel. Only
events in the same time window are eligible for parallel execution. The default
value (0.0) means that only events at the same simulation time are eligible for
parallel execution. See Parallel Simulation Concepts on page MC-10-34 for
details.

Type double

Units seconds

Default Value 0.0

parallel_sim.num_processors
Specifies the number of processors to be used by the Simulation Kernel. This
preference applies only to the parallel kernels. If this preference is set to 0 or
Maximum, the simulation will try to determine the number of CPUs available and
use them all. This value can be changed for a given scenario with the “Number
of threads” field on the Kernel Type page of the Configure/Run DES dialog box.
WARNING—Requesting that simulations use more CPUs than are physically
present and available will degrade simulation performance dramatically.

Type integer

Default Value 1

per_module_random_stream
When FALSE, specifies that all random numbers are generated from the same
stream. Thus, adding new distributions into a simulation will affect the random
numbers seen by existing distributions.

OPNET Modeler/Release 16.1 EI-3-67

3—Program Descriptions

When TRUE, specifies that each module maintains an independent random

stream. Calls to op_dist KPs will use the appropriate module’s stream. Thus,
adding new nodes or modules will not affect existing modules. This also makes
it easier for parallel simulations to have reproducible results.

Type boolean

Default Value FALSE for sequential kernels;

TRUE for parallel kernels

probe
Specifies the name of the probe file to be used to guide the collection of
statistics and the subsequent recording of vector data by the simulation. The
.pb.m suffix of the probe file should not be included in the preference value. If
no name is specified, the network name will be used.

Type string

Default Value “”

probe_error_enable
Enables warning messages regarding probe mismatches during simulation
loading.

Type boolean

Default Value FALSE

probe_start_time
If positive, specifies a simulation time before which no probing takes place. The
start times of individual probes will be taken into account only if later than this
time.

Type double

Units seconds

Default Value -1.0

EI-3-68 OPNET Modeler/Release 16.1

 3—Program Descriptions

probe_stop_time
If positive, specifies a simulation time after which no probing takes place. The
stop times of individual probes will be taken into account only if earlier than this
time.

Type double

Units seconds

Default Value -1.0

rand_gen_type
Specifies the pseudo-random number generator to use. “Linear-Congruential” is
a port of the random() function from the BSD UNIX source distribution, with a
31
period of 2 -1. “Mersenne-Twister” is a newer algorithm that generates higher
607
quality random numbers with a period of 2 -1.

Type enum

Default Value Linear-Congruential

Constraints Linear-Congruential, Mersenne-Twister

rand_num_ext_res
Specifies to generate random numbers with extended resolution (that is, with a
wider range of possible outcomes). If it is necessary to generate a stream of
random numbers compatible with earlier releases of OPNET, assign this
preference the value FALSE.

Type boolean

Default Value TRUE

raw_err
Specifies how compiler output should be handled. When FALSE, compiler
output is parsed and displayed in tabular form. When TRUE, the raw compiler
output is displayed.

This preference can be entered only from the command line.

Type boolean

Default Value FALSE

OPNET Modeler/Release 16.1 EI-3-69

3—Program Descriptions

realtime_ratio
Specifies a speed ratio (relative to real time) that op_runsim uses to control the
speed of a cosimulation. Note that the requested speed might be unachievable,
in which case the simulation will run as close to the requested speed as
possible. For example:

• 0—run simulation at full speed

• 1—run in real time

• 0.1—run 10 times slower than real time (that is, one-tenth of the real-time
speed)

• 5—run 5 times faster than real time

This preference can be set on the Execution > Advanced > Kernel Preferences
page of the Configure/Run DES dialog box.

Type double

Default Value 0

rec_err_suppress
Specifies that the simulation should suppress the printing and logging of
recoverable errors.

Type boolean

Default Value FALSE

record_gstats
Specifies that the simulation should record all global statistics in the output
vector file, regardless of the probe definitions.

Type boolean

Default Value FALSE

reports
Specifies the set of report probe files to use during the simulation.

Type string list

Default Value <empty>

EI-3-70 OPNET Modeler/Release 16.1

 3—Program Descriptions

repositories
Specifies the set of code repositories to load for a simulation. If you specify
repository files, op_runsim uses them instead of the default set.

Type string list

Default Value <empty>

Constraints <empty>, “none”, “stdmod”, valid repository files

script_mode
Specifies the ODB scripting mode. The possible values are “none”, “play”, and
“record”. If “play” is specified, the simulation will execute the commands in the
file specified by the script_name preference immediately after starting ODB. If
“record”, the simulation will record all ODB commands in the file specified by
script_name.

Type string

Default Value “none”

script_name
Specifies the name of a script file for use with ODB.

Type string

Default Value “odb_script”

seed
Specifies the seed value to be used by the simulation’s random number
generator. This generator provides either a simulation-wide random number
sequence or seeds for individual per-module sequences, depending on the
per_module_random_stream preference. See Generating Random Numbers
on page MC-10-46 for details.

Type integer

Default Value 128

seq
Specifies the name of a simulation sequence that will be loaded by the
simulation. op_runsim will extract the sets from the simulation sequence and
generate the required simulation runs, creating support files as needed.

OPNET Modeler/Release 16.1 EI-3-71

3—Program Descriptions

This preference (or net_name) is required, and can be used only from the
command line. seq and net_name are mutually exclusive and cannot be used
together.

Type string

Default Value “”

sim_packet_sharing
Specifies the packet sharing mode used by the simulation kernel. To reduce
simulation run time and conserve memory, packets can be shared when copies
are needed (for example, when transmitted to multiple receivers). When
packets are copied—either by procedures such as op_pk_copy() or through
automatic duplication by the Simulation Kernel—only the packet header is
copied at first. The packet copy references the fields in the original packet.
Later, if a field of either the original packet or the copy is to be changed, all of
the packet fields are copied to the packet copy. The possible values for this
preference are:

• Full—All packets are shared. This is the most efficient setting, but requires
that the structure fields not be modified directly when in a packet.

• Conservative—[default] All packets are shared except those with information

that can be accessed directly by a model (such as structure field content).

• Disabled—Packets are never shared.

Type enum

Constraints conservative, disabled, full

Default Value conservative

sim_process_priority
Specifies the scheduling priority of the discrete event simulation process within
the operating system.

Type enum

Constraints normal, high, low (Windows)

normal, low, lowest (Linux) 1

Default Value normal

1. Non-superusers on Linux cannot increase the priority of a process.

EI-3-72 OPNET Modeler/Release 16.1

 3—Program Descriptions

sim_time_quantum
Specifies the smallest quantum of time, in seconds, that the Simulation Kernel
will resolve. For instance, if 1 microsecond is specified (0.000001 or 1e-6),
simulation events will occur only on 1-microsecond boundaries. Events
scheduled for times that are not multiples of the specified quantum will be
rounded to the nearest quantum multiple.

If the value of this preference is zero, simulation time values are not quantized
and have the full resolution of double-precision floating-point variables.

Type double

Default Value 0.0

site_position_cache_size
Specifies how many positions are cached by each mobile site, in addition to the
current position. Although caching multiple positions can help the simulation run
faster, the speed increase uses additional memory. Requires Wireless
functionality.

Type integer

Default Value 3

sitl_realtime_ratio_check
Specifies whether SITL simulations should generate a warning message if the
realtime_ratio simulation preference is not set to 1. (Typically, it should be 1 for
a SITL simulation. However, other values are allowed for special cases, such as
using SITL to inject data into a simulation.) When TRUE, the message is
generated.

Data Type boolean

Default Value TRUE

sla_compute_all_violations
Normally, OPNET does not compute compliance for statistics that are
bucketized by default as count, sum over time, or time average. If TRUE,
OPNET computes compliance for all statistics.

Type boolean

Default Value FALSE

OPNET Modeler/Release 16.1 EI-3-73

3—Program Descriptions

sla_reports
Specifies the set of service level agreement (SLA) report probe files to use
during the simulation.

Type string list

Default Value <empty>

update_interval
Specifies the number of simulation events that are to elapse between printing
simulation update messages, which are generated when the verbose_sim
preference is set to TRUE.

Type double

Units simulation events

Default Value 500,000

updates_in_seconds
When TRUE, specifies that the simulation time reported in update messages
should be given in seconds instead of the usual hh:mm:ss format.

Type boolean

Default Value FALSE

verbose_cell_size_report
When TRUE, specifies that the simulation generate a report giving the
distribution of events per time cell. In parallel simulations, this report also
contains the number of events processed in parallel. See Cell Size Report on
page MC-10-39 for details.

This preference is available only in sequential development kernels.

Type boolean

Default Value FALSE

verbose_event_report
When TRUE, specifies that the simulation generate a report giving details about
event generation.

EI-3-74 OPNET Modeler/Release 16.1

 3—Program Descriptions

This preference is available only in sequential development kernels.

Type boolean

Default Value FALSE

verbose_event_timing_report
When TRUE, specifies that the simulation generate a report giving the average
event processing rate per time cell. This report provides a view of the event
execution happening in a simulation to analyze its potential for good parallel
simulation. See Event Timing Report on page MC-10-42 for details.

This preference is available only in sequential development kernels.

Type boolean

Default Value FALSE

verbose_load
Specifies that the simulation should print messages to the standard output
during its loading phase, describing distribution models as they are loaded.

Type boolean

Default Value FALSE

verbose_packet_report
When TRUE, specifies that the simulation generate a report giving details about
packet creation.

This preference is available only in sequential development kernels.

Type boolean

Default Value FALSE

verbose_parallel_speedup_report
When TRUE, specifies that the simulation generate a report predicting the
potential increases in execution speed for various numbers of processors. This
report can be used to estimate the value of using parallel simulation. See
Parallel Speedup Report on page MC-10-38 for details.

OPNET Modeler/Release 16.1 EI-3-75

3—Program Descriptions

This preference is available only in sequential development kernels.

Type boolean

Default Value FALSE

verbose_sim
Specifies that the simulation print update messages to the standard output
during mainline execution (i.e., in the post-loading phase). The messages
indicate the number of events that have executed, the elapsed real and
simulated times, and the efficiency of the simulation in events-per-second.

Type boolean

Default Value FALSE

Example Usage

% op_runsim -net_name ACE-local_net -debug

|-----------------------------------------------------------------------------|
| ____ _____ _ _ ______ _______ |
| / __ \ | __ \ | \ | || ____||__ __| Simulation and Model Library |
| | | | || |__) || \| || |__ | | Copyright 1987-2003 by |
| | | | || ___/ | . ` || __| | | OPNET Technologies, Inc. |
| | |__| || | | |\ || |____ | | as a part of OPNET Release 10.0.A |
| \____/ |_| |_| \_||______| |_| |
|-----------------------------------------------------------------------------|
| O P T I M U M N E T W O R K P E R F O R M A N C E |
|-----------------------------------------------------------------------------|
| OPNET Technologies, Inc. / 7255 Woodmont Av. / Bethesda, MD 20814, USA |
| TEL: +1.240.497.3000 / FAX: +1.240.497.3001 |
|-----------------------------------------------------------------------------|
| Network Simulation of: ACE-local_net |
|-----------------------------------------------------------------------------|
| Kernel: development (not optimized), sequential |
|-----------------------------------------------------------------------------|

|-----------------------------------------------------------------------------|
| Reading network model (ACE-local_net) |
|-----------------------------------------------------------------------------|

|-----------------------------------------------------------------------------|
| Reading result collection file: (ACE-local_net) |
|-----------------------------------------------------------------------------|

|-----------------------------------------------------------------------------|
| Verifying model consistency. |
|-----------------------------------------------------------------------------|

|-----------------------------------------------------------------------------|
| Loading scenario model library. |
|-----------------------------------------------------------------------------|
|-----------------------------------------------------------------------------|
| Counting objects. |
|-----------------------------------------------------------------------------|

|-----------------------------------------------------------------------------|
| Allocating objects. |
|-----------------------------------------------------------------------------|

EI-3-76 OPNET Modeler/Release 16.1

 3—Program Descriptions

|-----------------------------------------------------------------------------|
| Allocating objects. |
|-----------------------------------------------------------------------------|

|-----------------------------------------------------------------------------|
| Allocating attributes. |
|-----------------------------------------------------------------------------|

|-----------------------------------------------------------------------------|
| Installing subnetworks and nodes. |
|-----------------------------------------------------------------------------|

|-----------------------------------------------------------------------------|
| Installing links. |
|-----------------------------------------------------------------------------|

|-----------------------------------------------------------------------------|
| Constructing model hierarchy. |
|-----------------------------------------------------------------------------|
|-----------------------------------------------------------------------------|
| Creating node contents. |
|-----------------------------------------------------------------------------|

|-----------------------------------------------------------------------------|
| Attaching links to nodes. |
|-----------------------------------------------------------------------------|

|-----------------------------------------------------------------------------|
| Preparing for results collection. |
|-----------------------------------------------------------------------------|

|-----------------------------------------------------------------------------|
| Releasing Model Memory. |
|-----------------------------------------------------------------------------|

|-----------------------------------------------------------------------------|
| Opening results file. |
|-----------------------------------------------------------------------------|
|-----------------------------------------------------------------------------|
| Final initializations for all objects. |
|-----------------------------------------------------------------------------|
|-----------------------------------------------------------------------------|
| Initializing results. |
|-----------------------------------------------------------------------------|

|-----------------------------------------------------------------------------|
| Loading OPNET Debugger. |
|-----------------------------------------------------------------------------|

_______________ OPNET Simulation Debugger _______________

Type 'help' for Command Summary

odb> quit

|-----------------------------------------------------------------------------|
| Simulation Completed - Collating Results. |
| Simulated: Time (0 sec.), Events (26) |
| Time: Elapsed (8 sec.) |
|-----------------------------------------------------------------------------|

OPNET Modeler/Release 16.1 EI-3-77

3—Program Descriptions

op_sim_restart
The op_sim_restart utility restarts a checkpointed simulation

Description
This utility is available on Linux platforms to restart a discrete event simulation
from a selected checkpoint.

Preferences
None.

Example Usage

% op_sim_restart <checkpoint_directory>

where <checkpoint_directory> is of the form

<project>-<scenario>-c<#>.i1.desckpt.dir

EI-3-78 OPNET Modeler/Release 16.1

 3—Program Descriptions

op_ver
A utility that prints the current version and build number of the core software. To
obtain this and additional relevant information, choose Help > About this
Application in OPNET Modeler.

Preferences
None.

OPNET Modeler/Release 16.1 EI-3-79

3—Program Descriptions

op_vuerr
A utility that prints out function stack traceback and other program error
information. The error information is extracted from an error log maintained by
programs supplied by OPNET or based on OPNET object code libraries.

Description
Most OPNET-supplied programs handle error conditions and program crashes
using a unified error package. This package indicates the error to the user by
updating a message area (if the program has a Graphical User Interface) or by
printing messages on the standard output device. In all cases, errors are also
logged in an ASCII file named err_log within the administration directory
(<HOME>/op_admin).

Each entry in err_log has the following components:

• error classification, which indicates the severity of the error. The possible
classifications are listed below:
— Warning—situation that may lead to problems, and that should be
checked by user
— Recoverable Error—problem that does not prohibit the program from
proceeding, but that may result in the cancellation of the current
operation.
— Program Abort—problem that prohibits the program from reliably
proceeding, and that causes the program to immediately abort
— Program Fault—problem that causes the Linux kernel to immediately
abort the program in an uncontrolled manner

• date and time when the error occurred

• program in which the error occurred

• package of functions in which the error occurred

• function in which the error occurred

• description of the error, including variable values and related information

which can serve to identify the error’s cause

• contents of the program-maintained function stack that can be used by

technical support to help identify the location and cause of the error

EI-3-80 OPNET Modeler/Release 16.1

 3—Program Descriptions

The error log continues to grow as program errors occur and cause traceback
information to added to the file. The reason the error log is cumulative is to
provide:

• a reliable description of a recent sequence of errors that users or technical

support can use to investigate the cause of the errors

• a comprehensive summary of problematic user/program interactions that

technical support can analyze at regular intervals to improve the user
interface

Typically, the error log grows to many thousands of lines after a month of heavy
usage, so the log’s size should be checked regularly if disk space is at a
premium. The error log file can be removed by the user at any time to reduce
disk space usage; it is recreated as needed when the next error is logged.

The op_vuerr program provides a direct way to view the most recently logged
error(s). It opens up the error log, searches out the last error (or last N errors, if
specified), and prints out the traceback information on the standard output
device. op_vuerr can be executed from any directory, adding to its convenience.

Preferences
This program supports the following preference sets:

• Standard Preferences

• Diagnostics preferences (except diag_enable and rec_err_suppress)

This program also supports the following additional preferences.

num_err
Specifies the number of errors to be extracted from the error log and printed to
the standard output device. The most recent N errors are printed by op_vuerr
(i.e., the last n entries in the error log), where N is the value of this preference.

Type integer

Units errors

Default Value 1

OPNET Modeler/Release 16.1 EI-3-81

3—Program Descriptions

Example Usage

% op_vuerr
<<< Program Abort >>>
* Time: Fri May 17 17:31:48 1996
* Program: op_runsim (Version 3.0.A)
* Package: Simulation Kernel
* Function: sim_err_print (severity_level, str0, str1)
* Error: Error encountered rebuilding repository -- unable to proceed
T (0), EV (-1), MOD (NONE), PROC (sim_load_repos_load)

* Function call stack: (builds down)

------------------------------------------------------------
Call Block
Count Line# Function
------------------------------------------------------------
0) 1 267 main (argc, argv, envp)
1) 1 204 sim_init (argc, argv, envp)
2) 1 148 sim_load_models (net_name)
3) 1 571 sim_load_repos_load (net_name)
4) 2 171 sim_err_print (severity_level, str0, str1)
5) 3 224 Vos_Error_Print (level, package, error0, error1, error2)
------------------------------------------------------------

Each line in the function call stack contains a call count and a block line number
in addition to the function name and arguments. The call count specifies the total
number of times that the function has been called since the start of program
execution. The block line number specifies the last source-code line number
that was known to have executed within that function at the time of the error. The
block line number is not a fine-grained measure and does not necessarily list
the exact line number executed within the function at the time of the error.

The following example makes this more clear. It includes a sample code
fragment with line numbers and four hypothetical error locations:

1 int function()
2 {
3 int x, y, z;
4 int *ptr;
5
6 z = 0; A
7 for (x = 0; x < 10; x++)
8 {
9 for (y = 0; y < 10; y++) B
10 {
11 z += y;
12 z += x; C
13 }
14 }
15 return z; D
16 }

The following table lists the line numbers that will be returned by op_vuerr for
each location in the preceding example:

Location Reported line number

A 2

EI-3-82 OPNET Modeler/Release 16.1

 3—Program Descriptions

Location Reported line number

B 8

C 10

D 14

OPNET Modeler/Release 16.1 EI-3-83

3—Program Descriptions

op_xml_export
A utility that converts a model file from OPNET binary (.m) form to XML form.

Description
This program lets you convert a single model file from binary to XML form. It can
convert unlicensed process, link, path, demand, wireless domain, packet
format, ICI, and node models.

When you run this program, an OPNET Modeler license is reserved for your use
for one hour. Successive runs of this program (or op_xml_import) reset the lock.

OPNET Modeler provides menu commands for batch conversion of model files
between XML and binary form. See XML<=>Binary Model Conversion on
page ER-2-27 for details.

Preferences
This program supports the following preference sets:

• Standard Preferences (except arch_suffix, console_exit_pause, and

geocentric_model)

• Development preferences (mem_opt.compact_pools,

mem_opt.grow_pool_planks, mem_opt.pool_small_blocks, mem_shred,
mem_track, mem_track_object, prof_output, prof_output_separator,
prof_track, prof_track_func, and prof_track_recurse only)

• Diagnostics preferences (beep_count_confirm and beep_count_error only)

• File preferences (buffered_tfile_types, force_posix_locale, java_prog,

java_prog64, and verbose_session_log only)

• GUI (display_timezone_string and timezone only)

• Licensing (license_broker_host, license_broker_port, license_group,

license_password, license_port, license_server, license_server_standalone,
and license_username only)

• Automation Preferences (auto_disk_space_threshold only)

This program also supports the following additional preferences.

model_path
Specifies the full path name of the source model file. This preference is required.

Type string

Default Value “”

EI-3-84 OPNET Modeler/Release 16.1

 3—Program Descriptions

xml
Specifies the full path name of the destination XML file. This preference is
required.

Type string

Default Value “”

Example Usage

% op_xml_export -model_path “C:\Documents and

Settings\OPNET\op_models\shared_antenna.nd.m” -xml “C:\Documents and
Settings\OPNET\op_models\shared_antenna.xml”

OPNET Modeler/Release 16.1 EI-3-85

3—Program Descriptions

op_xml_import
A utility that converts a model file from XML form to OPNET binary (.m) form.

Description
This program lets you convert a single model file from XML to binary form. It can
convert process, link, path, demand, wireless domain, packet format, ICI, and
node models.

When you run this program, an OPNET Modeler license is reserved for your use
for one hour. Successive runs of this program (or op_xml_export) reset the lock.

OPNET Modeler provides menu commands for batch conversion of model files
between XML and binary form. See XML<=>Binary Model Conversion on
page ER-2-27 for details.

Preferences
This program supports the following preference sets:

• Standard Preferences (except arch_suffix, console_exit_pause, and

geocentric_model)

• Development preferences (mem_opt.compact_pools,

mem_opt.grow_pool_planks, mem_opt.pool_small_blocks, mem_shred,
mem_track, mem_track_object, prof_output, prof_output_separator,
prof_track, prof_track_func, and prof_track_recurse only)

• Diagnostics preferences (beep_count_confirm and beep_count_error only)

• File preferences (buffered_tfile_types, force_posix_locale, java_prog,

java_prog64, and verbose_session_log only)

• GUI (display_timezone_string and timezone only)

• Licensing (license_broker_host, license_broker_port, license_group,

license_password, license_port, license_server, license_server_standalone,
and license_username only)

• Automation Preferences (auto_disk_space_threshold only)

This program also supports the following additional preferences.

EI-3-86 OPNET Modeler/Release 16.1

 3—Program Descriptions

target_path
Specifies the full path name of the destination model file. This preference is
required.

Type string

Default Value “”

xml
Specifies the full path name of the source XML file. This preference is required.

Type string

Default Value “”

Example Usage

% op_xml_import -xml “C:\Documents and Settings\OPNET\op_models\shared_antenna.xml”

-target_path “C:\Documents and Settings\OPNET\op_models\shared_antenna.nd.m”
%

OPNET Modeler/Release 16.1 EI-3-87

3—Program Descriptions

opnet
A GUI-based, licensed application for editing and viewing models, executing
simulations, and analyzing simulation output results.

Description
The opnet program is the main working environment of the OPNET system. It
comprises a suite of internal editors for manipulating models. These editors
include the Project Editor, Node Editor, and Process Editor. Details about these
and other editors are described in Editors Reference.

Preferences
This program supports the following preference sets:

• Standard Preferences

• Development preferences

• Diagnostics preferences

• File preferences

• GUI preferences

• Licensing Preferences

• Printing preferences

• User Lock preferences

• Web Reporting preferences

• XML preferences

This program also supports preferences for specific add-on functionality; these
preferences are described in the corresponding manuals.

The following program-specific preferences are supported.

aliases_verify
Specifies whether to verify that all node aliases in the current scenario are
unique. If TRUE, the verification is performed when you change a node alias,
import a topology, or import an alias set. Duplicate aliases are listed in a text edit
pad.

Type boolean

Default Value TRUE

EI-3-88 OPNET Modeler/Release 16.1

 3—Program Descriptions

allow_parallel_kernel
Specifies whether controls allowing the use of parallel kernels should be
enabled in the detailed Configure/Run DES dialog box. When FALSE, the
parallel kernel controls on the Execution > Advanced > Kernel Type page are
disabled.

Type boolean

Default Value FALSE

an_mono_sym
Specifies whether the Analysis Tool panels drawn on monochrome displays
should visually distinguish separate traces with unique marker symbols (such as
triangles, circles, etc.). The value of this preference also applies to multi-trace
panels that are printed, because print output is monochrome.

Type boolean

Default Value TRUE

apply_all_aliases
Specifies the persistence of aliases assigned to network objects for unmapped
traffic in the Flows Browser after traffic import. By default, node aliases are
persistent OPNET-wide. Setting this preference to FALSE makes node aliases
persistent project-wide.

Type boolean

Default Value TRUE

auto_fire
Specifies whether the Analysis Tool panels automatically display statistics. If
FALSE, panels are created empty and you must select the Show Statistic
checkbox in the Edit Graph dialog box to draw each statistic.

Type boolean

Default Value TRUE

OPNET Modeler/Release 16.1 EI-3-89

3—Program Descriptions

bgutil_errlog_incident_limit
Specifies the incident limit for the link load import error logs.

Type integer

Default Value 10

bgutil_gbu_bucket_size
Specifies the bucket size to be used for ASCII (.gbu, .gbu2) imports. This
preference can be set also from the Import Baseline Loads from ASCII FIles
dialog box.

Type string

Default Value “As Is”

bgutil_gbu_bucket_type
Specifies the bucket mode to be used for ASCII (.gbu, .gbu2) imports. This
preference can be set also from the Import Baseline Loads from ASCII FIles
dialog box.

Type string

Default Value “Average”

bgutil_gbu_file_list
Specifies a list of files to be imported as ASCII (.gbu, .gbu2) files. This
preference can be set also from the Import Baseline Loads from ASCII FIles
dialog box.

Type string list

Default Value <empty>

bgutil_gbu_from_time
Specifies the start of the time window for filtering ASCII (.gbu, .gbu2) data.
This preference can be set also from the Import Baseline Loads from ASCII
FIles dialog box.

Type string

Default Value “ALL VALUES”

EI-3-90 OPNET Modeler/Release 16.1

 3—Program Descriptions

bgutil_gbu_overwrite
Specifies whether ASCII (.gbu, .gbu2) imports should overwrite existing data.
When TRUE, existing data is overwritten. This preference can be set also from
the Import Baseline Loads from ASCII FIles dialog box.

Type boolean

Default Value TRUE

bgutil_gbu_to_time
Specifies the end of the time window for filtering ASCII (.gbu, .gbu2) data. This
preference can be set also from the Import Baseline Loads from ASCII FIles
dialog box.

Type string

Default Value “ALL VALUES”

bgutil_ignore_alias_case
Specifies whether to ignore the case of alias names when importing background
utilization (link loads). When TRUE, case is ignored.

Type boolean

Default Value TRUE

comp_target_type.development_parallel_32
Specifies whether to generate this type of object file when compiling. Together
with the other comp_target_type attributes, this allows you to produce multiple
targets from a single source.

The value of this preference changes only at start-up.

Data Type boolean

Default Value FALSE

comp_target_type.development_parallel_64
Specifies whether to generate this type of object file when compiling. Together
with the other comp_target_type attributes, this allows you to produce multiple
targets from a single source.

OPNET Modeler/Release 16.1 EI-3-91

3—Program Descriptions

The value of this preference changes only at start-up.

Data Type boolean

Default Value FALSE

comp_target_type.development_sequential_32
Specifies whether to generate this type of object file when compiling. Together
with the other comp_target_type attributes, this allows you to produce multiple
targets from a single source.

The value of this preference changes only at start-up.

Data Type boolean

Default Value TRUE

comp_target_type.development_sequential_64
Specifies whether to generate this type of object file when compiling. Together
with the other comp_target_type preferences, this allows you to produce
multiple targets from a single source.

The value of this preference changes only at start-up.

Data Type boolean

Default Value TRUE

comp_target_type.optimized_parallel_32
Specifies whether to generate this type of object file when compiling. Together
with the other comp_target_type attributes, this allows you to produce multiple
targets from a single source.

The value of this preference changes only at start-up.

Data Type boolean

Default Value FALSE

EI-3-92 OPNET Modeler/Release 16.1

 3—Program Descriptions

comp_target_type.optimized_parallel_64
Specifies whether to generate this type of object file when compiling. Together
with the other comp_target_type attributes, this allows you to produce multiple
targets from a single source.

The value of this preference changes only at start-up.

Data Type boolean

Default Value FALSE

comp_target_type.optimized_sequential_32
Specifies whether to generate this type of object file when compiling. Together
with the other comp_target_type attributes, this allows you to produce multiple
targets from a single source.

The value of this preference changes only at start-up.

Data Type boolean

Default Value FALSE

comp_target_type.optimized_sequential_64
Specifies whether to generate this type of object file when compiling. Together
with the other comp_target_type preferences, this allows you to produce
multiple targets from a single source.

The value of this preference changes only at start-up.

Data Type boolean

Default Value FALSE

disk_cleanup.clean_automatically
Specifies whether to automatically maintain the files it creates on disk. If TRUE,
“old” files are automatically removed from disk as specified by the other
disk_cleanup preferences. This preference can be changed also with the File >
Delete Temporary Files… operation.

Data Type boolean

Default Value TRUE

OPNET Modeler/Release 16.1 EI-3-93

3—Program Descriptions

disk_cleanup.clean_duplicate_scenarios
Specifies whether to automatically maintain the number of
automation-generated scenarios in a project. If TRUE, duplicate scenarios older
than specified by disk_cleanup.clean_duplicate_scenarios_days are
automatically removed from disk when disk cleanup is executed. This
preference can be changed also with the File > Delete Temporary Files…
operation.

Data Type boolean

Default Value TRUE

disk_cleanup.clean_duplicate_scenarios_days
Specifies the number of days that automation-generated scenarios will be kept
before being automatically removed from disk. This preference is used only
when disk_cleanup.clean_duplicate_scenarios is TRUE. Its value can be
changed also with the File > Delete Temporary Files… operation.

Data Type integer

Default Value 30

disk_cleanup.clean_error_log
Specifies whether to automatically maintain the size of the error log. When
TRUE, error log entries older than specified by
disk_cleanup.clean_error_log_days are automatically removed from disk when
disk cleanup is executed. This preference can be changed also with the File >
Delete Temporary Files… operation.

Data Type boolean

Default Value TRUE

disk_cleanup.clean_error_log_days
Specifies the number of days that error log entries will be kept before being
automatically removed from the log. This preference is used only when
disk_cleanup.clean_error_log is TRUE. Its value can be changed also with the
File > Delete Temporary Files… operation.

Data Type integer

Default Value 30

EI-3-94 OPNET Modeler/Release 16.1

 3—Program Descriptions

disk_cleanup.clean_session_log
Specifies whether to automatically maintain the size of the session log. When
TRUE, session log entries older than specified by
disk_cleanup.clean_session_log_days are automatically removed from disk
when disk cleanup is executed. This preference can be changed also with the
File > Delete Temporary Files… operation.

Data Type boolean

Default Value TRUE

disk_cleanup.clean_session_log_days
Specifies the number of days that session log entries will be kept before being
automatically removed from the log. This preference is used only when
disk_cleanup.clean_session_log is TRUE. Its value can be changed also with
the File > Delete Temporary Files… operation.

Data Type integer

Default Value 30

disk_cleanup.clean_temporary_files
Specifies whether to automatically maintain the temporary files in
<HOME>\op_admin\tmp. When TRUE, temporary files older than specified by
disk_cleanup.clean_temporary_files_days are automatically removed from
disk. This preference can be changed also with the File >
Delete Temporary Files… operation.

Data Type boolean

Default Value TRUE

disk_cleanup.clean_temporary_files_days
Specifies the number of days that temporary files will be kept before being
automatically removed from disk. This preference is used only when
disk_cleanup.clean_temporary_files is TRUE. Its value can be changed also
with the File > Delete Temporary Files… operation.

Data Type integer

Default Value 7

OPNET Modeler/Release 16.1 EI-3-95

3—Program Descriptions

edit_attr_undo_warning_prompt
If TRUE, specifies whether to display a warning dialog for non-undoable
attribute-edit operations.

Type boolean

Default Value TRUE

ets_options
Specifies a list of unlicensed ETS-based product options.

The value of this preference changes only at start-up.

Type string list

Default Value <empty>

event_speed_parameter
Provides an advanced event management system that can be tuned to maintain
peak performance when simulating very large systems. Larger values will result
in faster simulations. The trade-off is that higher values for this preference
require additional memory.

Optimal values depend on the type and size of models. You may wish to
experiment with different values and compare the simulation's performance. In
general, increasing this parameter will not yield significant performance gains
for small, lightly-loaded systems.

Type integer

Default Value 100,000

file_abort_read_suppress
Prevents a program abort when a corrupted node model is read.

Type boolean

Default Value FALSE

EI-3-96 OPNET Modeler/Release 16.1

 3—Program Descriptions

flow_import_errlog_incident_limit
Specifies the maximum number of log messages recorded during flow imports
for a particular category, class, and subclass.

Type integer

Default Value 100

hpov_default_server
Specifies the default HP OpenView network topology server to be used for
imports.

Type string

Default Value “”

import_default_interface_type
Specifies the default interface type assigned during a topology import if a port
or link’s interface type is not specified or cannot be identified. The interface
type’s protocol and (optionally) speed can be specified by this preference (for
example, ethernet:10BaseT is a valid default interface type).

Type string

Default Value “”

import_default_machine_type
Specifies the default machine type assigned during a topology import if an
object’s machine type is not specified or cannot be identified (for example,
“switch” is a valid default machine type).

Type string

Default Value “”

import_mem_stats_log
Specifies whether to log memory usage statistics during topology import
operations. When FALSE, memory statistics are not logged.

Type boolean

Default Value FALSE

OPNET Modeler/Release 16.1 EI-3-97

3—Program Descriptions

ip_address_change_notify_limit
Specifies the maximum number of change messages displayed when
auto-assigning or clearing IP addresses.

Type integer

Default Value 0

javascript_enable
Specifies whether to use Javascript in the creation of results web reports. If
TRUE, Javascript is used to create the results tables in the web report, allowing
them to be manipulated in various ways. Ifn FALSE, the results tables are
written out in plain HTML.

Note—Regardless of the value of this preference, the treeview in a web report

is always created using Javascript.

Type boolean

Default Value TRUE

kernel_procedure_help
Specifies the type of online help for Kernel Procedures in the Process Editor.
“built-in” specifies that Modeler opens the KP documentation included with the
program. “web-based” specifies that Modeler launches the default browser and
accesses the URL indicated by kernel_procedure_help_URL.

Type enum

Default Value built-in

Constraints built-in, web-based

kernel_procedure_help_URL
Specifies the URL of online help for Kernel Procedures. This preference must
be set if kernel_procedure_help is set to “web-based”.

Type string

Default Value “”

EI-3-98 OPNET Modeler/Release 16.1

 3—Program Descriptions

ma_errlog_incident_limit
Specifies the maximum number of incidents to be reported in a model assistant
error log.

Type integer

Default Value 10

manage_licenses
Specifies whether to start with the License Manager running. If TRUE, there is
only limited functionality, however, no license is used. (The License Manager is
started automatically.) This mode is useful when performing license
management functions only. You must use this mode if you are deleting all
licenses, because the License Manager will not allow you to delete a license that
is in use.

This preference can be entered only from the command line, and its value
changes only at start-up.

Type boolean

Default Value FALSE

model_assistant_adjust_view_after_apply
Specifies whether autozoom is applied to the workspace following application of
a model assistant file. If TRUE, the display is automatically zoomed to the
affected objects.

The value of this preference changes only at start-up.

Type boolean

Default Value FALSE

model_assistant_configuration_file
Specifies a configuration file for the model assistant.

The value of this preference changes only at start-up.

Type string

Default Value “”

OPNET Modeler/Release 16.1 EI-3-99

3—Program Descriptions

net_report_link_detail_attrs
Specifies which link model attributes should be included in the link details
section of the network summary report. If this preference and
net_report_link_tooltip_alias are set to the default values, the link details section
lists the name and link type of each link, organized by subnet. When modifying
this preference, enter model attribute names exactly as shown in the Attributes
dialog box.

Type string

Default Value “tooltip”

net_report_link_summary_attrs
Specifies which link model attributes should be included in the link summary
section of the network summary report. If this preference and
net_report_link_tooltip_alias are set to the default values, the link summary
section lists the total number of links and the number (count) by link type. When
modifying this preference, enter model attribute names exactly as shown in the
Attributes dialog box.

Type string list

Default Value “tooltip”

net_report_link_tooltip_alias
Definition of the tooltip attribute used in link sections of the network summary
report. This is different from the UI tooltip (the explanatory text in a yellow box
that appears when you place the cursor over buttons).

Type string

Default Value “Link Type”

net_report_node_details_attrs
Specifies which node model attributes should be included in the node details
section of the network summary report. If this preference and
net_report_node_tooltip_alias are set to the default values, the node details
section lists the name and device type of each node, organized by subnet.
When modifying this preference, enter model attribute names exactly as shown
in the Attributes dialog box.

Type string list

Default Value “tooltip”

EI-3-100 OPNET Modeler/Release 16.1

 3—Program Descriptions

net_report_node_summary_attrs
Specifies which node model attributes should be included in the node details
section of the network summary report. If this preference and
net_report_node_tooltip_alias are set to the default values, the node details
section lists the name and device type of each node, organized by subnet.
When modifying this preference, enter model attribute names exactly as shown
in the Attributes dialog box.

Type string list

Default Value “tooltip”

net_report_node_tooltip_alias
Definition of the tooltip attribute used in node sections of the network summary
report. This is different from the UI tooltip (the explanatory text in a yellow box
that appears when you place the cursor over buttons).

Type string list

Default Value “Device Type”

network_diff.default_live_spec
Specifies the default specification file for Live Object/Attribute Difference
behavior.

Type string

Default Value “op_live_diff”

network_diff.default_report_spec
Specifies the default specification file for Object/Attribute Difference reports.

Type string

Default Value “op_network_diff”

OPNET Modeler/Release 16.1 EI-3-101

3—Program Descriptions

network_diff.live_icon_use
Specifies where to use the icons for Live Object/Attribute Differences.

Type enum

Default Value workspace_and_treeview

Constraints workspace_and_treeview, workspace_only, treeview_only

network_diff.output_dir
Specifies the directory to which Object/Attribute Difference report files are
written.

Type string

Default Value “”

network_diff.suppress_live_legend
Specifies whether to suppress the legend that appears in the lower left-hand
corner of the workspace while Live Object/Attribute Differences is active. This
legend describes the active tracking mode and the meaning of each of the icons
used to mark the various network objects. When FALSE, the legend is shown.
When TRUE, the legend is suppressed.

Type boolean

Default Value FALSE

network_palette
Specifies a custom model list or set of keywords to be used initially with the
object palette in the Project Editor. If this list is empty, no keywords or model list
are set when starting programs and the object palette displays icons for all
models in your model directories. Specifying this preference can save time
when you open the object palette, because the palette displays fewer models.

The value of this preference must be one of the following:

• One or more valid keywords. (Separate keywords by spaces on the

command line, or commas elsewhere.)

• The reserved word custom_model_list followed by a space and the name of

an existing custom model list.

EI-3-102 OPNET Modeler/Release 16.1

 3—Program Descriptions

You can specify keywords or a custom model list with this preference, but not
both at once.

Type string list

Default Value “”

network_palette.fixed_subnet_icon
Specifies the icon used for fixed subnet objects in the object palette. You can
specify an icon from any database listed in the “icon_dbs” line in your
modeler.ets file. If this preference is an empty string, the fixed subnet object
will not appear in the object palette.

Type string list

Default Value “subnet“

network_palette.group_aggregation
Specifies the self-description core characteristic used to group objects in the
object palette when model aggregation is enabled.

Type string

Default Value “System Object ID”

network_palette.keep_above
Specifies whether to prevent the object palette from being hidden behind the
editor window. If TRUE, the object palette is kept in front of the editor window
(but not other windows).

Type boolean

Default Value TRUE

OPNET Modeler/Release 16.1 EI-3-103

3—Program Descriptions

network_palette.mobile_subnet_icon
Specifies the icon used for mobile subnet objects in the object palette. You can
specify an icon from any database listed in the “icon_dbs” line in your
modeler.ets file. If this preference is an empty string, the mobile subnet object
will not appear in the object palette.

Type string

Default Value “subnet (mobile)”

network_palette.only_one
Specifies whether to limit a network model to only one open object palette at a
time. If FALSE, any number of object palettes can be open for a network model.
If TRUE, an attempt to open a second object palette will bring the existing object
palette window to the front and activate it.

Type boolean

Default Value FALSE

network_palette.satellite_subnet_icon
Specifies the icon used for satellite subnet objects in the object palette. You can
specify an icon from any database listed in the “icon_dbs” line in your
modeler.ets file. If this preference is an empty string, the satellite subnet object
will not appear in the object palette.

Type string

Default Value “subnet (mobile)”

nmx_no_dynamic
Specifies whether to allow use of DNS for HP NetMetrix traffic import. Setting
this preference to TRUE forces NetMetrix to ignore DNS for resolution of
addresses found in the archives being read.

EI-3-104 OPNET Modeler/Release 16.1

 3—Program Descriptions

Otherwise, if NetMetrix was installed to use DNS, importing archives can be

very lengthy, as every Internet address found in the archive will be checked to
find the corresponding host name. If the address is bogus or the corresponding
site cannot be found, the search ends after a lengthy time-out, giving the
impression that the import is going nowhere.

Type boolean

Default Value TRUE

no_snap
Specifies that graphical objects being placed within editors not have their
locations snapped to an invisible grid. Applies to Node and Process Editors
only.

Type boolean

Default Value FALSE

nt_model_post_conversion_library
Specifies a library containing a post-conversion pre-processor function used to
perform any additional cleanup work after automatic model conversion.

Type string

Default Value “”

nt_model_post_conversion_proc
Specifies a post-conversion pre-processor function used to perform any
additional cleanup work after automatic model conversion.

Type string

Default Value “”

nt_model_pre_conversion_library
Specifies a library containing a pre-conversion pre-processor function used to
perform any setup work for automatic model conversion.

Type string

Default Value “”

OPNET Modeler/Release 16.1 EI-3-105

3—Program Descriptions

nt_model_pre_conversion_proc
Specifies a pre-conversion pre-processor function used to perform any setup
work for automatic model conversion.

Type string

Default Value “”

num_collect_values
Specifies the default maximum number of values to collect for each statistic
during a simulation. This value can be changed for a given scenario in the
Configure/Run DES dialog box.

Type integer

Default Value 100

panels_plot_area_pack
Specifies whether analysis panels should be drawn with a margin (empty space)
around the graph area. When TRUE, a graph will completely fill the analysis
panel.

Data Type boolean

Default Value TRUE

panels_vector_x_axis_mode
Specifies what scale to use for the x axis in analysis panels and the Results
Browser preview pane. “default” labels the x axis using the network date and
time, if available. “Auto-scale” labels the x axis in seconds, minutes, hours, or
days, whichever is most appropriate to the length of the simulation. “Seconds”
forces the use of seconds.

Data Type enum

Default Value Auto-scale

Constraints default, Auto-scale, Seconds

EI-3-106 OPNET Modeler/Release 16.1

 3—Program Descriptions

panels_y_axis_bottom_margin
Specifies how much empty space to draw between the minimum vertical scale
and the bottom frame of the graph. This space prevents the bottom frame from
obscuring any low data values in the graph.

Data Type integer

Default Value 5

panels_y_axis_top_margin
Specifies how much empty space to draw between the maximum vertical scale
and the top frame of the graph. This space prevents the top frame from
obscuring any high data values in the graph.

Data Type integer

Default Value 3

parallel_sim.num_processors
Specifies the number of processors to be used by the Simulation Kernel. This
preference applies only to the parallel kernels. If this preference is set to 0 or
Maximum, the simulation will try to determine the number of CPUs available and
use them all. This value can be changed for a given scenario with the “Number
of threads” field on the Kernel Type page of the Configure/Run DES dialog box.
WARNING—Requesting that simulations use more CPUs than are physically
present and available will degrade simulation performance dramatically.

Type integer

Default Value 1

OPNET Modeler/Release 16.1 EI-3-107

3—Program Descriptions

parallel_sim.unknown_process_mt_safety_handling
Specifies how the parallel simulation kernel treats processes of unknown
MT-safety. When this preference is set to “assumed_unsafe”, they are executed
sequentially. With “assumed_safe”, they are treated as MT-safe and run in
parallel when possible. Refer to Parallel Simulation Concepts on
page MC-10-34 for more details.

Type enum

Default Value assumed_unsafe

Constraints assumed_unsafe, assumed_safe

product
Specifies the OPNET analysis software, which determines the feature set of the
program. The possible product types are:

• OPNET Development Kit (“odktools”)

• Modeler (“modeler”)

• SP Guru (“spguru”)

• IT Guru (“itguru”)

• SP Sentinel (“spsentinel”)

• IT Sentinel (“itsentinel”)

• CapEx (“capex”)

• Netbiz (“netbiz”)

• WDM Guru (“wdmguru”)

The value of this preference changes only at start-up.

Type enum

Default Value modeler

product_options
Specifies a list of modules that add additional functionality.

Type string list

Default Value <empty>

EI-3-108 OPNET Modeler/Release 16.1

 3—Program Descriptions

repositories
Specifies the set of code repositories to load for a simulation. If you specify
repository files, op_runsim uses them instead of the default set.

Type string list

Default Value <empty>

Constraints <empty>, “none”, “stdmod”, valid repository files

show_import_help
Specifies whether to display an import help dialog when failing to connect to a
server. If TRUE, the help dialog is displayed.

Type boolean

Default Value TRUE

show_map_edit_mode_help_msg
Specifies whether to display a help message when entering map edit mode in
the Project Editor. If TRUE, the help message is displayed.

Type boolean

Default Value TRUE

spreadsheet_prog
Specifies the path to the spreadsheet program that launches when data is
exported. The value can be simply the program name if the program is in a
directory specified by the path variable.

If no value is specified, the export operation still takes place, but the
spreadsheet program does not launch. The data is exported to a text file stored
in the op_admin/tmp directory.

Type string

Default Value “”

OPNET Modeler/Release 16.1 EI-3-109

3—Program Descriptions

static_bk_util.archive_dir
Specifies the list of directories in which background load data files are stored.
The specified directories are used when importing data from a NetworkHealth
(.dci) data file, an MRTG configuration (.cfg) file, or a General Background
Utilization (.gbu) file.

Type string

Default Value “”

top_n_results_min_significant_digits
Specifies the minimum number of significant digits in a Find Top Results report.

Type integer

Default Value 0

traffic_archive_dir
Specifies the path to a directory in which archive files can be found.

Type string

Default Value “”

traffic_default_interval
Specifies the interval (in seconds) used to subdivide imported traffic when
intervals are not otherwise known.

Type double

Default Value 30

traffic_import_suppress_unrecognized_sources_dialog
Specifies whether to suppress the unrecognized sources dialog box after a
traffic flow import. If FALSE, the dialog box is displayed; If TRUE, it is
suppressed.

Type boolean

Default Value FALSE

EI-3-110 OPNET Modeler/Release 16.1

 3—Program Descriptions

traffic_preprocessor_prog
Specifies a list of external preprocessing scripts used to convert ASCII traffic
files to Flexible CSV (.tr2) format. These scripts appear in the Import Traffic
dialog box’s Traffic Preprocessor menu.

Note—You must include the full path name for any scripts located outside your
user path.

Type string list

Default Value <empty>

traffic_profile_undef_value_treat_as_zero
Specifies how undefined values in traffic profiles should be handled during
simulation. When TRUE, undefined values are treated as 0.0; when FALSE, the
previous numeric value in the profile is used.

Type boolean

Default Value TRUE

undo_stack_size
Specifies the maximum number of undoable operations.

Type integer

Default Value 10

use_metric
Specifies whether the Startup Wizard should use metric units as a default.

Type boolean

Default Value TRUE

OPNET Modeler/Release 16.1 EI-3-111

3—Program Descriptions

use_network_editor_warning
Specifies whether to display migration information when starting the Network
Editor.

Type boolean

Default Value TRUE

use_scenario_prompt
Specifies whether to prompt for a scenario name when creating a new project.

Type boolean

Default Value TRUE

use_startup_wizard
Specifies that the Startup Wizard will launch automatically each time a new
scenario is created.

You can also control the Startup Wizard via the “Use Startup Wizard for each
new scenario” checkbox in the initial Startup Wizard dialog box. This method
supersedes this preference—unchecking the checkbox will prevent the Startup
Wizard from launching even if this preference is set to TRUE.

Type boolean

Default Value TRUE

value_notch_filter_tolerance
Specifies the range used by the value_notch filter to generate an output statistic.
Given an input statistic T0 and an ordinate value x, the value_notch filter
eliminates T0 if it is greater than x – value_notch_filter_tolerance and less than
x + value_notch_filter_tolerance. Otherwise the value_notch filter simply sends
T0 to the filter output. See also Value Notch Filter on page MC-11-60.

Type double

Default Value 1-E9

EI-3-112 OPNET Modeler/Release 16.1

 3—Program Descriptions

word_processing_prog
Specifies the path name of the word processing program that launches when a
text report is generated. The value can be simply the program name if the
program is in a directory specified by the path variable.

If no value is specified, the report is still generated, but the word processing
program does not launch. The report is stored in the op_admin/tmp directory.

The value of this preference changes only at start-up.

Type string

Default Value “”

OPNET Modeler/Release 16.1 EI-3-113