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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/NetworkPort.v1_2_3.json",
"$ref": "#/definitions/NetworkPort",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
"definitions": {
"Actions": {
"additionalProperties": false,
"description": "The available actions for this Resource.",
"longDescription": "This type shall contain the available actions for this Resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"Oem": {
"$ref": "#/definitions/OemActions",
"description": "The available OEM-specific actions for this Resource.",
"longDescription": "This property shall contain the available OEM-specific actions for this Resource.",
"versionAdded": "v1_1_0"
}
},
"type": "object"
},
"FlowControl": {
"enum": [
"None",
"TX",
"RX",
"TX_RX"
],
"enumDescriptions": {
"None": "No IEEE 802.3x flow control is enabled on this port.",
"RX": "IEEE 802.3x flow control may be initiated by the link partner.",
"TX": "IEEE 802.3x flow control may be initiated by this station.",
"TX_RX": "IEEE 802.3x flow control may be initiated by this station or the link partner."
},
"type": "string"
},
"LinkNetworkTechnology": {
"enum": [
"Ethernet",
"InfiniBand",
"FibreChannel"
],
"enumDescriptions": {
"Ethernet": "The port is capable of connecting to an Ethernet network.",
"FibreChannel": "The port is capable of connecting to a Fibre Channel network.",
"InfiniBand": "The port is capable of connecting to an InfiniBand network."
},
"type": "string"
},
"LinkStatus": {
"enum": [
"Down",
"Up"
],
"enumDescriptions": {
"Down": "The port is enabled but link is down.",
"Up": "The port is enabled and link is good (up)."
},
"type": "string"
},
"NetDevFuncMaxBWAlloc": {
"additionalProperties": false,
"description": "A maximum bandwidth allocation percentage for a network device functions associated a port.",
"longDescription": "This type shall describe a maximum bandwidth percentage allocation for a network device function associated with a port.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"MaxBWAllocPercent": {
"description": "The maximum bandwidth allocation percentage allocated to the corresponding network device function instance.",
"longDescription": "This property shall contain the maximum bandwidth percentage allocation for the associated network device function.",
"readonly": false,
"type": [
"integer",
"null"
],
"units": "%"
},
"NetworkDeviceFunction": {
"$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction",
"description": "The link to the NetworkDeviceFunction associated with this bandwidth setting of this network port.",
"longDescription": "This property shall contain a link of the NetworkDeviceFunction type that represents the network device function associated with this bandwidth setting of this network port.",
"readonly": true
}
},
"type": "object"
},
"NetDevFuncMinBWAlloc": {
"additionalProperties": false,
"description": "A minimum bandwidth allocation percentage for a network device functions associated a port.",
"longDescription": "This type shall describe a minimum bandwidth percentage allocation for a network device function associated with a port.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"MinBWAllocPercent": {
"description": "The minimum bandwidth allocation percentage allocated to the corresponding network device function instance.",
"longDescription": "This property shall contain the minimum bandwidth percentage allocation for the associated network device function. The sum total of all minimum percentages shall not exceed 100.",
"readonly": false,
"type": [
"integer",
"null"
],
"units": "%"
},
"NetworkDeviceFunction": {
"$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction",
"description": "The link to the NetworkDeviceFunction associated with this bandwidth setting of this network port.",
"longDescription": "This property shall contain a link of the NetworkDeviceFunction type that represents the network device function associated with this bandwidth setting of this network port.",
"readonly": true
}
},
"type": "object"
},
"NetworkPort": {
"additionalProperties": false,
"description": "A network port, which is a discrete physical port that can connect to a network.",
"longDescription": "A network port represents a discrete physical port that can connect to a network.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"@odata.context": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
},
"@odata.etag": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this Resource.",
"longDescription": "This property shall contain the available actions for this Resource.",
"versionAdded": "v1_1_0"
},
"ActiveLinkTechnology": {
"anyOf": [
{
"$ref": "#/definitions/LinkNetworkTechnology"
},
{
"type": "null"
}
],
"description": "Network port active link technology.",
"longDescription": "This property shall contain the configured link technology of this port.",
"readonly": false
},
"AssociatedNetworkAddresses": {
"description": "An array of configured MAC or WWN network addresses that are associated with this network port, including the programmed address of the lowest numbered network device function, the configured but not active address, if applicable, the address for hardware port teaming, or other network addresses.",
"items": {
"type": [
"string",
"null"
]
},
"longDescription": "This property shall contain an array of configured network addresses that are associated with this network port, including the programmed address of the lowest numbered network device function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses.",
"readonly": true,
"type": "array"
},
"CurrentLinkSpeedMbps": {
"description": "Network port current link speed.",
"longDescription": "This property shall contain the current configured link speed of this port.",
"readonly": false,
"type": [
"integer",
"null"
],
"units": "Mbit/s",
"versionAdded": "v1_2_0"
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"EEEEnabled": {
"description": "An indication of whether IEEE 802.3az Energy-Efficient Ethernet (EEE) is enabled for this network port.",
"longDescription": "This property shall indicate whether IEEE 802.3az Energy-Efficient Ethernet (EEE) is enabled for this network port.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"FCFabricName": {
"description": "The FC Fabric Name provided by the switch.",
"longDescription": "This property shall indicate the FC Fabric Name provided by the switch.",
"readonly": true,
"type": [
"string",
"null"
],
"versionAdded": "v1_2_0"
},
"FCPortConnectionType": {
"anyOf": [
{
"$ref": "#/definitions/PortConnectionType"
},
{
"type": "null"
}
],
"description": "The connection type of this port.",
"longDescription": "This property shall contain the connection type for this port.",
"readonly": true,
"versionAdded": "v1_2_0"
},
"FlowControlConfiguration": {
"anyOf": [
{
"$ref": "#/definitions/FlowControl"
},
{
"type": "null"
}
],
"description": "The locally configured 802.3x flow control setting for this network port.",
"longDescription": "This property shall contain the locally configured 802.3x flow control setting for this network port.",
"readonly": false
},
"FlowControlStatus": {
"anyOf": [
{
"$ref": "#/definitions/FlowControl"
},
{
"type": "null"
}
],
"description": "The 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only).",
"longDescription": "This property shall contain the 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only).",
"readonly": true
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"LinkStatus": {
"anyOf": [
{
"$ref": "#/definitions/LinkStatus"
},
{
"type": "null"
}
],
"description": "The status of the link between this port and its link partner.",
"longDescription": "This property shall contain the link status between this port and its link partner.",
"readonly": true
},
"MaxFrameSize": {
"description": "The maximum frame size supported by the port.",
"longDescription": "This property shall contain the maximum frame size supported by the port.",
"readonly": true,
"type": [
"integer",
"null"
],
"units": "By",
"versionAdded": "v1_2_0"
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"readonly": true
},
"NetDevFuncMaxBWAlloc": {
"description": "An array of maximum bandwidth allocation percentages for the network device functions associated with this port.",
"items": {
"$ref": "#/definitions/NetDevFuncMaxBWAlloc"
},
"longDescription": "This property shall contain an array of maximum bandwidth allocation percentages for the network device functions associated with this port.",
"type": "array"
},
"NetDevFuncMinBWAlloc": {
"description": "An array of minimum bandwidth allocation percentages for the network device functions associated with this port.",
"items": {
"$ref": "#/definitions/NetDevFuncMinBWAlloc"
},
"longDescription": "This property shall contain an array of minimum bandwidth percentage allocations for each of the network device functions associated with this port.",
"type": "array"
},
"NumberDiscoveredRemotePorts": {
"description": "The number of ports not on this adapter that this port has discovered.",
"longDescription": "This property shall contain the number of ports not on this adapter that this port has discovered.",
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_2_0"
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "The OEM extension property.",
"longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
},
"PhysicalPortNumber": {
"description": "The physical port number label for this port.",
"longDescription": "This property shall contain the physical port number on the network adapter hardware that this network port corresponds to. This value should match a value visible on the hardware.",
"readonly": true,
"type": [
"string",
"null"
]
},
"PortMaximumMTU": {
"description": "The largest maximum transmission unit (MTU) that can be configured for this network port.",
"longDescription": "This property shall contain the largest maximum transmission unit (MTU) that can be configured for this network port.",
"readonly": true,
"type": [
"integer",
"null"
]
},
"SignalDetected": {
"description": "An indication of whether the port has detected enough signal on enough lanes to establish a link.",
"longDescription": "This property shall indicate whether the port has detected enough signal on enough lanes to establish a link.",
"readonly": true,
"type": [
"boolean",
"null"
]
},
"Status": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
"description": "The status and health of the Resource and its subordinate or dependent Resources.",
"longDescription": "This property shall contain any status or health properties of the Resource."
},
"SupportedEthernetCapabilities": {
"description": "The set of Ethernet capabilities that this port supports.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/SupportedEthernetCapabilities"
},
{
"type": "null"
}
]
},
"longDescription": "This property shall contain an array of zero or more Ethernet capabilities supported by this port.",
"readonly": true,
"type": "array"
},
"SupportedLinkCapabilities": {
"description": "The link capabilities of this port.",
"items": {
"$ref": "#/definitions/SupportedLinkCapabilities"
},
"longDescription": "This property shall describe the static capabilities of the port, irrespective of transient conditions such as cabling, interface module presence, or remote link parter status or configuration.",
"type": "array"
},
"VendorId": {
"description": "The vendor Identification for this port.",
"longDescription": "This property shall indicate the vendor Identification string information as provided by the manufacturer of this port.",
"readonly": true,
"type": [
"string",
"null"
],
"versionAdded": "v1_2_0"
},
"WakeOnLANEnabled": {
"description": "An indication of whether Wake on LAN (WoL) is enabled for this network port.",
"longDescription": "This property shall indicate whether Wake on LAN (WoL) is enabled for this network port.",
"readonly": false,
"type": [
"boolean",
"null"
]
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
},
"OemActions": {
"additionalProperties": true,
"description": "The available OEM-specific actions for this Resource.",
"longDescription": "This type shall contain the available OEM-specific actions for this Resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {},
"type": "object"
},
"PortConnectionType": {
"enum": [
"NotConnected",
"NPort",
"PointToPoint",
"PrivateLoop",
"PublicLoop",
"Generic",
"ExtenderFabric"
],
"enumDescriptions": {
"ExtenderFabric": "This port connection type is an extender fabric port.",
"Generic": "This port connection type is a generic fabric port.",
"NPort": "This port connects through an N-Port to a switch.",
"NotConnected": "This port is not connected.",
"PointToPoint": "This port connects in a Point-to-point configuration.",
"PrivateLoop": "This port connects in a private loop configuration.",
"PublicLoop": "This port connects in a public configuration."
},
"type": "string"
},
"SupportedEthernetCapabilities": {
"enum": [
"WakeOnLAN",
"EEE"
],
"enumDescriptions": {
"EEE": "IEEE 802.3az Energy-Efficient Ethernet (EEE) is supported on this port.",
"WakeOnLAN": "Wake on LAN (WoL) is supported on this port."
},
"type": "string"
},
"SupportedLinkCapabilities": {
"additionalProperties": false,
"description": "The link capabilities of an assocaited port.",
"longDescription": "This type shall describe the static capabilities of an associated port, irrespective of transient conditions such as cabling, interface module presence, or remote link parter status or configuration.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"AutoSpeedNegotiation": {
"description": "An indication of whether the port is capable of auto-negotiating speed.",
"longDescription": "This property shall indicate whether the port is capable of auto-negotiating speed.",
"readonly": true,
"type": [
"boolean",
"null"
],
"versionAdded": "v1_2_0"
},
"CapableLinkSpeedMbps": {
"description": "The set of link speed capabilities of this port.",
"items": {
"type": [
"integer",
"null"
]
},
"longDescription": "This property shall contain all of the possible network link speed capabilities of this port.",
"readonly": true,
"type": "array",
"versionAdded": "v1_2_0"
},
"LinkNetworkTechnology": {
"anyOf": [
{
"$ref": "#/definitions/LinkNetworkTechnology"
},
{
"type": "null"
}
],
"description": "The link network technology capabilities of this port.",
"longDescription": "This property shall contain a network technology capability of this port.",
"readonly": true
},
"LinkSpeedMbps": {
"deprecated": "This property has been deprecated in favor of the CapableLinkSpeedMbps.",
"description": "The speed of the link in Mbps when this link network technology is active.",
"longDescription": "This property shall contain the speed of the link in megabits per second (Mbps) for this port when this link network technology is active.",
"readonly": true,
"type": [
"integer",
"null"
],
"units": "Mbit/s",
"versionDeprecated": "v1_2_0"
}
},
"type": "object"
}
},
"owningEntity": "DMTF",
"release": "2018.2",
"title": "#NetworkPort.v1_2_3.NetworkPort"
}
|
