.\" Automatically generated by Pandoc 2.17.1.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "wicked-firmware" "8" "Feb 28, 2023" "Wicked User Manual" ""
.hy
.SH NAME
.PP
wicked firmware - manage netif-firmware-discovery extensions
.SH SYNOPSIS
.PP
\f[V]wicked firmware [options] <action> \&...\f[R]
.SH DESCRIPTION
.SH OPTIONS
.TP
\f[V]--help\f[R], \f[V]-h\f[R]
show brief options and actions description and exit
.SH ACTIONS
.TP
\f[V]interfaces [options] [firmware name\&...|all]\f[R]
Shows all or specified firmware extension names and the interfaces names
they configure.
.RS
.PP
Options:
.TP
\f[V]--format\f[R], \f[V]-F\f[R] \f[V]<txt|xml>\f[R]
Show the firmware interfaces as \f[V]xml\f[R] or (default) \f[V]txt\f[R]
table.
.PP
Example output:
.IP
.nf
\f[C]
# wicked firmware interfaces
nbft            eth0 eth0.42
redfish         usb0
\f[R]
.fi
.IP
.nf
\f[C]
# wicked firmware interfaces -F xml
<interfaces>
  <firmware name=\[dq]nbft\[dq]>
    <interface>eth0</interface>
    <interface>eth0.42</interface>
  </firmware>
  <firmware name=\[dq]redfish\[dq]>
    <interface>usb0</interface>
  </firmware>
</interfaces>
\f[R]
.fi
.RE
.TP
\f[V]extensions [options] [firmware name\&...|all]\f[R]
Shows all or specified firmware extension names and their
enabled/disabled status.
.RS
.PP
Options:
.TP
\f[V]--format\f[R], \f[V]-F\f[R] \f[V]<txt|xml>\f[R]
Show the firmware extensions as \f[V]xml\f[R] override config or
(default) \f[V]txt\f[R] table.
.TP
\f[V]--expand\f[R], \f[V]-E\f[R]
Expand xml to a complete firmware discovery extension definition.
.PP
Example output:
.IP
.nf
\f[C]
# wicked firmware extensions
ibft            enabled
nbft            enabled
redfish         disabled
\f[R]
.fi
.IP
.nf
\f[C]
# wicked firmware extensions -F xml redfish
<config>
  <netif-firmware-discovery name=\[dq]redfish\[dq] enabled=\[dq]false\[dq]/>
</config>
\f[R]
.fi
.IP
.nf
\f[C]
# wicked firmware extensions -F xml -E ibft
<config>
  <netif-firmware-discovery name=\[dq]ibft\[dq]>
    <script name=\[dq]show-config\[dq] command=\[dq]/etc/wicked/extensions/ibft\[dq]/>
    <script name=\[dq]list-ifnames\[dq] command=\[dq]/etc/wicked/extensions/ibft -l\[dq]/>
  </netif-firmware-discovery>
</config>
\f[R]
.fi
.RE
.TP
\f[V]disable [options] <firmware name\&... |all>\f[R]
Disables the specified firmware extension(s)
.RS
.PP
Creates an xml override in the \f[V]/etc/wicked/client-firmware.xml\f[R]
file disabling the specified firmware extension(s) defined in the
\f[V]client.xml\f[R] or it\[cq]s includes.
.PP
Options:
.TP
\f[V]--format\f[R], \f[V]-F\f[R] \f[V]<txt|xml>\f[R]
Show the modified firmware extension overrides in requested format.
.TP
\f[V]--show\f[R], \f[V]-S\f[R]
Show the modified firmware extensions on stdandard output only (dry
run).
.RE
.TP
\f[V]enable [options] <firmware name\&... |all>\f[R]
Enables the specified firmware extension(s)
.RS
.PP
Creates an xml override in the \f[V]/etc/wicked/client-firmware.xml\f[R]
file enabling the specified firmware extension(s) defined in the
\f[V]client.xml\f[R] or it\[cq]s includes.
.PP
Options:
.TP
\f[V]--format\f[R], \f[V]-F\f[R] \f[V]<txt|xml>\f[R]
Show the modified firmware extension overrides in requested format.
.TP
\f[V]--show\f[R], \f[V]-S\f[R]
Show the modified firmware extensions on stdandard output only (dry
run).
.RE
.TP
\f[V]revert [options] <firmware name\&... |all>\f[R]
Reverts the enable-state override for specified firmware extension(s).
.RS
.PP
Reverts the enabled/disabled status to it\[cq]s default defined in
\f[V]client.xml\f[R] or it\[cq]s includes by removing the specified
firmware extension from the \f[V]/etc/wicked/client-firmware.xml\f[R]
config file.
.PP
Options:
.TP
\f[V]--format\f[R], \f[V]-F\f[R] \f[V]<txt|xml>\f[R]
Show the reverted firmware extension overrides in requested format.
.TP
\f[V]--show\f[R], \f[V]-S\f[R]
Show the reverted firmware extensions on stdandard output only (dry
run).
.RE
.SH COPYRIGHT
.PP
Copyright (C) 2023 SUSE LLC
.SH BUGS
.PP
Please report bugs as described at http://bugs.opensuse.org
.SH SEE ALSO
.PP
\f[B]\f[VB]wicked\f[B]\f[R](8), \f[B]\f[VB]wicked-redfish\f[B]\f[R](8),
\f[B]\f[VB]wicked-config\f[B]\f[R](5)
.SH AUTHORS
Marius Tomaschewski.