Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Complete list of FDI kernel options #2464

Merged
merged 3 commits into from
Sep 26, 2023
Merged

Complete list of FDI kernel options #2464

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7446c4f
Add list of FDI parameters
maximiliankolb Sep 25, 2023
77a545a
Remove leading whitespace
maximiliankolb Sep 25, 2023
4a03e10
Sort items in alphabetical order
maximiliankolb Sep 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 74 additions & 47 deletions guides/common/modules/con_unattended-use-customization-and-image-remastering.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,89 +5,116 @@ You can create a customized Discovery ISO to automate the image configuration pr
The Discovery image uses a Linux kernel for the operating system, which passes kernel parameters to configure the discovery service.
These kernel parameters include the following entries:

proxy.url::
The URL of {SmartProxyServer} or {ProjectServer} providing the Discovery service.
fdi.cachefacts::
Number of fact uploads without caching.
By default, {Project} does not cache any uploaded facts.

proxy.type::
The proxy type.
This is usually set to `proxy` to connect to {SmartProxyServer}.
This parameter also supports a legacy `foreman` option, where communication goes directly to {ProjectServer} instead of a {SmartProxyServer}.
fdi.countdown::
Number of seconds to wait until the text-user interface is refreshed after the initial discovery attempt.
This value defaults to 45 seconds.
Increase this value if the status page reports the IP address as `N/A`.

fdi.pxmac::
The MAC address of the primary interface in the format of `AA:BB:CC:DD:EE:FF`.
This is the interface you aim to use for communicating with {SmartProxyServer}.
In automated mode, the first NIC (using network identifiers in alphabetical order) with a link is used.
In semi-automated mode, a screen appears and requests you to select the correct interface.
fdi.dhcp_timeout::
NetworkManager DHCP timeout.
The default value is 300 seconds.

fdi.pxip, fdi.pxgw, fdi.pxdns::
Manually configures IP address (`fdi.pxip`), the gateway (`fdi.pxgw`), and the DNS (`fdi.pxdns`) for the primary network interface.
If your omit these parameters, the image uses DHCP to configure the network interface.
fdi.dns_nameserver::
Nameserver to use for DNS SRV record.

fdi.dns_ndots::
`ndots` option to use for DNS SRV record.

fdi.dns_search::
Search domain to use for DNS SRV record.

fdi.initnet::
By default, the image initializes all network interfaces (value `all`).
When this setting is set to `bootif`, only the network interface it was network-booted from will be initialized.

fdi.ipv4.method::
By default, NetworkManager IPv4 method setting is set to `auto`.
This option overrides it, set it to `ignore` to disable the IPv4 stack.
This option works only in DHCP mode.

fdi.ipv6.method::
By default, NetworkManager IPv6 method setting is set to `auto`.
This option overrides it, set it to `ignore` to disable the IPv6 stack.
This option only works in DHCP mode.

fdi.ipwait::
Duration in seconds to wait for IP to be available in HTTP proxy SSL cert start.
By default, {Project} waits for 120 seconds.

fdi.nmwait::
`nmcli -wait` option for NetworkManager.
By default, `nmcli` waits for 120 seconds.

fdi.proxy_cert_days::
Number of days the self-signed HTTPS cert is valid for.
By default, the certificate is valid for 999 days.

fdi.pxauto::
To set automatic or semi-automatic mode.
If set to 0, the image uses semi-automatic mode, which allows you to confirm your choices through a set of dialog options.
If set to 1, the image uses automatic mode and proceeds without any confirmation.

fdi.pxfactname1, fdi.pxfactname2 ... fdi.pxfactnameN::
Use to specify custom fact names.
Use to specify custom fact names.

fdi.pxfactvalue1, fdi.pxfactvalue2 ... fdi.pxfactvalueN::
The values for each custom fact.
The values for each custom fact.
Each value corresponds to a fact name.
For example, `fdi.pxfactvalue1` sets the value for the fact named with `fdi.pxfactname1`.

fdi.pxauto::
To set automatic or semi-automatic mode.
If set to 0, the image uses semi-automatic mode, which allows you to confirm your choices through a set of dialog options.
If set to 1, the image uses automatic mode and proceeds without any confirmation.
fdi.pxip, fdi.pxgw, fdi.pxdns::
Manually configures IP address (`fdi.pxip`), the gateway (`fdi.pxgw`), and the DNS (`fdi.pxdns`) for the primary network interface.
If your omit these parameters, the image uses DHCP to configure the network interface.

fdi.initnet::
By default, the image initializes all network interfaces (value `all`).
When this setting is set to `bootif`, only the network interface it was network-booted from will be initialized.
fdi.pxmac::
The MAC address of the primary interface in the format of `AA:BB:CC:DD:EE:FF`.
This is the interface you aim to use for communicating with {SmartProxyServer}.
In automated mode, the first NIC (using network identifiers in alphabetical order) with a link is used.
In semi-automated mode, a screen appears and requests you to select the correct interface.

fdi.rootpw::
By default, the `root` account is locked.
By default, the `root` account is locked.
Use this option to set a root password.
You can enter both clear and encrypted passwords.

fdi.ssh::
By default, the SSH service is disabled.
By default, the SSH service is disabled.
Set this to `1` or `true` to enable SSH access.

fdi.ipv4.method::
By default, NetworkManager IPv4 method setting is set to `auto`.
This option overrides it, set it to `ignore` to disable the IPv4 stack.
This option works only in DHCP mode.
fdi.uploadsleep::
Duration in seconds between facter runs.
By default, facter runs every 30 secondes.

fdi.ipv6.method::
By default, NetworkManager IPv6 method setting is set to `auto`.
This option overrides it, set it to `ignore` to disable the IPv6 stack.
This option only works in DHCP mode.
fdi.vlan.primary::
VLAN tagging ID to set for the primary interface.

fdi.zips::
Filenames with extensions to be downloaded and started during boot.
Filenames with extensions to be downloaded and started during boot.
For more information, see see xref:Extending_the_Discovery_Image_{context}[].

fdi.zipserver::
TFTP server to use to download extensions from.
TFTP server to use to download extensions from.
For more information, see see xref:Extending_the_Discovery_Image_{context}[].

fdi.countdown::
Number of seconds to wait until the text-user interface is refreshed after the initial discovery attempt.
This value defaults to 45 seconds.
Increase this value if the status page reports the IP address as `N/A`.

fdi.dhcp_timeout::
NetworkManager DHCP timeout.
The default value is 300 seconds.
proxy.type::
The proxy type.
This is usually set to `proxy` to connect to {SmartProxyServer}.
This parameter also supports a legacy `foreman` option, where communication goes directly to {ProjectServer} instead of a {SmartProxyServer}.

fdi.vlan.primary::
VLAN tagging ID to set for the primary interface.
proxy.url::
The URL of {SmartProxyServer} or {ProjectServer} providing the Discovery service.

.Using the `discovery-remaster` Tool to Remaster an OS Image

ifdef::satellite[]
{ProjectServer} provides the `discovery-remaster` tool in the `{fdi-package-name}` package.
This tool remasters the image to include these kernel parameters.
To remaster the image, run the `discovery-remaster` tool.
For example:
endif::[]

ifdef::foreman-el,katello[]
{ProjectServer} provides the `discovery-remaster` tool.
This tool remasters the image to include these kernel parameters.
Expand Down