1IBMSSH(1) IB MANAGEMENT SIMULATOR IBMSSH(1)
2
6 ibmssh IB MANAGEMENT SIMULATOR - Extentended TCL shell
7
9 ibmssh is a TCL shell extended with interface for the IB Management
10 Simulator facilities. Normally you will not run this shell directly -
11 but instead it will be invoked by the IBMgtSim utility. However, in
12 order to write simulation flows that interacts closely with the simu‐
13 lated model, a simulation flow should be provided. This flow is loaded
14 by IBMgtSim and excersize the API provided by this shell.
15 The following sub sections provide detailed definition for those
17 objects and API.
18
20 These constants are provided by IBMgtSim
21 Massage Manager Log Verbosity Flags
23 [ Constant : int ] $MsgShowFatal = 0x01
25 [ Constant : int ] $MsgShowError = 0x02
26 [ Constant : int ] $MsgShowWarning = 0x04
27 [ Constant : int ] $MsgShowInfo = 0x08
28 [ Constant : int ] $MsgShowVerbose = 0x10
29 [ Constant : int ] $MsgShowContext = 0x20
30 [ Constant : int ] $MsgShowSource = 0x40
31 [ Constant : int ] $MsgShowTime = 0x80
32 [ Constant : int ] $MsgShowModule = 0x100
33 [ Constant : int ] $MsgShowMads = 0x200
34 [ Constant : int ] $MsgShowFrames = 0x400
35 [ Constant : int ] $MsgShowAll = 0xffff
36 [ Constant : int ] $MsgDefault = 0x62f
37
39 class msgManager
40 This is the Message Manager class
42 [ Member : returns int ] getVerbLevel ?module?
44 [ Member : returns int ] clrVerbLevel ?module?
45 [ Member : returns void ] setVerbLevel vl ?module?
46 [ Member : returns int ] outstandingMsgCount ?vl?
47 [ Member : returns string ] outstandingMsgs ?vl?
48 [ Member : returns string ] getNextMessage
49 [ Member : returns void ] nullOutstandingMsgs
50 [ Member : returns int ] setLogFile fileName
51
53 [ returns float ] rmRand
54 obtain a random number in the range 0.0 - 1.0
55 [ returns int ] rmSeed seed
57 initialize the seed for the random manager
58 class ib_node_info_t
60 [ Member data: returns uint8_t * ] -base_version
62 [ Member data: returns uint8_t * ] -class_version
63 [ Member data: returns uint8_t * ] -node_type
64 [ Member data: returns uint8_t * ] -num_ports
65 [ Member data: returns ib_net64_t * ] -sys_guid
66 [ Member data: returns ib_net64_t * ] -node_guid
67 [ Member data: returns ib_net64_t * ] -port_guid
68 [ Member data: returns ib_net16_t * ] -partition_cap
69 [ Member data: returns ib_net16_t * ] -device_id
70 [ Member data: returns ib_net32_t * ] -revision
71 [ Member data: returns ib_net32_t * ] -port_num_vendor_id
72 class ib_switch_info_t
74 [ Member data: returns ib_net16_t * ] -lin_cap
76 [ Member data: returns ib_net16_t * ] -rand_cap
77 [ Member data: returns ib_net16_t * ] -mcast_cap
78 [ Member data: returns ib_net16_t * ] -lin_top
79 [ Member data: returns uint8_t * ] -def_port
80 [ Member data: returns uint8_t * ] -def_mcast_pri_port
81 [ Member data: returns uint8_t * ] -def_mcast_not_port
82 [ Member data: returns uint8_t * ] -life_state
83 [ Member data: returns ib_net16_t * ] -lids_per_port
84 [ Member data: returns ib_net16_t * ] -enforce_cap
85 [ Member data: returns uint8_t * ] -flags
86 class ib_port_info_t
88 [ Member data: returns ib_net64_t * ] -m_key
90 [ Member data: returns ib_net64_t * ] -subnet_prefix
91 [ Member data: returns ib_net16_t * ] -base_lid
92 [ Member data: returns ib_net16_t * ] -master_sm_base_lid
93 [ Member data: returns ib_net32_t * ] -capability_mask
94 [ Member data: returns ib_net16_t * ] -diag_code
95 [ Member data: returns ib_net16_t * ] -m_key_lease_period
96 [ Member data: returns uint8_t * ] -local_port_num
97 [ Member data: returns uint8_t * ] -link_width_enabled
98 [ Member data: returns uint8_t * ] -link_width_supported
99 [ Member data: returns uint8_t * ] -link_width_active
100 [ Member data: returns uint8_t * ] -state_info1
101 [ Member data: returns uint8_t * ] -state_info2
102 LinkSpeedSupported and PortState
103 [ Member data: returns uint8_t * ] -mkey_lmc
105 PortPhysState and LinkDownDefaultState
106 [ Member data: returns uint8_t * ] -link_speed
108 [ Member data: returns uint8_t * ] -mtu_smsl
109 LinkSpeedEnabled and LinkSpeedActive
110 [ Member data: returns uint8_t * ] -vl_cap
112 [ Member data: returns uint8_t * ] -vl_high_limit
113 VlCap and InitType
114 [ Member data: returns uint8_t * ] -vl_arb_high_cap
116 [ Member data: returns uint8_t * ] -vl_arb_low_cap
117 [ Member data: returns uint8_t * ] -mtu_cap
118 [ Member data: returns uint8_t * ] -vl_stall_life
119 [ Member data: returns uint8_t * ] -vl_enforce
120 [ Member data: returns ib_net16_t * ] -m_key_violations
121 [ Member data: returns ib_net16_t * ] -p_key_violations
122 [ Member data: returns ib_net16_t * ] -q_key_violations
123 [ Member data: returns uint8_t * ] -guid_cap
124 [ Member data: returns uint8_t * ] -subnet_timeout
125 [ Member data: returns uint8_t * ] -resp_time_value
126 [ Member data: returns uint8_t * ] -error_threshold
127 class ib_node_desc_t
129 [ Member data: returns uint8_array_t * ] -description
131 Node String is an array of UTF-8 character that describes the node
132 in text format Note that this string is NOT NULL TERMINATED!
133 class ib_lft_record_t
135 [ Member data: returns ib_net16_t * ] -lid
137 [ Member data: returns ib_net16_t * ] -block_num
138 [ Member data: returns uint32_t * ] -resv0
139 [ Member data: returns uint8_array_t * ] -lft
140 class ib_pm_counters_t
142 [ Member data: returns ib_mad_t * ] -mad_header
144 [ Member data: returns uint32_array_t * ] -reserved0
145 [ Member data: returns uint8_t * ] -reserved1
146 [ Member data: returns uint8_t * ] -port_select
147 [ Member data: returns ib_net16_t * ] -counter_select
148 [ Member data: returns ib_net16_t * ] -symbol_error_counter
149 [ Member data: returns uint8_t * ] -link_error_recovery_counter
150 [ Member data: returns uint8_t * ] -link_down_counter
151 [ Member data: returns ib_net16_t * ] -port_rcv_errors
152 [ Member data: returns ib_net16_t * ] -port_rcv_remote_physical_errors
153 [ Member data: returns ib_net16_t * ] -port_rcv_switch_relay_errors
154 [ Member data: returns ib_net16_t * ] -port_xmit_discard
155 [ Member data: returns uint8_t * ] -port_xmit_constraint_errors
156 [ Member data: returns uint8_t * ] -port_rcv_constraint_errors
157 [ Member data: returns uint8_t * ] -reserved2
158 [ Member data: returns uint8_t * ] -lli_errors_exc_buf_errors
159 [ Member data: returns ib_net16_t * ] -reserved3
160 [ Member data: returns ib_net16_t * ] -vl15_dropped
161 [ Member data: returns ib_net32_t * ] -port_xmit_data
162 [ Member data: returns ib_net32_t * ] -port_rcv_data
163 [ Member data: returns ib_net32_t * ] -port_xmit_pkts
164 [ Member data: returns ib_net32_t * ] -port_rcv_pkts
165 [ Member data: returns uint32_array_t * ] -reserved5
166
168 class IBMgtSim
169 [ Member : returns IBFabric * ] getFabric
171 [ Member : returns IBMSServer * ] getServer
172 [ Member : returns IBMSDispatcher * ] getDispatcher
173 [ Member : returns int ] init topoFileName serverPortNum numWorkers
174 class IBMSNode
176 [ Member : returns IBNode * ] getIBNode
178 get the IBNode of the IBMSNode
179 [ Member : returns int ] getLinkStatus outPortNum
181 get the link status of the given port
182 [ Member : returns int ] setPhyPortErrProfile portNum errProfileIn
184 set a particular port err profile
185 [ Member : returns int ] getPhyPortErrProfile portNum
187 get a particular port err profile
188 [ Member : returns int ] setPhyPortPMCounter portNum counterSelect
190 countersVal
191 set a specific port counter
192 [ Member : returns ib_pm_counters_t * ] getPhyPortPMCounter portNum
194 counterSelect get a specific port counter
195 [ Member : returns ib_port_info_t * ] getPortInfo portNum
196 get a specific port info
197 [ Member : returns int ] setLinkStatus portNum newState
199 set the Link status including sending trap128
200 [ Member : returns ib_node_info_t * ] getNodeInfo
202 get the node info
203 [ Member : returns ib_switch_info_t * ] getSwitchInfo
205 get the switch info
206 [ Member : returns ib_pkey_table_t * ] getPKeyTblBlock portNum blockNum
208 get pkey table block
209 [ Member : returns int ] setPKeyTblBlock portNum blockNum tbl
211 set pkey table block
212 [ Member : returns int ] setCrSpace startAddr length data
214 set CR Space Value
215 [ Member : returns int ] getCrSpace startAddr length data
217 get CR Space Value
218 [ Member : returns int ] getMFTBlock blockIdx portIdx
220 get MFT block
221 [ Member : returns int ] setMFTBlock blockIdx portIdx inMftBlock
223 set MFT block
224 class madMcMemberRec
226 [ Constructor: returns madMcMemberRec * ] madMcMemberRec name
228 [ Destructor: returns void ] rename obj {}
229 [ Member data: returns ib_gid_t * ] -mgid
230 [ Member data: returns ib_gid_t * ] -port_gid
231 [ Member data: returns ib_net32_t * ] -qkey
232 [ Member data: returns ib_net16_t * ] -mlid
233 [ Member data: returns uint8_t * ] -mtu
234 [ Member data: returns uint8_t * ] -tclass
235 [ Member data: returns ib_net16_t * ] -pkey
236 [ Member data: returns uint8_t * ] -rate
237 [ Member data: returns uint8_t * ] -pkt_life
238 [ Member data: returns ib_net32_t * ] -sl_flow_hop
239 [ Member data: returns uint8_t * ] -scope_state
240 [ Member : returns int ] send_set pFromNode fromPort destLid comp_mask
241 [ Member : returns int ] send_get pFromNode fromPort destLid comp_mask
242 [ Member : returns int ] send_del pFromNode fromPort destLid comp_mask
243 class madPathRec
245 [ Constructor: returns madPathRec * ] madPathRec name
247 [ Destructor: returns void ] rename obj {}
248 [ Member data: returns uint8_array_t * ] -resv0
249 [ Member data: returns ib_gid_t * ] -dgid
250 [ Member data: returns ib_gid_t * ] -sgid
251 [ Member data: returns ib_net16_t * ] -dlid
252 [ Member data: returns ib_net16_t * ] -slid
253 [ Member data: returns ib_net32_t * ] -hop_flow_raw
254 [ Member data: returns uint8_t * ] -tclass
255 [ Member data: returns uint8_t * ] -num_path
256 [ Member data: returns ib_net16_t * ] -pkey
257 [ Member data: returns ib_net16_t * ] -sl
258 [ Member data: returns uint8_t * ] -mtu
259 [ Member data: returns uint8_t * ] -rate
260 [ Member data: returns uint8_t * ] -pkt_life
261 [ Member data: returns uint8_t * ] -preference
262 [ Member data: returns uint8_array_t * ] -resv2
263 [ Member : returns int ] send_get pFromNode fromPort destLid comp_mask
264 class madServiceRec
266 [ Constructor: returns madServiceRec * ] madServiceRec name
268 [ Destructor: returns void ] rename obj {}
269 [ Member data: returns ib_net64_t * ] -service_id
270 [ Member data: returns ib_gid_t * ] -service_gid
271 [ Member data: returns ib_net16_t * ] -service_pkey
272 [ Member data: returns ib_net16_t * ] -resv
273 [ Member data: returns ib_net32_t * ] -service_lease
274 [ Member data: returns uint8_array_t * ] -service_key
275 [ Member data: returns uint8_array_t * ] -service_name
276 [ Member data: returns uint8_array_t * ] -service_data8
277 [ Member data: returns uint16_array_t * ] -service_data16
278 [ Member data: returns uint32_array_t * ] -service_data32
279 [ Member data: returns uint64_array_t * ] -service_data64
280 [ Member : returns int ] send_set pFromNode fromPort destLid comp_mask
281 [ Member : returns int ] send_get pFromNode fromPort destLid comp_mask
282 [ Member : returns int ] send_del pFromNode fromPort destLid comp_mask
283 class madNotice128
285 [ Constructor: returns madNotice128 * ] madNotice128 name
287 [ Destructor: returns void ] rename obj {}
288 [ Member data: returns uint8_t * ] -generic_type
289 [ Member data: returns uint8_t * ] -prod_type_msb
290 [ Member data: returns ib_net16_t * ] -prod_type_lsb
291 [ Member data: returns ib_net16_t * ] -trap_num
292 [ Member data: returns ib_net16_t * ] -issuer_lid
293 [ Member data: returns ib_net16_t * ] -toggle_count
294 [ Member data: returns ib_net16_t * ] -sw_lid
295 the sw lid of which link state changed - for 128 only
296 [ Member data: returns ib_gid_t * ] -issuer_gid
298 [ Member : returns int ] send_trap pFromNode fromPort destLid
299 class madNotice129
301 [ Constructor: returns madNotice129 * ] madNotice129 name
303 [ Destructor: returns void ] rename obj {}
304 [ Member data: returns uint8_t * ] -generic_type
305 [ Member data: returns uint8_t * ] -prod_type_msb
306 [ Member data: returns ib_net16_t * ] -prod_type_lsb
307 [ Member data: returns ib_net16_t * ] -trap_num
308 [ Member data: returns ib_net16_t * ] -issuer_lid
309 [ Member data: returns ib_net16_t * ] -toggle_count
310 [ Member data: returns ib_net16_t * ] -pad
311 [ Member data: returns ib_net16_t * ] -lid
312 lid and port number of the violation
313 [ Member data: returns uint8_t * ] -port_num
315 [ Member data: returns ib_gid_t * ] -issuer_gid
316 [ Member : returns int ] send_trap pFromNode fromPort destLid
317 class madNotice144
319 [ Constructor: returns madNotice144 * ] madNotice144 name
321 [ Destructor: returns void ] rename obj {}
322 [ Member data: returns uint8_t * ] -generic_type
323 [ Member data: returns uint8_t * ] -prod_type_msb
324 [ Member data: returns ib_net16_t * ] -prod_type_lsb
325 [ Member data: returns ib_net16_t * ] -trap_num
326 [ Member data: returns ib_net16_t * ] -issuer_lid
327 [ Member data: returns ib_net16_t * ] -toggle_count
328 [ Member data: returns ib_net16_t * ] -pad1
329 [ Member data: returns ib_net16_t * ] -lid
330 lid where capability mask changed
331 [ Member data: returns ib_net16_t * ] -pad2
333 [ Member data: returns ib_net32_t * ] -new_cap_mask
334 new capability mask
335 [ Member data: returns ib_gid_t * ] -issuer_gid
337 [ Member : returns int ] send_trap pFromNode fromPort destLid
338
340 Eitan Zahavi, Mellanox Technologies LTD, eitan@mellanox.co.il
341IBMGTSIM 1.0 2008-06-16 IBMSSH(1)