1wicked-redfish(8)                                            wicked-redfish(8)
2
3
4

NAME

6       wicked redfish - redfish network host interface configuration utilities
7

SYNOPSIS

9       wicked redfish [options] <action>
10

DESCRIPTION

12       The Redfish Network Host Interface defined by the DMTF Redfish Host In‐
13       terface Specification enables the software running on a computer system
14       to access the Redfish Service, which can be used to manage that comput‐
15       er system.
16
17       Machines supporting a Redfish Network Host Interface, provide an SMBIOS
18       (3.0) Management Controller Host Interface (Type 42) structure contain‐
19       ing a Device Description of the Network (Type 40h) Interface and  “Red‐
20       fish over IP” Protocol (Type 04h) records with the configuration to use
21       for this network interface, visible in e.g. `dmidecode -t 42' output.
22
23       The Redfish Network Host Interface needs to be enabled  and/or  config‐
24       ured in the Management Controller (BMC, firmware, ...) – please consult
25       the machine vendor documentation for  further  details.   With  enabled
26       Redfish Network Host Interface in the Management Controller, the SMBIOS
27       structure and the network interface (usb, pci) are available/appear  in
28       the  system  (e.g. `hwinfo  --netcard'  or  `lsusb',  `lspci', `ip link
29       show').
30
31       The `wicked redfish' command implements utility  actions  decoding  the
32       SMBIOS  structures  to  configure the Network Host Interface with these
33       settings, used by other parts of wicked.
34
35       The automatic setup of the Redfish Network Host Interface  from  SMBIOS
36       settings with wicked is (currently) disabled by default, use the:
37
38                 wicked redfish enable
39
40       command to enable it once.
41
42       When  enabled,  the `wicked ifup', `wicked ifreload', `wicked show-con‐
43       fig' and related commands to setup/shutdown interfaces as well  as  the
44       `systemctl'  (start,  stop,  reload)  actions  to the `network.service'
45       (alias to an enabled `wicked.service') will consider the  Redfish  Net‐
46       work Host Interfaces.
47

OPTIONS

49       --help, -h
50              show short options and actions description and exit
51

ACTIONS

53       enable Enables the redfish network host interface setup.
54
55              Creates  an  /etc/wicked/client-redfish.xml  configuration  file
56              adding the `redfish-config' extension to the “firmware:” (netif-
57              firmware-discovery)  configuration  source set, to decode SMBIOS
58              as a “firmware:redfish” wicked interface configuration requested
59              by/during e.g. `wicked ifup all' run.
60
61       disable
62              Disables the redfish network host interface setup.
63
64              Deletes the /etc/wicked/client-redfish.xml configuration file.
65
66   Utility actions
67       show-config
68              Decodes  the  SMBIOS  structures with the Network Host Interface
69              reference and “Redfish over IP” protocol settings  as  a  wicked
70              “firmware:redfish” configuration.
71
72              An  underlying command used by an (enabled) `redfish-config' ex‐
73              tension providing configuration to  `wicked  ifup'  and  related
74              commands.
75
76       list-ifnames
77              Decodes  the  SMBIOS structures and shows the referenced network
78              host and the vlan interface name – if vlan  is  defined  by  the
79              redfish protocol.
80
81       hosts-update
82              Decodes  the  Redfish Service IP and Hostname from SMBIOS struc‐
83              ture and updates the redfish-localhost entries in /etc/hosts.
84
85              Implements the “post-up” action of the  `redfish-update'  script
86              hook  used  in  the “firmware:redfish” configuration executed at
87              the end of an ifup run.
88
89       hosts-remove
90              Removes the redfish-localhost entries from /etc/hosts.
91
92              Implements the “pre-down” action of the `redfish-update'  script
93              hook  used  in  the “firmware:redfish” configuration executed in
94              ifdown run.
95

EXAMPLE

97       An Redfish Network Host  Interface  SMBIOS  settings  using  DHCPv4  by
98       dmidecode:
99
100              # dmidecode -t 42
101              Management Controller Host Interface
102                  Host Interface Type: Network
103                  Device Type: USB
104                      idVendor: 0x03f0
105                      idProduct: 0x2927
106                      Protocol ID: 04 (Redfish over IP)
107                          Service UUID: 8388efa4-6501-53a1-a1da-b6ee02cebbdf
108                          Host IP Assignment Type: DHCP
109                          Host IP Address Format: IPv4
110                          Redfish Service IP Discovery Type: DHCP
111                          Redfish Service IP Address Format: IPv4
112                          Redfish Service Hostname: virt152-sp
113
114       The  network  interface  name (as identified in the `hwinfo --netcard')
115       output is:
116
117              # ip link show dev usb0
118              11: usb0: <BROADCAST,MULTICAST> mtu 1500 qdisc pfifo_fast state DOWN mode DEFAULT group default qlen 1000
119                  link/ether 3a:d8:86:7c:01:64 brd ff:ff:ff:ff:ff:ff
120
121       The network interface name(s) can be identified/resolved by wicked:
122
123              # wicked redfish list-ifnames
124              usb0
125
126       The Redfish Network Host Interface SMBIOS settings decoded by wicked to
127       an interface config:
128
129              # wicked redfish show-config
130              <interface origin="firmware:redfish">
131                <name>usb0</name>
132                <scripts>
133                  <post-up>
134                    <script>wicked:redfish-update</script>
135                  </post-up>
136                  <pre-down>
137                    <script>wicked:redfish-update</script>
138                  </pre-down>
139                </scripts>
140                <ipv4>
141                  <enabled>true</enabled>
142                </ipv4>
143                <ipv4:dhcp>
144                  <enabled>true</enabled>
145                  <update/>
146                </ipv4:dhcp>
147              </interface>
148
149       Once  the Redfish Network Host Interface setup with wicked has been en‐
150       abled with:
151
152              # wicked redfish enable
153
154       The `wicked show-config' command contains the (same  as  above)  wicked
155       configuration for the usb0 interface and commands setting up interfaces
156       are considering it:
157
158              # wicked ifreload all
159              usb0            device-ready
160              usb0            up
161              # wicked ifstatus usb0
162              usb0            up
163                    link:     #11, state up, mtu 1500
164                    type:     ethernet, hwaddr 3a:d8:86:7c:01:64
165                    config:   firmware:redfish
166                    leases:   ipv4 dhcp granted
167                    addr:     ipv4 16.1.15.2/30 [dhcp]
168              # grep redfish-localhost /etc/hosts
169              16.1.15.1   redfish-localhost virt152-sp
170
171       After disabling of  the  Redfish  Network  Host  Interface  setup  with
172       wicked,  the  `wicked  show-config' command stops to show the interface
173       configuration and the commands to setup interfaces will (shut  it  down
174       if still active and) stop to consider it in interface setup:
175
176              # wicked redfish disable
177              # wicked ifreload all
178              usb0            device-ready
179              # grep redfish-localhost /etc/hosts
180              # wicked ifstatus usb0
181              usb0            device-unconfigured
182                    link:     #11, state down, mtu 1500
183                    type:     ethernet, hwaddr 3a:d8:86:7c:01:64
184              # ip link show dev usb0
185              11: usb0: <BROADCAST,MULTICAST> mtu 1500 qdisc pfifo_fast state DOWN mode DEFAULT group default qlen 1000
186                  link/ether 3a:d8:86:7c:01:64 brd ff:ff:ff:ff:ff:ff
187              # wicked ifreload all
188              wicked: ifreload: no configuration changes to reload
189

NOTES

191       The implementation is based on the following specifications:
192
193       • DMTF  DSP0134,  System  Management  BIOS Reference Specification (SM‐
194         BIOS), Version 3.5.0
195
196https://www.dmtf.org/standards/smbios,
197           https://www.dmtf.org/dsp/DSP0134
198
199       • DMTF DSP0270, Redfish Host Interface Specification, Version 1.3.0
200
201https://www.dmtf.org/standards/redfish,
202           https://www.dmtf.org/dsp/DSP0270
203
204       and covers decoding of the (raw) SMBIOS Type 42 structures  from  sysfs
205       files (/sys/firmware/dmi/tables/smbios_entry_point and DMI) with:
206
207       • Network Host Interface (40h) Device Description Data for:
208
209         • USB Network Interface
210
211         • PCI/PCIe Network Interface
212
213         • USB Network Interface v2
214
215       • Multiple Redfish over IP Protocol records with
216
217         • Static, DHCP, AutoConfigure Assignment/Discovery Types for IPv4 and
218           IPv6
219
220       • Merge of multiple SMBIOS structures for the same device
221
222       Not yet implemented are:
223
224       • “Preferred IP” Address in AutoConfigure
225
226       • PCI/PCIe Network Interface v2
227
228       • Credential Bootstrapping
229
231       Copyright (C) 2022 SUSE LLC
232

BUGS

234       Please report bugs as described at http://bugs.opensuse.org
235

SEE ALSO

237       wicked(8), wicked-config(5)
238

AUTHORS

240       Marius Tomaschewski.
241
242
243
244Wicked User Manual               Apr 12, 2021                wicked-redfish(8)
Impressum