HP Mellanox SX1018 Mellanox MLNX-OS®Command Reference Guide for SX101 - Page 23

Parameter Key, Table 8 - Parameter Key Table

Page 23 highlights

Rev 1.6.9 1.7 Parameter Key This section is a key to the meaning and format of all of the angle-bracketed parameters in all the commands that are listed in this document. Table 8 - Parameter Key Table Parameter Description A domain name, e.g. "mellanox.com". A hostname, e.g. "switch-1". An interface name, e.g. "mgmt0", "mgmt1", "lo" (loopback), etc. A number to be associated with aliased (secondary) IP addresses. An IPv4 address, e.g. "192.168.0.1". A syslog logging severity level. Possible values, from least to most severe, are: "debug", "info", "notice", "warning", "error", "crit", "alert", "emerg". Globally Unique Identifier. A number that uniquely identifies a device or component. A MAC address. The segments may be 8 bits or 16 bits at a time, and may be delimited by ":" or ".". So you could say "11:22:33:44:55:66", "1122:3344:5566", "11.22.33.44.55.66", or "1122.3344.5566". A netmask (e.g. "255.255.255.0") or mask length prefixed with a slash (e.g. "/24"). These two express the same information in different formats. An IPv4 network prefix specifying a network. Used in conjunction with a netmask to determine which bits are significant. e.g. "192.168.0.0". An extended regular expression as defined by the "grep" in the man page. (The value you provide here is passed on to "grep -E".) ID of a node belonging to a cluster. This is a numerical value greater than zero. A string specifying the name of a cluster. TCP/UDP port number. A TCP port number in the full allowable range [0...65535]. A normal URL, using any protocol that wget supports, including http, https, ftp, sftp, and tftp; or a pseudo-URL specifying an scp file transfer. The scp pseudo-URL format is scp://username:password@hostname/path/filename. Note that the path is an absolute path. Paths relative to the user's home directory are not currently supported. The implementation of ftp does not support authentication, so use scp or sftp for that. Note also that if you omit the ":password" part, you may be prompted for the password in a follow up prompt, where you can type it securely (without the characters being echoed). This prompt will occur if the "cli default prompt empty-password" setting is true; otherwise, the CLI will assume you do not want any password. If you include the ":" character, this will be taken as an explicit declaration that the password is empty, and you will not be prompted in any case. Mellanox Technologies 23 Mellanox® Technologies Confidential

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313
  • 314
  • 315
  • 316
  • 317
  • 318
  • 319
  • 320
  • 321
  • 322
  • 323
  • 324
  • 325
  • 326
  • 327
  • 328
  • 329
  • 330
  • 331
  • 332
  • 333
  • 334
  • 335
  • 336
  • 337
  • 338
  • 339
  • 340
  • 341
  • 342
  • 343
  • 344
  • 345
  • 346
  • 347
  • 348
  • 349
  • 350
  • 351
  • 352
  • 353
  • 354
  • 355
  • 356
  • 357
  • 358
  • 359
  • 360
  • 361
  • 362
  • 363
  • 364
  • 365
  • 366
  • 367
  • 368
  • 369
  • 370
  • 371
  • 372
  • 373
  • 374
  • 375
  • 376
  • 377
  • 378
  • 379
  • 380
  • 381
  • 382
  • 383
  • 384
  • 385
  • 386
  • 387
  • 388
  • 389
  • 390
  • 391
  • 392
  • 393
  • 394
  • 395
  • 396
  • 397
  • 398
  • 399
  • 400
  • 401
  • 402
  • 403
  • 404
  • 405
  • 406
  • 407
  • 408
  • 409
  • 410
  • 411
  • 412
  • 413
  • 414
  • 415
  • 416
  • 417
  • 418
  • 419

Rev 1.6.9
Mellanox Technologies
23
1.7
Parameter Key
This section is a key to the meaning and format of all of the angle-bracketed parameters in all the
commands that are listed in this document.
Table 8 - Parameter Key Table
Parameter
Description
<domain>
A domain name, e.g. “mellanox.com”.
<hostname>
A hostname, e.g. “
switch-1
”.
<ifname>
An interface name, e.g. “mgmt0”, “mgmt1”, “lo” (loopback), etc.
<index>
A number to be associated with aliased (secondary) IP addresses.
<IP address>
An IPv4 address, e.g. “192.168.0.1”.
<log level>
A syslog logging severity level. Possible values, from least to most severe, are:
“debug”, “info”, “notice”, “warning”, “error”, “crit”, “alert”, “emerg”.
<GUID>
Globally Unique Identifier. A number that uniquely identifies a device or compo-
nent.
<MAC address>
A MAC address. The segments may be 8 bits or 16 bits at a time, and may be
delimited by “:” or “.”. So you could say “11:22:33:44:55:66”, “1122:3344:5566”,
“11.22.33.44.55.66”, or “1122.3344.5566”.
<netmask>
A netmask (e.g. “255.255.255.0”) or mask length prefixed with a slash (e.g. “/24”).
These two express the same information in different formats.
<network prefix>
An IPv4 network prefix specifying a network. Used in conjunction with a netmask
to determine which bits are significant. e.g. “192.168.0.0”.
<regular expression>
An extended regular expression as defined by the “grep” in the man page. (The
value you provide here is passed on to “grep -E”.)
<node id>
ID of a node belonging to a cluster. This is a numerical value greater than zero.
<cluster id>
A string specifying the name of a cluster.
<port>
TCP/UDP port number.
<TCP port>
A TCP port number in the full allowable range [0...65535].
<URL>
A normal URL, using any protocol that wget supports, including http, https, ftp,
sftp,
and tftp; or a pseudo-URL specifying an scp file transfer. The scp pseudo-URL
format is scp://username:password@hostname/path/filename.
Note that the path is an absolute path. Paths relative to the user's home directory are
not currently supported. The implementation of ftp does not support authentication,
so use scp or sftp
for that.
Note also that if you omit the “:password” part, you may be prompted for the pass-
word in a follow up prompt, where you can type it securely (without the characters
being echoed). This prompt will occur if the “cli default prompt empty-password”
setting is true; otherwise, the CLI will assume you do not want any password. If
you include the “:” character, this will be taken as an explicit declaration that the
password is empty, and you will not be prompted in any case.
Mellanox® Technologies Confidential