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
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.v1_3_3.json",
"$ref": "#/definitions/NetworkDeviceFunction",
"$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"
},
"AuthenticationMethod": {
"enum": [
"None",
"CHAP",
"MutualCHAP"
],
"enumDescriptions": {
"CHAP": "iSCSI Challenge Handshake Authentication Protocol (CHAP) authentication is used.",
"MutualCHAP": "iSCSI Mutual Challenge Handshake Authentication Protocol (CHAP) authentication is used.",
"None": "No iSCSI authentication is used."
},
"type": "string"
},
"BootMode": {
"enum": [
"Disabled",
"PXE",
"iSCSI",
"FibreChannel",
"FibreChannelOverEthernet"
],
"enumDescriptions": {
"Disabled": "Do not indicate to UEFI/BIOS that this device is bootable.",
"FibreChannel": "Boot this device by using the embedded Fibre Channel support and configuration. Only applicable if the NetworkDeviceFunctionType is `FibreChannel`.",
"FibreChannelOverEthernet": "Boot this device by using the embedded Fibre Channel over Ethernet (FCoE) boot support and configuration. Only applicable if the NetworkDeviceFunctionType is `FibreChannelOverEthernet`.",
"PXE": "Boot this device by using the embedded PXE support. Only applicable if the NetworkDeviceFunctionType is `Ethernet`.",
"iSCSI": "Boot this device by using the embedded iSCSI boot support and configuration. Only applicable if the NetworkDeviceFunctionType is `iSCSI`."
},
"type": "string"
},
"BootTargets": {
"additionalProperties": false,
"description": "A Fibre Channel boot target configured for a network device function.",
"longDescription": "This type shall describe a Fibre Channel boot target configured for a network device function.",
"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": {
"BootPriority": {
"description": "The relative priority for this entry in the boot targets array.",
"longDescription": "This property shall contain the relative priority for this entry in the boot targets array. Lower numbers shall represent higher priority, with zero being the highest priority. The BootPriority shall be unique for all entries of the BootTargets array.",
"readonly": false,
"type": [
"integer",
"null"
]
},
"LUNID": {
"description": "The logical unit number (LUN) ID from which to boot on the device to which the corresponding WWPN refers.",
"longDescription": "This property shall contain the logical unit number (LUN) ID from which to boot on the device to which the corresponding WWPN refers.",
"readonly": false,
"type": [
"string",
"null"
]
},
"WWPN": {
"description": "The World Wide Port Name (WWPN) from which to boot.",
"longDescription": "This property shall contain World Wide Port Name (WWPN) from which to boot.",
"readonly": false,
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Ethernet": {
"additionalProperties": false,
"description": "This type describes Ethernet capabilities, status, and configuration for a network device function.",
"longDescription": "This type shall describe the Ethernet capabilities, status, and configuration values for a network device function.",
"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": {
"MACAddress": {
"description": "The currently configured MAC address.",
"longDescription": "This property shall contain the effective current MAC address of this network device function. If an assignable MAC address is not supported, this is a read-only alias of the PermanentMACAddress.",
"pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$",
"readonly": false,
"type": [
"string",
"null"
]
},
"MTUSize": {
"description": "The maximum transmission unit (MTU) configured for this network device function.",
"longDescription": "The maximum transmission unit (MTU) configured for this network device function. This value serves as a default for the OS driver when booting. The value only takes effect on boot.",
"readonly": false,
"type": [
"integer",
"null"
]
},
"PermanentMACAddress": {
"description": "The permanent MAC address assigned to this function.",
"longDescription": "This property shall contain the permanent MAC Address of this function. Typically, this value is programmed during manufacturing. This address is not assignable.",
"pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$",
"readonly": true,
"type": [
"string",
"null"
]
},
"VLAN": {
"$ref": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterface.json#/definitions/VLAN",
"description": "If this network interface supports more than one VLAN, this property is not present. VLANs collections appear in the Link section of this Resource.",
"longDescription": "This property shall contain the VLAN for this interface. If this interface supports more than one VLAN, the VLAN property shall not be present and the VLANS collection link shall be present instead.",
"versionAdded": "v1_3_0"
},
"VLANs": {
"$ref": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterfaceCollection.json#/definitions/VLanNetworkInterfaceCollection",
"description": "The link to a collection of VLANs. This property is used only if the interface supports more than one VLAN.",
"longDescription": "This property shall contain a link to a collection of VLANs. If this property is used, the VLANEnabled and VLANId property shall not be used.",
"readonly": true,
"versionAdded": "v1_3_0"
}
},
"type": "object"
},
"FibreChannel": {
"additionalProperties": false,
"description": "This type describes Fibre Channel capabilities, status, and configuration for a network device function.",
"longDescription": "This type shall describe the Fibre Channel capabilities, status, and configuration values for a network device function.",
"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": {
"AllowFIPVLANDiscovery": {
"description": "An indication of whether the FCoE Initialization Protocol (FIP) populates the FCoE VLAN ID.",
"longDescription": "For FCoE connections, this boolean property shall indicate whether the FIP VLAN Discovery Protocol determines the FCoE VLAN ID selected by the network device function for the FCoE connection. If `true` and the FIP VLAN discovery succeeds, the FCoEActiveVLANId property shall reflect the FCoE VLAN ID to use for all FCoE traffic. If `false` or if the FIP VLAN Discovery protocol fails, the FCoELocalVLANId shall be used for all FCoE traffic and the FCoEActiveVLANId shall reflect the FCoELocalVLANId.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"BootTargets": {
"description": "An array of Fibre Channel boot targets configured for this network device function.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/BootTargets"
},
{
"type": "null"
}
]
},
"longDescription": "This property shall contain an array of Fibre Channel boot targets configured for this network device function.",
"type": "array"
},
"FCoEActiveVLANId": {
"description": "The active FCoE VLAN ID.",
"longDescription": "For FCoE connections, this property shall contain `null` or a VLAN ID currently being used for FCoE traffic. When the FCoE link is down this value shall be null. When the FCoE link is up this value shall be either the FCoELocalVLANId property or a VLAN discovered through the FIP protocol.",
"maximum": 4094,
"minimum": 0,
"readonly": true,
"type": [
"integer",
"null"
]
},
"FCoELocalVLANId": {
"description": "The locally configured FCoE VLAN ID.",
"longDescription": "For FCoE connections, this property shall contain the VLAN ID configured locally by setting this property. This value shall be used for FCoE traffic to this network device function during boot unless AllowFIPVLANDiscovery is `true` and a valid FCoE VLAN ID is found through the FIP VLAN Discovery Protocol.",
"maximum": 4094,
"minimum": 0,
"readonly": false,
"type": [
"integer",
"null"
]
},
"FibreChannelId": {
"description": "The Fibre Channel ID that the switch assigns for this interface.",
"longDescription": "This property shall indicate the Fibre Channel ID that the switch assigns for this interface.",
"readonly": true,
"type": [
"string",
"null"
],
"versionAdded": "v1_3_0"
},
"PermanentWWNN": {
"description": "The permanent World Wide Node Name (WWNN) address assigned to this function.",
"longDescription": "This property shall contain the permanent World Wide Node Name (WWNN) of this function. Typically, this value is programmed during manufacturing. This address is not assignable.",
"readonly": true,
"type": [
"string",
"null"
]
},
"PermanentWWPN": {
"description": "The permanent World Wide Port Name (WWPN) address assigned to this function.",
"longDescription": "This property shall contain the permanent World Wide Port Name (WWPN) of this function. Typically, this value is programmed during manufacturing. This address is not assignable.",
"readonly": true,
"type": [
"string",
"null"
]
},
"WWNN": {
"description": "The currently configured World Wide Node Name (WWNN) address of this function.",
"longDescription": "This property shall contain the effective current World Wide Node Name (WWNN) of this function. If an assignable WWNN is not supported, this is a read-only alias of the permanent WWNN.",
"readonly": false,
"type": [
"string",
"null"
]
},
"WWNSource": {
"anyOf": [
{
"$ref": "#/definitions/WWNSource"
},
{
"type": "null"
}
],
"description": "The configuration source of the World Wide Names (WWN) for this World Wide Node Name (WWNN) and World Wide Port Name (WWPN) connection.",
"longDescription": "This property shall contain the configuration source of the World Wide Name (WWN) for this World Wide Node Name (WWNN) and World Wide Port Name (WWPN) connection.",
"readonly": false
},
"WWPN": {
"description": "The currently configured World Wide Port Name (WWPN) address of this function.",
"longDescription": "This property shall contain the effective current World Wide Port Name (WWPN) of this function. If an assignable WWPN is not supported, this is a read-only alias of the permanent WWPN.",
"readonly": false,
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"IPAddressType": {
"enum": [
"IPv4",
"IPv6"
],
"enumDescriptions": {
"IPv4": "IPv4 addressing is used for all IP-fields in this object.",
"IPv6": "IPv6 addressing is used for all IP-fields in this object."
},
"type": "string"
},
"Links": {
"additionalProperties": false,
"description": "The links to other Resources that are related to this Resource.",
"longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to 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": {
"Endpoints": {
"description": "An array of links to endpoints associated with this network device function.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint"
},
"longDescription": "The type shall contain an array property. The members of this array are Resources of the Endpoint type, which are associated with this network device function.",
"readonly": true,
"type": "array",
"versionAdded": "v1_2_0"
},
"Endpoints@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"PCIeFunction": {
"$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction",
"description": "The link to the PCIe function associated with this network device function.",
"longDescription": "This property shall contain a link of the PCIeFunction type that represents the PCIe function associated with this network device function.",
"readonly": true
},
"PhysicalPortAssignment": {
"$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPort.json#/definitions/NetworkPort",
"description": "The physical port to which this network device function is currently assigned.",
"longDescription": "This property shall contain the physical port to which this network device function is currently assigned. This value shall be one of the AssignablePhysicalPorts array members.",
"versionAdded": "v1_3_0"
}
},
"type": "object"
},
"NetworkDeviceFunction": {
"additionalProperties": false,
"description": "The NetworkDeviceFunction schema represents a logical interface that a network adapter exposes.",
"longDescription": "A network device function represents a logical interface that a network adapter exposes.",
"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"
},
"AssignablePhysicalPorts": {
"description": "An array of physical ports to which this network device function may be assigned.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPort.json#/definitions/NetworkPort"
},
"longDescription": "This property shall contain an array of physical ports to which this network device function may be assigned.",
"readonly": true,
"type": "array"
},
"AssignablePhysicalPorts@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"BootMode": {
"anyOf": [
{
"$ref": "#/definitions/BootMode"
},
{
"type": "null"
}
],
"description": "The boot mode configured for this network device function.",
"longDescription": "This property shall contain the boot mode configured for this network device function. If the value is not `Disabled`, this network device function shall be configured for boot by using the specified technology.",
"readonly": false
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"DeviceEnabled": {
"description": "An indication of whether the network device function is enabled.",
"longDescription": "This property shall indicate whether the network device function is enabled. The operating system shall not enumerate or see disabled network device functions.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"Ethernet": {
"$ref": "#/definitions/Ethernet",
"description": "The Ethernet capabilities, status, and configuration values for this network device function.",
"longDescription": "This property shall contain Ethernet capabilities, status, and configuration values for this network device function."
},
"FibreChannel": {
"$ref": "#/definitions/FibreChannel",
"description": "The Fibre Channel capabilities, status, and configuration values for this network device function.",
"longDescription": "This property shall contain Fibre Channel capabilities, status, and configuration values for this network device function."
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"Links": {
"$ref": "#/definitions/Links",
"description": "The links for this network device function.",
"longDescription": "This property shall contain the Links for this network device function."
},
"MaxVirtualFunctions": {
"description": "The number of virtual functions that are available for this network device function.",
"longDescription": "This property shall contain the number of virtual functions that are available for this network device function.",
"readonly": true,
"type": [
"integer",
"null"
]
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"readonly": true
},
"NetDevFuncCapabilities": {
"description": "An array of capabilities for this network device function.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/NetworkDeviceTechnology"
},
{
"type": "null"
}
]
},
"longDescription": "This property shall contain an array of capabilities for this network device function.",
"readonly": true,
"type": "array"
},
"NetDevFuncType": {
"anyOf": [
{
"$ref": "#/definitions/NetworkDeviceTechnology"
},
{
"type": "null"
}
],
"description": "The configured capability of this network device function.",
"longDescription": "This property shall contain the configured capability of this network device function.",
"readonly": false
},
"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."
},
"PhysicalPortAssignment": {
"$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPort.json#/definitions/NetworkPort",
"deprecated": "This property has been deprecated and moved to the Links section to avoid loops on expand.",
"description": "The physical port to which this network device function is currently assigned.",
"longDescription": "This property shall contain the physical port to which this network device function is currently assigned. This value shall be one of the AssignablePhysicalPorts array members.",
"readonly": true,
"versionDeprecated": "v1_3_0"
},
"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."
},
"VirtualFunctionsEnabled": {
"description": "An indication of whether single root input/output virtualization (SR-IOV) virtual functions are enabled for this network device function.",
"longDescription": "This property shall indicate whether single root input/output virtualization (SR-IOV) virtual functions are enabled for this network device function.",
"readonly": true,
"type": [
"boolean",
"null"
]
},
"iSCSIBoot": {
"$ref": "#/definitions/iSCSIBoot",
"description": "The iSCSI boot capabilities, status, and configuration values for this network device function.",
"longDescription": "This property shall contain iSCSI boot capabilities, status, and configuration values for this network device function."
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
},
"NetworkDeviceTechnology": {
"enum": [
"Disabled",
"Ethernet",
"FibreChannel",
"iSCSI",
"FibreChannelOverEthernet"
],
"enumDescriptions": {
"Disabled": "Neither enumerated nor visible to the operating system.",
"Ethernet": "Appears to the operating system as an Ethernet device.",
"FibreChannel": "Appears to the operating system as a Fibre Channel device.",
"FibreChannelOverEthernet": "Appears to the operating system as an FCoE device.",
"iSCSI": "Appears to the operating system as an iSCSI device."
},
"type": "string"
},
"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"
},
"WWNSource": {
"enum": [
"ConfiguredLocally",
"ProvidedByFabric"
],
"enumDescriptions": {
"ConfiguredLocally": "The set of FC/FCoE boot targets was applied locally through API or UI.",
"ProvidedByFabric": "The set of FC/FCoE boot targets was applied by the Fibre Channel fabric."
},
"type": "string"
},
"iSCSIBoot": {
"additionalProperties": false,
"description": "The iSCSI boot capabilities, status, and configuration for a network device function.",
"longDescription": "This type shall describe the iSCSI boot capabilities, status, and configuration values for a network device function.",
"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": {
"AuthenticationMethod": {
"anyOf": [
{
"$ref": "#/definitions/AuthenticationMethod"
},
{
"type": "null"
}
],
"description": "The iSCSI boot authentication method for this network device function.",
"longDescription": "This property shall contain the iSCSI boot authentication method for this network device function.",
"readonly": false
},
"CHAPSecret": {
"description": "The shared secret for CHAP authentication.",
"longDescription": "This property shall contain the shared secret for CHAP authentication.",
"readonly": false,
"type": [
"string",
"null"
]
},
"CHAPUsername": {
"description": "The user name for CHAP authentication.",
"longDescription": "This property shall containhe user name for CHAP authentication.",
"readonly": false,
"type": [
"string",
"null"
]
},
"IPAddressType": {
"anyOf": [
{
"$ref": "#/definitions/IPAddressType"
},
{
"type": "null"
}
],
"description": "The type of IP address being populated in the iSCSIBoot IP address fields.",
"longDescription": "This property shall contain the type of IP address being populated in the iSCSIBoot IP address fields. Mixing IPv6 and IPv4 addresses on the same network device function shall not be permissible.",
"readonly": false
},
"IPMaskDNSViaDHCP": {
"description": "An indication of whether the iSCSI boot initiator uses DHCP to obtain the initiator name, IP address, and netmask.",
"longDescription": "This property shall indicate whether the iSCSI boot initiator uses DHCP to obtain the initiator name, IP address, and netmask.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"InitiatorDefaultGateway": {
"description": "The IPv6 or IPv4 iSCSI boot default gateway.",
"longDescription": "This property shall contain the IPv6 or IPv4 iSCSI boot default gateway.",
"readonly": false,
"type": [
"string",
"null"
]
},
"InitiatorIPAddress": {
"description": "The IPv6 or IPv4 address of the iSCSI initiator.",
"longDescription": "This property shall contain the IPv6 or IPv4 address of the iSCSI boot initiator.",
"readonly": false,
"type": [
"string",
"null"
]
},
"InitiatorName": {
"description": "The iSCSI initiator name.",
"longDescription": "This property shall contain the iSCSI boot initiator name. This property should match formats defined in RFC3720 or RFC3721.",
"readonly": false,
"type": [
"string",
"null"
]
},
"InitiatorNetmask": {
"description": "The IPv6 or IPv4 netmask of the iSCSI boot initiator.",
"longDescription": "This property shall contain the IPv6 or IPv4 netmask of the iSCSI boot initiator.",
"readonly": false,
"type": [
"string",
"null"
]
},
"MutualCHAPSecret": {
"description": "The CHAP secret for two-way CHAP authentication.",
"longDescription": "This property shall contain the CHAP secret for two-way CHAP authentication.",
"readonly": false,
"type": [
"string",
"null"
]
},
"MutualCHAPUsername": {
"description": "The CHAP user name for two-way CHAP authentication.",
"longDescription": "This property shall contain the CHAP user name for two-way CHAP authentication.",
"readonly": false,
"type": [
"string",
"null"
]
},
"PrimaryDNS": {
"description": "The IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator.",
"longDescription": "This property shall contain the IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator.",
"readonly": false,
"type": [
"string",
"null"
]
},
"PrimaryLUN": {
"description": "The logical unit number (LUN) for the primary iSCSI boot target.",
"longDescription": "This property shall contain the logical unit number (LUN) for the primary iSCSI boot target.",
"readonly": false,
"type": [
"integer",
"null"
]
},
"PrimaryTargetIPAddress": {
"description": "The IPv4 or IPv6 address for the primary iSCSI boot target.",
"longDescription": "This property shall contain the IPv4 or IPv6 address for the primary iSCSI boot target.",
"readonly": false,
"type": [
"string",
"null"
]
},
"PrimaryTargetName": {
"description": "The name of the iSCSI primary boot target.",
"longDescription": "This property shall contain the name of the primary iSCSI boot target. This property should match formats defined in RFC3720 or RFC3721.",
"readonly": false,
"type": [
"string",
"null"
]
},
"PrimaryTargetTCPPort": {
"description": "The TCP port for the primary iSCSI boot target.",
"longDescription": "This property shall contain the TCP port for the primary iSCSI boot target.",
"readonly": false,
"type": [
"integer",
"null"
]
},
"PrimaryVLANEnable": {
"description": "An indication of whether the primary VLAN is enabled.",
"longDescription": "This property shall indicate whether this VLAN is enabled for the primary iSCSI boot target.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"PrimaryVLANId": {
"description": "The 802.1q VLAN ID to use for iSCSI boot from the primary target.",
"longDescription": "This property shall contain the 802.1q VLAN ID to use for iSCSI boot from the primary target. This VLAN ID is only used if PrimaryVLANEnable is true.",
"maximum": 4094,
"minimum": 0,
"readonly": false,
"type": [
"integer",
"null"
]
},
"RouterAdvertisementEnabled": {
"description": "An indication of whether IPv6 router advertisement is enabled for the iSCSI boot target.",
"longDescription": "This property shall indicate whether IPv6 router advertisement is enabled for the iSCSI boot target. This setting shall apply to only IPv6 configurations.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"SecondaryDNS": {
"description": "The IPv6 or IPv4 address of the secondary DNS server for the iSCSI boot initiator.",
"longDescription": "This property shall contain the IPv6 or IPv4 address of the secondary DNS server for the iSCSI boot initiator.",
"readonly": false,
"type": [
"string",
"null"
]
},
"SecondaryLUN": {
"description": "The logical unit number (LUN) for the secondary iSCSI boot target.",
"longDescription": "This property shall contain the logical unit number (LUN) for the secondary iSCSI boot target.",
"readonly": false,
"type": [
"integer",
"null"
]
},
"SecondaryTargetIPAddress": {
"description": "The IPv4 or IPv6 address for the secondary iSCSI boot target.",
"longDescription": "This property shall contain the IPv4 or IPv6 address for the secondary iSCSI boot target.",
"readonly": false,
"type": [
"string",
"null"
]
},
"SecondaryTargetName": {
"description": "The name of the iSCSI secondary boot target.",
"longDescription": "This property shall contain the name of the secondary iSCSI boot target. This property should match formats defined in RFC3720 or RFC3721.",
"readonly": false,
"type": [
"string",
"null"
]
},
"SecondaryTargetTCPPort": {
"description": "The TCP port for the secondary iSCSI boot target.",
"longDescription": "This property shall contain the TCP port for the secondary iSCSI boot target.",
"readonly": false,
"type": [
"integer",
"null"
]
},
"SecondaryVLANEnable": {
"description": "An indication of whether the secondary VLAN is enabled.",
"longDescription": "This property shall indicate whether this VLAN is enabled for the secondary iSCSI boot target.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"SecondaryVLANId": {
"description": "The 802.1q VLAN ID to use for iSCSI boot from the secondary target.",
"longDescription": "This property shall contain the 802.1q VLAN ID to use for iSCSI boot from the secondary target. This VLAN ID is only used if SecondaryVLANEnable is `true`.",
"maximum": 4094,
"minimum": 0,
"readonly": false,
"type": [
"integer",
"null"
]
},
"TargetInfoViaDHCP": {
"description": "An indication of whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.",
"longDescription": "This property shall indicate whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.",
"readonly": false,
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"owningEntity": "DMTF",
"release": "2018.2",
"title": "#NetworkDeviceFunction.v1_3_3.NetworkDeviceFunction"
}
|
