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

« back to all changes in this revision

Viewing changes to ibmgtsim/doc/IBMgtSim.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<IBMgtSim> - Infiniband Management Simulator
 
4
 
 
5
=head1 SYNOPSYS
 
6
 
 
7
IBMgtSim [-h] [-V mod-verb-pair-list] [-l log-file] [-p server-port]
 
8
  [-w num-threads] [-f flow-tcl-file] [-s seed] -t topology
 
9
 
 
10
=head1 DESCRIPTION
 
11
 
 
12
Simulates the Fabric as defined by the given topology file and start a server to handle MAD requests from clients like OpenSM.
 
13
 
 
14
=head1 ARGUMENTS
 
15
 
 
16
 
 
17
=item -t topology
 
18
 
 
19
A topology file describing the fabric to be simulated (see B<ibdm-topo-file>)
 
20
 
 
21
=head1 OPTIONS
 
22
 
 
23
=item -s seed
 
24
 
 
25
The seed to be used for random number generation.
 
26
 
 
27
=item -f flow-tcl-file
 
28
 
 
29
A tcl file to be sourced after the fabric is setup.
 
30
 
 
31
=item -l log-file
 
32
 
 
33
Set the log file of the simulator (default is /tmp/ibsim.log)
 
34
 
 
35
=item -p server-port
 
36
 
 
37
Set the port number the server attaches to (default 46517)
 
38
 
 
39
=item -w num-threads
 
40
 
 
41
The number of threads processing the mads
 
42
 
 
43
=item -V <module-verbosity-pair-list>
 
44
 
 
45
Provides a fine grain control over the log file verbosity. Given list of pairs of simulator software module names and their verbosity levels - every module is separatly controlled. The first value (missing module name) is controlling the default verbosity for all un-explicitly set modules.
 
46
 
 
47
=over 4
 
48
 
 
49
Current Verbosity Levels:
 
50
 
 
51
 MsgShowFatal  = 0x01;
 
52
 MsgShowError  = 0x02;
 
53
 MsgShowWarning= 0x04;
 
54
 MsgShowInfo   = 0x08;
 
55
 MsgShowVerbose= 0x10;
 
56
 MsgShowContext= 0x20;
 
57
 MsgShowSource = 0x40;
 
58
 MsgShowTime   = 0x80;
 
59
 MsgShowModule = 0x100;
 
60
 MsgShowMads   = 0x200;
 
61
 MsgShowFrames = 0x400;
 
62
 MsgShowAll    = 0xffff;
 
63
 MsgDefault    = 0x62f;
 
64
 
 
65
Software Modules:
 
66
 
 
67
client, server, dispatcher, node, sma, lftMad, mftMad, vlArbMad, pKeyMad, portInfoMad
 
68
 
 
69
Examples -V flag values might be:
 
70
 
 
71
 -V 0xffff = Full verbosity on all modules
 
72
 
 
73
 -V '0x3 server 0x6f2 sma 0xffff' = Only fatal and error for all modules
 
74
     full verbosity for the SMA module and default verbosity for the
 
75
     Server module.
 
76
 
 
77
=back 4
 
78
 
 
79
=item -h
 
80
 
 
81
This help message
 
82
 
 
83
=head1 AUTHOR
 
84
 
 
85
Eitan Zahavi, Mellanox Technologies LTD, eitan@mellanox.co.il
 
86
 
 
87
 
 
88
 
 
89