forked from openbmc/bmcweb
-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathmeson.options
More file actions
1394 lines (1285 loc) · 36.4 KB
/
meson.options
File metadata and controls
1394 lines (1285 loc) · 36.4 KB
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
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# BMCWEB_KVM
option(
'kvm',
type: 'feature',
value: 'enabled',
description: '''Enable the KVM host video WebSocket. Path is /kvm/0.
Video is from the BMCs /dev/videodevice.''',
)
# BMCWEB_TESTS
option(
'tests',
type: 'feature',
value: 'enabled',
description: 'Enable Unit tests for bmcweb',
)
# BMCWEB_VM_WEBSOCKET
option(
'vm-websocket',
type: 'feature',
value: 'enabled',
description: '''Enable the Virtual Media WebSocket. Path is /vm/0/0 and /nbd/<id> to
open the websocket. See
https://github.com/openbmc/jsnbd/blob/master/README.''',
)
option(
'redfish-use-3-digit-messageid',
type: 'feature',
value: 'disabled',
description: '''Prior to a bug fix, bmcweb exposed error messages with a
MessageId of Base.x.y.z.Message which was incorrect.
Enabling this option causes return codes to return the old
incorrect version for backward compatibility. Will be
removed Q2-2025''',
)
# BMCWEB_REST
option(
'shmem-platform-metrics',
type: 'feature',
value: 'disabled',
description: 'Enable/disable the platform metrics to collect all sensors reading over shared memory',
)
option(
'erot-reset',
type: 'feature',
value: 'disabled',
description: 'Enable/disable ERoT reset option',
)
option(
'vm-nbdproxy',
type: 'feature',
value: 'disabled',
description: 'Enable the Virtual Media WebSocket.',
)
option(
'rmedia',
type: 'feature',
value: 'enabled',
description: 'Enable the Rmedia Redfish API.',
)
option(
'rest',
type: 'feature',
value: 'disabled',
description: '''Enable Phosphor REST (D-Bus) APIs. Paths directly map
Phosphor D-Bus object paths, for example,
/xyz/openbmc_project/logging/entry/enumerate. See
https://github.com/openbmc/docs/blob/master/rest-api.md.''',
)
# BMCWEB_REDFISH
option(
'redfish',
type: 'feature',
value: 'enabled',
description: '''Enable Redfish APIs. Paths are under /redfish/v1/. See
https://github.com/openbmc/bmcweb/blob/master/DEVELOPING.md#redfish.''',
)
# BMCWEB_HOST_SERIAL_SOCKET
option(
'host-serial-socket',
type: 'feature',
value: 'enabled',
description: '''Enable host serial console WebSocket. Path is /console0.
See https://github.com/openbmc/docs/blob/master/console.md.''',
)
# BMCWEB_STATIC_HOSTING
option(
'static-hosting',
type: 'feature',
value: 'enabled',
description: '''Enable serving files from the /usr/share/www directory
as paths under /.''',
)
# BMCWEB_REDFISH_BMC_JOURNAL
option(
'redfish-bmc-journal',
type: 'feature',
value: 'enabled',
description: '''Enable BMC journal access through Redfish. Paths are under
/redfish/v1/Managers/bmc/LogServices/Journal.''',
)
# BMCWEB_REDFISH_CPU_LOG
option(
'redfish-cpu-log',
type: 'feature',
value: 'disabled',
description: '''Enable CPU log service transactions through Redfish. Paths
are under /redfish/v1/Systems/system/LogServices/Crashdump'.''',
)
# BMCWEB_REDFISH_DUMP_LOG
option(
'lldp-dedicated-ports',
type: 'feature',
value: 'disabled',
description: '''Enable LLDP information under the path of dedicated ports:
/v1/Managers/bmc/DedicatedNetworkPorts/1''',
)
option(
'redfish-dump-log',
type: 'feature',
value: 'disabled',
description: '''Enable Dump log service transactions through Redfish. Paths
are under /redfish/v1/Systems/system/LogServices/Dump
and /redfish/v1/Managers/bmc/LogServices/Dump''',
)
option(
'redfish-fdr-log',
type: 'feature',
value: 'disabled',
description: '''Enable FDR log service transactions through Redfish. Paths
are under /redfish/v1/Systems/bmc/LogServices/FDR''',
)
option(
'redfish-net-log',
type: 'feature',
value: 'disabled',
description: '''Enable NetIR debug dumps collection through Redfish.
Current devices supporting this feature are:
NVSwitch and NVLinkManagementNIC''',
)
# BMCWEB_REDFISH_DBUS_LOG
option(
'redfish-dbus-log',
type: 'feature',
value: 'enabled',
description: '''Enable DBUS log service transactions through Redfish. Paths
are under
/redfish/v1/Systems/system/LogServices/EventLog/Entries''',
)
# BMCWEB_EXPERIMENTAL_REDFISH_DBUS_LOG_SUBSCRIPTION
option(
'experimental-redfish-dbus-log-subscription',
type: 'feature',
value: 'enabled',
description: '''
Allows EventService subscriptions when the redfish-dbus-log option is
enabled.
This option is currently non-functional, given Redfish requirements for
MessageId support in Events.
Option will be removed begining of Q2-2025.
Should not be enabled on any production systems.
''',
)
# BMCWEB_REDFISH_HOST_LOGGER
option(
'redfish-host-logger',
type: 'feature',
value: 'enabled',
description: '''Enable host log service transactions based on
phosphor-hostlogger through Redfish. Paths are under
/redfish/v1/Systems/system/LogServices/HostLogger''',
)
option(
'redfish-manager-event-log',
type: 'feature',
value: 'enabled',
description: '''Enable Manager Event log service transactions through Redfish. Paths
are under /redfish/v1/Managers/bmc/LogServices/Eventlog''',
)
option(
'redfish-dbus-event',
type: 'feature',
value: 'disabled',
description: 'Enable Redfish event service pushes based on DBUS signals of DBUS log service transactions.',
)
option(
'redfish-enable-proccessor-memory-status',
type: 'feature',
value: 'enabled',
description: '''Enable/disable the deprecated processor and memory summary
status. The default condition is disabling the processor
and memory summary status. This option will be removed in
1Q 2024.''',
)
# BMCWEB_REDFISH_PROVISIONING_FEATURE
option(
'redfish-provisioning-feature',
type: 'feature',
value: 'disabled',
description: '''Enable provisioning feature support in redfish. Paths are
under /redfish/v1/Systems/system/''',
)
# BMCWEB_REDFISH_MANAGER_URI_NAME
option(
'redfish-manager-uri-name',
type: 'string',
value: 'bmc',
description: '''The static Redfish Manager ID representing the BMC
instance. This option will appear in the Redfish tree at
/redfish/v1/Managers/<redfish-manager-uri-name>.
Defaults to \'bmc\' which resolves to
/redfish/v1/Managers/bmc''',
)
# BMCWEB_REDFISH_SYSTEM_URI_NAME
option(
'redfish-system-uri-name',
type: 'string',
value: 'system',
description: '''The static Redfish System ID representing the host
instance. This option will appear in the Redfish tree at
/redfish/v1/Systems/<redfish-system-uri-name>.
Defaults to \'system\' which resolves to
/redfish/v1/Systems/system''',
)
# BMCWEB_LOGGING_LEVEL
option(
'bmcweb-logging',
type: 'combo',
choices: [
'disabled',
'enabled',
'debug',
'info',
'warning',
'error',
'critical',
],
value: 'error',
description: '''Enable output the extended logging level.
- disabled: disable bmcweb log traces.
- enabled: treated as 'debug'
- For the other logging level option, see DEVELOPING.md.''',
)
# BMCWEB_BASIC_AUTH
option(
'http-chunking',
type: 'feature',
value: 'disabled',
description: 'Enable bmcweb chunking.',
)
option(
'http-response-timeout',
type: 'integer',
value: 60,
description: 'The bmcweb response timeout in seconds.',
)
option(
'rsyslog-client',
type: 'feature',
value: 'disabled',
description: 'Enable rsyslog client',
)
option(
'basic-auth',
type: 'feature',
value: 'enabled',
description: 'Enable basic authentication',
)
# BMCWEB_SESSION_AUTH
option(
'session-auth',
type: 'feature',
value: 'enabled',
description: 'Enable session authentication',
)
# BMCWEB_XTOKEN_AUTH
option(
'xtoken-auth',
type: 'feature',
value: 'enabled',
description: 'Enable xtoken authentication',
)
# BMCWEB_COOKIE_AUTH
option(
'cookie-auth',
type: 'feature',
value: 'enabled',
description: 'Enable cookie authentication',
)
option(
'bmcweb-logging-log-level',
type: 'integer',
min: 0,
max: 4,
value: 3,
description: 'log level for bmcweb logging. Default is 3(Error and above). Enum Mapping Debug = 0, Info = 1, Warning = 2, Error = 3, Critical =4.',
)
option(
'mutual-tls-auth',
type: 'feature',
value: 'enabled',
description: '''Enables authenticating users through TLS client
certificates. The insecure-disable-ssl must be disabled for
this option to take effect.''',
)
# BMCWEB_MUTUAL_TLS_COMMON_NAME_PARSING_DEFAULT
option(
'mutual-tls-common-name-parsing-default',
type: 'combo',
choices: ['CommonName', 'Whole', 'UserPrincipalName'],
description: '''Default MTLS parse mode to get username from the
client's x509 certificate''',
)
# BMCWEB_IBM_MANAGEMENT_CONSOLE
option(
'ibm-management-console',
type: 'feature',
value: 'disabled',
description: '''Enable the IBM management console specific functionality.
Paths are under /ibm/v1/''',
)
# BMCWEB_GOOGLE_API
option(
'google-api',
type: 'feature',
value: 'disabled',
description: '''Enable the Google specific functionality. Paths are under
/google/v1/''',
)
# BMCWEB_HTTP_BODY_LIMIT
option(
'http-body-limit',
type: 'integer',
min: 0,
max: 512,
value: 30,
description: 'Specifies the http request body length limit',
)
# BMCWEB_FIRMWARE_IMAGE_LIMIT
option(
'firmware-image-limit',
type: 'integer',
min: 0,
max: 512,
value: 30,
description: 'Specifies the firmware image size limit',
)
# BMCWEB_HTTP_ZSTD
option(
'http-zstd',
type: 'feature',
value: 'enabled',
description: 'Allows compression/decompression using zstd',
)
# BMCWEB_REDFISH_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM
option(
'redfish-new-powersubsystem-thermalsubsystem',
type: 'feature',
value: 'enabled',
description: '''Enable/disable the new PowerSubsystem, ThermalSubsystem,
and all children schemas. This includes displaying all
sensors in the SensorCollection.''',
)
# BMCWEB_REDFISH_ALLOW_DEPRECATED_POWER_THERMAL
option(
'redfish-allow-deprecated-power-thermal',
type: 'feature',
value: 'enabled',
description: '''Enable/disable the old Power / Thermal. The default
condition is allowing the old Power / Thermal. This
will be disabled by default June 2024. ''',
)
# BMCWEB_REDFISH_OEM_MANAGER_FAN_DATA
option(
'redfish-post-to-old-updateservice',
type: 'feature',
value: 'enabled',
description: '''Allows POST to /redfish/v1/UpdateService, counter to
the redfish specification. Option provided to allow
potential users to move away from using this endpoint.
Option will be removed Q4 2022.''',
)
option(
'redfish-oem-manager-fan-data',
type: 'feature',
value: 'enabled',
description: '''Enables Redfish OEM fan data on the manager resource.
This includes PID and Stepwise controller data. See
OpenBMCManager schema for more detail.''',
)
# BMCWEB_REDFISH_UPDATESERVICE_USE_DBUS
option(
'redfish-updateservice-use-dbus',
type: 'feature',
value: 'disabled',
description: '''Enables xyz.openbmc_project.Software.Update D-Bus interface
to propagate UpdateService requests to the corresponding
updater daemons instead of moving files to /tmp/images dir.
''',
)
# BMCWEB_REDFISH_ALLOW_FW_INVENTORY_PATCH
option(
'redfish-allow-fw-inventory-patch',
type: 'feature',
value: 'enabled',
description: '''Enables the WriteProtected property on firmware inventory
components to be PATCHable''',
)
# BMCWEB_REDFISH_ALLOW_SIMPLE_UPDATE
option(
'redfish-allow-simple-update',
type: 'feature',
value: 'disabled',
description: '''Enables Redfish UpdateService SimpleUpdate Action. Note
that at this time this option is non-functional. Redfish
recommends using MultiPartUpdate.''',
)
option(
'redfish-health-populate',
type: 'feature',
value: 'enabled',
description: '''Enables HealthPopulate and generate the Status property for
the resource. This option will be removed Q1 2024''',
)
option(
'https_port',
type: 'integer',
min: -1,
max: 65535,
value: 443,
description: '''HTTPS default port number. Set to -1 to disable and rely
only on additional_ports''',
)
# Additional ports
# This series of options below allows setting up non-trivial deployments of
# bmcweb, binding specific ports, authentication profiles, and device binds to
# multiple ports.
# Setting these options incorrectly can have severe security consequences and
# should be reserved for platform experts familiar with their particular
# platforms security requirements.
option(
'additional-ports',
type: 'array',
value: [],
description: '''Additional ports to listen to. Allows bmcweb to listen to
multiple ports at a given protocol''',
)
option(
'additional-protocol',
type: 'array',
value: [],
description: '''Allows specifying a specific protocol type for a given
additional-ports index. Allows setting http, https, or both
to each socket index. If not provided for a given
additional-ports index, assumes https.''',
)
option(
'additional-bind-to-device',
type: 'array',
value: [],
description: '''Allows specifying an SO_BINDTODEVICE or BindToDevice systemd
directive for each additional socket file. If not provided
for a given additional-ports index, assumes bind to all
devices''',
)
option(
'additional-auth',
type: 'array',
value: [],
description: '''Allows specifying an authentication profile for each socket
created with additional-ports. Allows auth or noauth, and
defaults to auth if not provided. If noauth is provided,
authentication will not be performed for a given socket/port
index.''',
)
# end additional ports
# BMCWEB_DNS_RESOLVER
option(
'dns-resolver',
type: 'combo',
choices: ['systemd-dbus', 'asio'],
value: 'systemd-dbus',
description: '''Sets which DNS resolver backend should be used.
systemd-dbus uses the Systemd ResolveHostname on dbus, but requires dbus
support. asio relies on boost::asio::tcp::resolver, but cannot resolve
names when boost threading is disabled.''',
)
# BMCWEB_REDFISH_AGGREGATION
option(
'redfish-aggregation',
type: 'feature',
value: 'disabled',
description: 'Allows this BMC to aggregate resources from satellite BMCs',
)
# BMCWEB_REDFISH_AGGREGATION_PREFIX_REMOVAL
option(
'redfish-aggregation-prefix-removal',
type: 'feature',
value: 'disabled',
description: 'Remove the prefix if the resources prefix from FirmwareInventory is the same with RFA prefix.',
)
# BMCWEB_HYPERVISOR_COMPUTER_SYSTEM
option(
'hypervisor-computer-system',
type: 'feature',
value: 'disabled',
description: '''This puts a hypervisor computer system resource at
/redfish/v1/Systems/hypervisor. This system resource has children
resources such as EthernetInterfaces and ComputerSystem.Reset.''',
)
# BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM
option(
'enforce_sensor_name_format',
type: 'feature',
value: 'enabled',
description: 'Enable or disable enforcement of sensor name format',
)
option(
'redfish-sw-einj',
type: 'feature',
value: 'disabled',
description: '''Enable SWEINJ Actions through Redfish. The Schema definition reference is
/schemas/v1/JsonSchemas/NvidiaManager.v1_4_0.json#/definitions/SWErrorInjection''',
)
option(
'nvidia-manager-ready-csm',
type: 'feature',
value: 'disabled',
description: '''Enable checking for Configurable state manager in addition to systemd service
state when checking the starting state.''',
)
option(
'power-control-type-percentage',
type: 'feature',
value: 'disabled',
description: 'set power control SetPointUnits to percentage.',
)
option(
'redfish-aggregation-prefix',
type: 'string',
value: '5B247A',
description: 'redfish aggregation prefix',
)
option(
'rfa-hmc-update-target',
type: 'string',
value: 'HGX_Chassis_0',
description: 'the update target to update all HMC components',
)
option(
'rfa-bmc-host-url',
type: 'string',
value: 'http://bmc_ip:8080/',
description: 'BMC url to receive redfish events from satellite BMC',
)
option(
'rfa-delay-subscribe-time',
type: 'integer',
min: 5,
max: 300,
value: 60,
description: 'the deferred time to subscribe HMC EventService',
)
option(
'health-rollup-alternative',
type: 'feature',
value: 'disabled',
description: 'Enable health rollup alternative with support of xyz.openbmc_project.State.Decorator.Health interface and health_rollup association.',
)
option(
'disable-health-rollup',
type: 'feature',
value: 'disabled',
description: 'Disable health rollup.',
)
option(
'disable-conditions-array',
type: 'feature',
value: 'disabled',
description: 'Disable conditions array.',
)
option(
'nvidia-oem-properties',
type: 'feature',
value: 'disabled',
description: 'Enable OEM properties.',
)
option(
'nvidia-oem-logservices',
type: 'feature',
value: 'disabled',
description: 'Enable OEM log services.',
)
option(
'nvidia-oem-bf-properties',
type: 'feature',
value: 'disabled',
description: 'Enable OEM Bluefield properties',
)
option(
'nvidia-oem-bf3-properties',
type: 'feature',
value: 'disabled',
description: 'Enable OEM Bluefield 3 properties',
)
option(
'nvidia-oem-gb200nvl-properties',
type: 'feature',
value: 'disabled',
description: 'Enable OEM GB200Nvl properties',
)
option(
'nvidia-oem-common-properties',
type: 'feature',
value: 'disabled',
description: 'Enable OEM Nvidia common properties.',
)
option(
'nvidia-oem-pmc',
type: 'feature',
value: 'disabled',
description: 'Enable Nvidia Power Compliance Managers',
)
option(
'nvidia-oem-policies',
type: 'feature',
value: 'disabled',
description: 'Enable Nvidia Policies',
)
option(
'nvidia-retimer-debugmode',
type: 'feature',
value: 'disabled',
description: 'Enable Nvidia retimer debug mode.',
)
option(
'nvidia-network-adapter-prefix',
type: 'string',
value: 'NIC_',
description: 'Prefix used for network adapter name',
)
option(
'nvidia-network-adapter-link-prefix',
type: 'string',
value: 'Port_',
description: 'Prefix used for links name on network adapter',
)
option(
'nvidia-oem-device-status-from-file',
type: 'feature',
value: 'disabled',
description: 'Enable OEM Nvidia device status properties from file.',
)
option(
'nvidia-device-status-from-association',
type: 'feature',
value: 'disabled',
description: 'Enable OEM Nvidia device status properties from associations.',
)
option(
'nvidia-uuid-from-platform-chassis-name',
type: 'feature',
value: 'disabled',
description: 'Enable UUID properties from platform chassis name.',
)
option(
'nvidia-host-management-network-access',
type: 'feature',
value: 'disabled',
description: 'Enable OEM Host management NIC.',
)
option(
'manager-usb-ports',
type: 'feature',
value: 'disabled',
description: 'Enable USB port enable/disable control at Managers/{id}/USBPorts.',
)
option(
'nvidia-bootentryid',
type: 'feature',
value: 'disabled',
description: 'Enable OEM Nvidia BootEntryID for phosphor-logging based logs.',
)
option(
'nvidia-api-metrics',
type: 'feature',
value: 'disabled',
description: 'Enable API metrics logging for Redfish requests.',
)
option(
'stalesensor-upper-limit-milisecond',
type: 'integer',
min: 1,
max: 65535,
value: 750,
description: 'Upper limit in miliseconds to determine the staleness of sensor reading',
)
option(
'platform-metrics-sensing-interval',
type: 'integer',
min: 1,
max: 65535,
value: 250,
description: 'Platform metrics telemetry sensor refresh interval in milliseconds',
)
option(
'platform-system-id',
type: 'string',
value: 'system',
description: 'Platform specific computer system id',
)
option(
'platform-system-description',
type: 'string',
value: 'Computer System',
description: 'Platform specific computer system description',
)
option(
'platform-network-adapter',
type: 'string',
value: 'networkadapter',
description: 'Platform network adapter',
)
option(
'host-eth-iface',
type: 'feature',
value: 'disabled',
description: 'Enable Host Ethernet Interface',
)
option(
'network-adapters',
type: 'feature',
value: 'disabled',
description: 'Enable NetworkAdapters',
)
option(
'network-adapters-generic',
type: 'feature',
value: 'disabled',
description: 'Enable Generic NetworkAdapters',
)
option(
'platform-total-power-sensor-name',
type: 'string',
value: 'TotalHSC_Power',
description: 'Platform specific total power sensor name, which has system power watts readings',
)
option(
'platform-power-control-sensor-name',
type: 'string',
value: 'total_power',
description: 'Platform specific total power control sensor name, which has system current power watts readings',
)
option(
'platform-metrics-id',
type: 'string',
value: 'PlatformMetrics',
description: 'Platform specific telemetry service metric reports id',
)
option(
'platform-device-prefix',
type: 'string',
value: 'device-prefix',
description: 'Platform specific device name prefix',
)
option(
'platform-gpu-name-prefix',
type: 'string',
value: 'GPU_SXM_',
description: 'Platform specific GPU name prefix',
)
option(
'platform-chassis-name',
type: 'string',
value: 'HGX_Chassis_0',
description: 'Platform specific chassis name',
)
option(
'platform-chassis-intrusion-component',
type: 'string',
value: '',
description: 'Platform specific intrusion component',
)
option(
'tls-auth-opt-in',
type: 'feature',
value: 'disabled',
description: 'Enables feature to opt-in to TLS-Authentication at runtime.',
)
option(
'nvidia-dot-cak-initialization',
type: 'feature',
value: 'disabled',
description: 'Expose DOT CAK initialization state in Systems OEM.',
)
option(
'host-os-features',
type: 'feature',
value: 'enabled',
description: 'Enables feature specific to host os.',
)
option(
'hide-host-os-features-init-value',
type: 'feature',
value: 'disabled',
description: 'Enables feature specific to host os with an initial value',
)
option(
'host-auxpower-features',
type: 'feature',
value: 'disabled',
description: 'disabled feature specific to host aux power.',
)
option(
'redfish-cables',
type: 'feature',
value: 'disabled',
description: 'Enables Redfish Cables and CableCollection routes.',
)
option(
'redfish-system-faultlog-dump-log',
type: 'feature',
value: 'disabled',
description: 'Enable Redfish System faultlog dump log services.',
)
option(
'reset-bios-by-clear-nonvolatile',
type: 'feature',
value: 'disabled',
description: 'Enable using DBUS xyz.openbmc_project.Control.Boot.ClearNonVolatileVariables for Bios.ResetBios action.',
)
option(
'fencing-privilege',
type: 'feature',
value: 'disabled',
description: 'Enables feature to set/unset the fencing privilege to satelite BMC.',
)
option(
'dot-support',
type: 'feature',
value: 'disabled',
description: 'Enables DOT token support.',
)
option(
'debug-interface-support',
type: 'feature',
value: 'disabled',
description: 'Enables debug interface support.',
)
option(
'nvidia-oem-openocd',
type: 'feature',
value: 'disabled',
description: 'Enable OpenOCD service.',
)
option(
'experimental-redfish-multi-computer-system',
type: 'feature',
value: 'disabled',
description: '''This is a temporary option flag for staging the
ComputerSystemCollection transition to multi-host. It, as well as the code
still beneath it will be removed on 1/1/2026. Do not enable in a
production environment, or where API stability is required.''',
)
# BMCWEB_HTTP2
option(
'http2',
type: 'feature',
value: 'enabled',
description: 'Enable HTTP/2 protocol support using nghttp2.',
)
option(
'manual-boot-mode-support',
type: 'feature',
value: 'disabled',
description: 'Enables support for ERoT manual boot mode',
)
# BMCWEB_WATCHDOG_TIMEOUT
option(
'watchdog-timeout-seconds',
type: 'integer',
min: 0,
max: 600,
value: 120,
description: '''Specifies the systemd watchdog timeout interval in seconds.
Set to 0 to disable the watchdog.''',
)
# Insecure options. Every option that starts with a `insecure` flag should
# not be enabled by default for any platform, unless the author fully comprehends
# the implications of doing so.In general, enabling these options will cause security
# problems of varying degrees
# BMCWEB_INSECURE_DISABLE_CSRF
option(
'insecure-disable-csrf',
type: 'feature',
value: 'disabled',
description: '''Disable CSRF prevention checks.Should be set to false for
production systems.''',
)
# BMCWEB_INSECURE_DISABLE_SSL
option(
'insecure-disable-ssl',
type: 'feature',
value: 'disabled',
description: '''Disable SSL ports. Should be set to false for production
systems.''',
)
# BMCWEB_INSECURE_DISABLE_AUTH
option(
'insecure-disable-auth',
type: 'feature',
value: 'disabled',
description: '''Disable authentication and authoriztion on all ports.
Should be set to false for production systems.''',
)
option(
'profiles-feature',
type: 'feature',
value: 'disabled',
description: 'Enable profiles feature.',
)
option(
'push-smbios-table-feature',
type: 'feature',
value: 'disabled',
description: '''Enable Redfish OEM action to update SMBIOS table in BMC.
This feature allows pushing system information, encapsulated
in an SMBIOS table blob, to the BMC through the Redfish API.
The action requires the session having BIOS privileges.
The SMBIOS table blob is limited to 64KB.''',