~ubuntu-branches/ubuntu/raring/ibutils/raring-proposed

« back to all changes in this revision

Viewing changes to ibmgtsim/doc/RunSimTest.pod

  • Committer: Bazaar Package Importer
  • Author(s): Benoit Mortier
  • Date: 2010-01-11 22:22:00 UTC
  • Revision ID: james.westby@ubuntu.com-20100111222200-53kum2et5nh13rv3
Tags: upstream-1.2-OFED-1.4.2
ImportĀ upstreamĀ versionĀ 1.2-OFED-1.4.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
=head1 NAME
 
2
 
 
3
B<RunSimTest> - Run a test over the IB management simulator
 
4
 
 
5
=head1 SYNOPSYS
 
6
 
 
7
RunSimTest [-h] [-o osm-path][-f flow-file][-c checker-file]
 
8
   -t topology [-n osm-node-name][-p osm-port-num][-s seed][-V verbosity-list]
 
9
 
 
10
This command starts the simulator and runs the the given test flow
 
11
on top of it. Then it runs the checker flow. The default test flow starts
 
12
OpenSM and wait for Subnet-Up event. User given flow can make use of the
 
13
provided facilities for starting OpenSM and tracking it events.
 
14
 
 
15
=head1 ARGUMENTS
 
16
 
 
17
=over
 
18
 
 
19
=item -t topology
 
20
 
 
21
A topology file describing the fabric (see B<ibdm-topo-file>)
 
22
 
 
23
=back
 
24
 
 
25
=head1 OPTIONS
 
26
 
 
27
=over
 
28
 
 
29
=item -f flow-file
 
30
 
 
31
A tcl file sourced by the sim after the fabric is setup. See following discussion about the provided API and global variables that are available for the flow.
 
32
 
 
33
=item -c checker-file
 
34
 
 
35
A tcl file defining when osm completed and what checks are requierd to validate it's outputs. The procedure named 'checker' is invoked by the test flow to start the checking flow. The default flow waits for OpenSM to complete setup the fabric and run ibdmchk.
 
36
 
 
37
=item -o osm-path
 
38
 
 
39
Full path to OpenSM (/usr/local/ofed/osm-sim/bin/opensm). NOTE OpenSM should be compiled with --with-osmv=sim to be able to connect to the simulator.
 
40
 
 
41
=item -n osm-node
 
42
 
 
43
Topology file node name the SM runs on (default H-1/U1)
 
44
 
 
45
=item -p port-num
 
46
 
 
47
Port number the SM attaches to (default 1).
 
48
 
 
49
=item -s seed
 
50
 
 
51
Random seed to be used.
 
52
 
 
53
=item -V verbosity-list
 
54
 
 
55
Module verbosity list. The first should be the global verbosity. See IBMgtSim for full list of modules.
 
56
Examples:
 
57
 
 
58
 -V 0xffff = Full verbosity on all modules
 
59
 -V '"0x3 server 0x6f2 sma 0xffff"' = Only fatal and error
 
60
    for all modules full verbosity for the SMA module and default
 
61
    verbosity for the Server module.
 
62
 
 
63
=item -h
 
64
 
 
65
This help message
 
66
 
 
67
 
 
68
=head1 AUTHOR
 
69
 
 
70
Eitan Zahavi, Mellanox Technologies LTD, eitan@mellanox.co.il