diff --git a/docs/source/guides/admin-guides/references/man5/nics.5.rst b/docs/source/guides/admin-guides/references/man5/nics.5.rst index 92a5621be..cf264ff18 100644 --- a/docs/source/guides/admin-guides/references/man5/nics.5.rst +++ b/docs/source/guides/admin-guides/references/man5/nics.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **nics Attributes:**\ \ *node*\ , \ *nicips*\ , \ *nichostnamesuffixes*\ , \ *nichostnameprefixes*\ , \ *nictypes*\ , \ *niccustomscripts*\ , \ *nicnetworks*\ , \ *nicaliases*\ , \ *nicextraparams*\ , \ *nicdevices*\ , \ *nicsadapter*\ , \ *comments*\ , \ *disable*\ +\ **nics Attributes:**\ \ *node*\ , \ *nicips*\ , \ *nichostnamesuffixes*\ , \ *nichostnameprefixes*\ , \ *nictypes*\ , \ *niccustomscripts*\ , \ *nicnetworks*\ , \ *nicaliases*\ , \ *nicextraparams*\ , \ *nicdevices*\ , \ *nicsadapter*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,117 +36,117 @@ nics Attributes: -\ **node**\ - +\ **node**\ + The node or group name. - -\ **nicips**\ - - Comma-separated list of IP addresses per NIC. + +\ **nicips**\ + + Comma-separated list of IP addresses per NIC. To specify one ip address per NIC: !,!,..., for example, eth0!10.0.0.100,ib0!11.0.0.100 To specify multiple ip addresses per NIC: !|,!|,..., for example, eth0!10.0.0.100|fd55::214:5eff:fe15:849b,ib0!11.0.0.100|2001::214:5eff:fe15:849a. The xCAT object definition commands support to use nicips. as the sub attributes. Note: The primary IP address must also be stored in the hosts.ip attribute. The nichostnamesuffixes should specify one hostname suffix for each ip address. - -\ **nichostnamesuffixes**\ - - Comma-separated list of hostname suffixes per NIC. + +\ **nichostnamesuffixes**\ + + Comma-separated list of hostname suffixes per NIC. If only one ip address is associated with each NIC: !,!,..., for example, eth0!-eth0,ib0!-ib0 If multiple ip addresses are associated with each NIC: - !|,!|,..., for example, eth0!-eth0|-eth0-ipv6,ib0!-ib0|-ib0-ipv6. + !|,!|,..., for example, eth0!-eth0|-eth0-ipv6,ib0!-ib0|-ib0-ipv6. The xCAT object definition commands support to use nichostnamesuffixes. as the sub attributes. - - + + .. code-block:: perl - + Note: According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9) and minus sign (-). When you are specifying "nichostnamesuffixes" or "nicaliases" make sure the resulting hostnames will conform to this naming convention - - -\ **nichostnameprefixes**\ - - Comma-separated list of hostname prefixes per NIC. + + +\ **nichostnameprefixes**\ + + Comma-separated list of hostname prefixes per NIC. If only one ip address is associated with each NIC: !,!,..., for example, eth0!eth0-,ib0!ib- If multiple ip addresses are associated with each NIC: - !|,!|,..., for example, eth0!eth0-|eth0-ipv6i-,ib0!ib-|ib-ipv6-. - The xCAT object definition commands support to use nichostnameprefixes. as the sub attributes. + !|,!|,..., for example, eth0!eth0-|eth0-ipv6i-,ib0!ib-|ib-ipv6-. + The xCAT object definition commands support to use nichostnameprefixes. as the sub attributes. Note: According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9) and minus sign (-). When you are specifying "nichostnameprefixes" or "nicaliases" make sure the resulting hostnames will conform to this naming convention - -\ **nictypes**\ - + +\ **nictypes**\ + Comma-separated list of NIC types per NIC. !,!, e.g. eth0!Ethernet,ib0!Infiniband. The xCAT object definition commands support to use nictypes. as the sub attributes. - -\ **niccustomscripts**\ - + +\ **niccustomscripts**\ + Comma-separated list of custom scripts per NIC. !,!, e.g. eth0!configeth eth0, ib0!configib ib0. The xCAT object definition commands support to use niccustomscripts. as the sub attribute . - -\ **nicnetworks**\ - + +\ **nicnetworks**\ + Comma-separated list of networks connected to each NIC. If only one ip address is associated with each NIC: !,!, for example, eth0!10_0_0_0-255_255_0_0, ib0!11_0_0_0-255_255_0_0 If multiple ip addresses are associated with each NIC: !|,!|, for example, eth0!10_0_0_0-255_255_0_0|fd55:faaf:e1ab:336::/64,ib0!11_0_0_0-255_255_0_0|2001:db8:1:0::/64. The xCAT object definition commands support to use nicnetworks. as the sub attributes. - -\ **nicaliases**\ - + +\ **nicaliases**\ + Comma-separated list of hostname aliases for each NIC. Format: eth0!,eth1!| - For multiple aliases per nic use a space-separated list. + For multiple aliases per nic use a space-separated list. For example: eth0!moe larry curly,eth1!tom|jerry - -\ **nicextraparams**\ - + +\ **nicextraparams**\ + Comma-separated list of extra parameters that will be used for each NIC configuration. If only one ip address is associated with each NIC: !,!, for example, eth0!MTU=1500,ib0!MTU=65520 CONNECTED_MODE=yes. If multiple ip addresses are associated with each NIC: !|,!|, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes. The xCAT object definition commands support to use nicextraparams. as the sub attributes. - -\ **nicdevices**\ - + +\ **nicdevices**\ + Comma-separated list of NIC device per NIC, multiple ethernet devices can be bonded as bond device, these ethernet devices are separated by | . !|,!, e.g. bond0!eth0|eth2,br0!bond0. The xCAT object definition commands support to use nicdevices. as the sub attributes. - -\ **nicsadapter**\ - + +\ **nicsadapter**\ + Comma-separated list of NIC information collected by getadapter. !,!, for example, enP3p3s0f1!mac=98:be:94:59:fa:cd linkstate=DOWN,enP3p3s0f2!mac=98:be:94:59:fa:ce candidatename=enP3p3s0f2/enx98be9459face - -\ **comments**\ - + +\ **comments**\ + Any user-written notes. - -\ **disable**\ - + +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -155,5 +155,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\