xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-21 19:22:05 +00:00
Code Issues Releases Wiki Activity

Fix formatting and grammar for makenetworks man page

Browse Source
This commit is contained in:
Mark Gurevich 2021-05-03 15:05:27 -04:00
parent 1a47868599
commit 2bad8de18e
2 changed files with 24 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/source/guides/admin-guides/references/man8/makenetworks.8.rst
View File

@ -35,9 +35,9 @@ The \ **makenetworks**\ command can be used to gather network information from
Every network that will be used to install a cluster node must be defined in the xCAT database.
The default behavior is to gather network information from the management node, and any configured xCAT service nodes, and automatically save this information in the xCAT database.
The default behavior is to gather network information from the management node, and any configured xCAT service nodes, and automatically save that information in the xCAT database.
You can use the "-d" option to display the network information without writing it to the database.
You can use the \ **-d**\ option to display the network information without writing it to the database.
You can also redirect the output to a file that can be used with the xCAT \ **mkdef**\ command to define the networks.
@ -53,9 +53,9 @@ For example:
This features allows you to verify and modify the network information before writing it to the database.
When the network information is gathered a default value is created for the "netname" attribute. This is done to make it possible to use the mkdef, chdef, lsdef, and rmdef commands to manage this data.
When the network information is gathered a default value is created for the "netname" attribute. This is done to make it possible to use the \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ commands to manage this data.
The default naming convention is to use a hyphen separated "net" and "mask" value with the "." replace by "_". (ex. "8_124_47_64-255_255_255_0")
The default naming convention is to use a hyphen separated "net" and "mask" values with the "." replaced by "_". (ex. "8_124_47_64-255_255_255_0")
You can also modify the xCAT "networks" database table directly using the xCAT \ **tabedit**\ command.
@ -121,13 +121,19 @@ EXAMPLES
makenetworks -d
The output would be one or more stanzas of information similar to the following. The line that ends with a colon is the value of the "netname" attribute and is the name of the network object to use with the lsdef, mkdef, chdef and rmdef commands.
The output would be one or more stanzas of information similar to the following. The line that ends with a colon is the value of the "netname" attribute and is the name of the network object to use with the \ **lsdef**\ , \ **mkdef**\ , \ **chdef**\ and \ **rmdef**\ commands.
.. code-block:: perl
9_114_37_0-255_255_255_0:
objtype=network
gateway=9.114.37.254
mask=255.255.255.0
net=9.114.37.0
mgtifname=ens3
mtu=1500
9_114_37_0-255_255_255_0:
objtype=network
gateway=9.114.37.254
mask=255.255.255.0
net=9.114.37.0

14
xCAT-client/pods/man8/makenetworks.8.pod
View File

@ -16,9 +16,9 @@ The B<makenetworks> command can be used to gather network information from an xC
Every network that will be used to install a cluster node must be defined in the xCAT database.
The default behavior is to gather network information from the management node, and any configured xCAT service nodes, and automatically save this information in the xCAT database.
The default behavior is to gather network information from the management node, and any configured xCAT service nodes, and automatically save that information in the xCAT database.
You can use the "-d" option to display the network information without writing it to the database.
You can use the B<-d> option to display the network information without writing it to the database.
You can also redirect the output to a file that can be used with the xCAT B<mkdef> command to define the networks.
@ -30,9 +30,9 @@ For example:
This features allows you to verify and modify the network information before writing it to the database.
When the network information is gathered a default value is created for the "netname" attribute. This is done to make it possible to use the mkdef, chdef, lsdef, and rmdef commands to manage this data.
When the network information is gathered a default value is created for the "netname" attribute. This is done to make it possible to use the B<mkdef>, B<chdef>, B<lsdef>, and B<rmdef> commands to manage this data.
The default naming convention is to use a hyphen separated "net" and "mask" value with the "." replace by "_". (ex. "8_124_47_64-255_255_255_0")
The default naming convention is to use a hyphen separated "net" and "mask" values with the "." replaced by "_". (ex. "8_124_47_64-255_255_255_0")
You can also modify the xCAT "networks" database table directly using the xCAT B<tabedit> command.
@ -77,13 +77,15 @@ Display cluster network information but do not write the network definitions to
makenetworks -d
The output would be one or more stanzas of information similar to the following. The line that ends with a colon is the value of the "netname" attribute and is the name of the network object to use with the lsdef, mkdef, chdef and rmdef commands.
The output would be one or more stanzas of information similar to the following. The line that ends with a colon is the value of the "netname" attribute and is the name of the network object to use with the B<lsdef>, B<mkdef>, B<chdef> and B<rmdef> commands.
9_114_37_0-255_255_255_0:
9_114_37_0-255_255_255_0:
objtype=network
gateway=9.114.37.254
mask=255.255.255.0
net=9.114.37.0
mgtifname=ens3
mtu=1500
=back