Managing hosts adding network interfaces

guides/common/assembly_managing-network-interfaces.adoc

@@ -1,11 +1,13 @@
-include::modules/con_adding-network-interfaces.adoc[]
+include::modules/con_configuring-network-interfaces.adoc[]
 
-include::modules/proc_adding-a-physical-interface.adoc[leveloffset=+1]
+include::modules/con_network-interface-configuration-options.adoc[leveloffset=+1]
 
-include::modules/proc_adding-a-virtual-interface.adoc[leveloffset=+1]
+include::modules/proc_configuring-a-physical-interface.adoc[leveloffset=+1]
 
-include::modules/proc_adding-a-bonded-interface.adoc[leveloffset=+1]
+include::modules/proc_configuring-a-virtual-interface.adoc[leveloffset=+1]
+
+include::modules/proc_configuring-a-bonded-interface.adoc[leveloffset=+1]
 
 include::modules/ref_bonding-modes-available-in-project.adoc[leveloffset=+1]
 
-include::modules/proc_adding-a-bmc-interface.adoc[leveloffset=+1]
+include::modules/proc_configuring-a-bmc-interface.adoc[leveloffset=+1]

guides/common/modules/con_adding-network-interfaces.adoc → guides/common/modules/con_configuring-network-interfaces.adoc

@@ -1,31 +1,25 @@
-[id="Adding_Network_Interfaces_{context}"]
-= Adding network interfaces
+[id="Configuring_Network_Interfaces_{context}"]
+= Configuring network interfaces
 
 {Project} supports specifying multiple network interfaces for a single host.
 You can configure these interfaces when creating a new host as described in xref:Creating_a_Host_{context}[] or when editing an existing host.
 
 There are several types of network interfaces that you can attach to a host.
-When adding a new interface, select one of:
+When configuring a new interface, select one of:
 
 * *Interface*: Allows you to specify an additional physical or virtual interface.
 There are two types of virtual interfaces you can create.
 Use *VLAN* when the host needs to communicate with several (virtual) networks by using a single interface, while these networks are not accessible to each other.
 Use *alias* to add an additional IP address to an existing interface.
-+
-For more information about adding a physical interface, see xref:Adding_a_Physical_Interface_{context}[].
-+
-For more information about adding a virtual interface, see xref:Adding_a_Virtual_Interface_{context}[].
 
 * *Bond*: Creates a bonded interface.
 NIC bonding is a way to bind multiple network interfaces together into a single interface that appears as a single device and has a single MAC address.
 This enables two or more network interfaces to act as one, increasing the bandwidth and providing redundancy.
-For more information, see xref:Adding_a_Bonded_Interface_{context}[].
 
 * *BMC*: Baseboard Management Controller (BMC) allows you to remotely monitor and manage the physical state of machines.
 ifndef::orcharhino[]
 For more information about BMC, see {InstallingServerDocURL}enabling-power-management-on-hosts_{project-context}[Enabling Power Management on Hosts] in _{InstallingServerDocTitle}_.
 endif::[]
-For more information about configuring BMC interfaces, see xref:Adding_a_Baseboard_Management_Controller_Interface_{context}[].
 
 [NOTE]
 ====
@@ -34,8 +28,3 @@ This requires a subnet with correctly configured DNS and DHCP {SmartProxyServers
 If you use a Kickstart method for host provisioning, configuration files are automatically created for managed interfaces in the post-installation phase at `/etc/sysconfig/network-scripts/ifcfg-_interface_id_`.
 ====
 
-[NOTE]
-====
-Virtual and bonded interfaces currently require a MAC address of a physical device.
-Therefore, the configuration of these interfaces works only on bare-metal hosts.
-====

guides/common/modules/con_network-interface-configuration-options.adoc

@@ -0,0 +1,41 @@
+[id="Network_interface_configuration_options_{context}"]
+= Network interface configuration options
+
+When adding a network interface, you need to specify several configuration options. The following lists provide information on the relevant options for the different types of interfaces.
+
+[id="Physical_interface_settings_{context}"]
+== Physical interface settings
+
+*Device Identifier*:: The identifier is used to specify this physical interface when creating bonded interfaces, VLANs, and aliases.
+
+*DNS name*:: {Project} saves this name in {SmartProxyServer} associated with the selected domain (the "DNS A" field) and {SmartProxyServer} associated with the selected subnet (the "DNS PTR" field).
+A single host can therefore have several DNS entries.
+
+*Domain*:: Specifies the domain associated with the network interface. To create and manage domains, navigate to *Infrastructure* > *Domains*.
+
+*Subnet*:: Specifies the subnet associated with the network interface. To create and manage subnets, navigate to *Infrastructure* > *Subnets*.
+
+*Managed* interface:: If the interface is managed, configuration is pulled from the associated {SmartProxyServer} during provisioning, and DNS and DHCP entries are created.
+If using Kickstart provisioning, a configuration file is automatically created for the interface.
+
+*Primary* interface:: The DNS name from the primary interface is used as the host portion of the FQDN.
+
+*Provision*:: TFTP boot takes place using the provisioning interface.
+For image-based provisioning, the script to complete the provisioning is executed through the provisioning interface.
+
+[id="Virtual_interface_settings_{context}"]
+== Virtual interface settings
+
+* *Tag*. You can set a VLAN tag to trunk a network segment from the physical network through to the virtual interface.
+** If you do not specify a tag, managed interfaces inherit the VLAN tag of the associated subnet.
+** User-specified entries from this field are not applied to alias interfaces.
+
+[id="Bonded_interface_settings_{context}"]
+== Bonded interface settings
+
+* *Mode*. The bonding mode defines a policy for fault tolerance and load balancing.
+See xref:Bonding_Modes_Available_{context}[] for a brief description of each bonding mode.
+
+ifdef::satellite[]
+For more information on configuration options for bonded interfaces, see {RHELDocsBaseURL}8/html-single/configuring_and_managing_networking/index#configuring-network-bonding_configuring-and-managing-networking[Configuring network bonding] in _{RHEL}{nbsp}8 Configuring and Managing Networking_.
+endif::[]

guides/common/modules/proc_adding-a-bmc-interface.adoc → guides/common/modules/proc_configuring-a-bmc-interface.adoc

@@ -1,8 +1,7 @@
-[id="Adding_a_Baseboard_Management_Controller_Interface_{context}"]
-= Adding a baseboard management controller (BMC) interface
+[id="Configuring_a_Baseboard_Management_Controller_Interface_{context}"]
+= Configuring a baseboard management controller (BMC) interface
 
-You can control the power status of bare-metal hosts from {Project}.
-Use this procedure to configure a baseboard management controller (BMC) interface for a host that supports this feature.
+To control the power status of bare-metal hosts from {Project}, you can configure a baseboard management controller (BMC) interface for hosts that support this feature. 
 
 .Prerequisites
 * You know the MAC address, IP address, and other details of the BMC interface on the host, and authentication credentials for that interface.
@@ -30,15 +29,21 @@ ifndef::satellite[]
 . On the *Proxies* tab, select your {SmartProxy} as *BMC Proxy*.
 endif::[]
 . Click *Submit*.
-. Navigate to *Hosts* > *All Hosts*.
-. Click *Edit* next to the host you want to edit.
-. On the *Interfaces* tab, click *Add Interface*.
+
+. Navigate to the *Add Interface* form:
+.. Navigate to *Hosts* > *All Hosts*.
+.. Click *Edit* next to the host you want to edit.
+.. On the *Interfaces* tab, click *Add Interface*.
+
 . Select *BMC* from the *Type* list.
-Type-specific configuration options are appended to the form.
-. Specify the general interface settings.
-The applicable configuration options are the same as for the physical interfaces described in xref:Adding_a_Physical_Interface_{context}[].
+
+. Specify the general interface settings:
+.. If the BMC is managed, specify a *MAC address*.
+.. Specify the *Device Identifier*.
+
 . Specify the configuration options specific to BMC interfaces:
-* *Username* and *Password*: Specify any authentication credentials required by BMC.
-* *Provider*: Specify the BMC provider.
+.. *Username* and *Password*: Specify any authentication credentials required by BMC.
+.. *Provider*: Specify the BMC provider.
+
 . Click *OK* to save the interface configuration.
 . Click *Submit* to apply the changes to the host.

guides/common/modules/proc_configuring-a-bonded-interface.adoc

@@ -0,0 +1,57 @@
+[id="Configuring_a_Bonded_Interface_{context}"]
+= Configuring a bonded interface
+
+You can combine multiple physical interfaces together by configuring a bonded interface for the host.
+
+[NOTE]
+====
+Bonded interfaces currently require a MAC address of a physical device.
+Therefore, the configuration of these interfaces works only on bare-metal hosts.
+====
+
+.Procedure
+. Navigate to the *Add Interface* form:
+.. In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*.
+.. Click *Edit* next to the host you want to edit.
+.. On the *Interfaces* tab, click *Add Interface*.
+
+. Select *Bond* from the *Type* list.
+
+. Specify the general interface settings:
+.. In the *Device Identifier* field, specify the interface ID in the `bond0` format .
+.. Specify a *MAC address*.
+.. If you are configuring a secondary interface, select *Managed*.
+Otherwise, {Project} does not apply the configuration.
+
+. Add the configuration specific to bonded interfaces:
+.. *Mode*: Select the bonding mode.
+.. *Attached devices*: Specify a comma-separated list of identifiers of attached devices.
+These can be physical interfaces or VLANs.
+.. *Bond options*: Specify a space-separated list of configuration options, for example `miimon=100`.
+
+. Click *OK* to save the interface configuration.
+. Click *Submit* to apply the changes to the host.
+
+[id="cli-adding-a-bonded-interface_{context}"]
+.CLI procedure
+
+* To create a host with a bonded interface, enter the following command:
++
+[options="nowrap", subs="verbatim,quotes,attributes"]
+----
+# hammer host create \
+--ask-root-password yes \
+--hostgroup _My_Host_Group_ \
+--ip=_My_IP_Address_ \
+--mac=_My_MAC_Address_ \
+--managed true \
+--interface="identifier=_My_NIC_1, mac=_My_MAC_Address_1_, managed=true, type=Nic::Managed, domain_id=_My_Domain_ID_, subnet_id=_My_Subnet_ID_" \
+--interface="identifier=_My_NIC_2_, mac=_My_MAC_Address_2_, managed=true, type=Nic::Managed, domain_id=_My_Domain_ID_, subnet_id=_My_Subnet_ID_" \
+--interface="identifier=_bondN_, ip=_My_IP_Address_2_, type=Nic::Bond, mode=active-backup, attached_devices=[_My_NIC_1_,_My_NIC_2_], managed=true, domain_id=_My_Domain_ID_, subnet_id=_My_Subnet_ID_" \
+--location "_My_Location_" \
+--name "_My_Host_Name_" \
+--organization "_My_Organization_" \
+--subnet-id=_My_Subnet_ID_
+----
++
+Replace `bondN` with `bond` and the ID of your device identifier, for example, `bond0`.

guides/common/modules/proc_configuring-a-physical-interface.adoc

@@ -0,0 +1,37 @@
+[id="Configuring_a_Physical_Interface_{context}"]
+= Configuring a physical interface
+
+You can configure a physical interface for a host.
+
+.Procedure
+
+. Navigate to the *Add Interface* form:
+.. In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*.
+.. Click *Edit* next to the host you want to edit.
+.. On the *Interfaces* tab, click *Add Interface*.
+
+. Specify the general interface settings:
+.. Specify a *MAC address*.
+This setting is required.
+.. Specify the *Device Identifier*, for example `eth0`.
+
+. Configure network and DNS settings:
+.. Specify the *DNS name* associated with the host's IP address.
+.. Select a domain from the *Domain* list.
+.. Select a subnet in the *IPv4 Subnet* or *IPv6 Subnet* list.
+.. Specify the *IPv4 address* or *IPv6 address*.
++
+[NOTE]
+====
+Managed interfaces with an assigned DHCP {SmartProxyServer} require this setting for creating a DHCP lease.
+DHCP-enabled managed interfaces are automatically provided with a suggested IP address.
+====
+
+. Specify interface management options:
+.. Select whether the interface is *Managed*.
+.. Select whether this is the *Primary* interface for the host.
+.. Select whether this is the *Provision* interface for the host.
+.. Select whether to use the interface for *Remote execution*.
+
+. Click *OK* to save the interface configuration.
+. Click *Submit* to apply the changes to the host.