From 37f35f731a71a76e1233aa59971f0324c6e06408 Mon Sep 17 00:00:00 2001 From: leiaibj Date: Wed, 23 Jan 2013 07:20:41 +0000 Subject: [PATCH] update man-pages for profiled nodes releated commands git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@14956 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd --- xCAT-client/pods/man1/nodeaddunmged.1.pod | 17 +- xCAT-client/pods/man1/nodechmac.1.pod | 19 +-- xCAT-client/pods/man1/nodechprofile.1.pod | 34 ++-- xCAT-client/pods/man1/nodediscoverls.1.pod | 8 +- xCAT-client/pods/man1/nodediscoverstart.1.pod | 67 ++++---- .../pods/man1/nodediscoverstatus.1.pod | 8 +- xCAT-client/pods/man1/nodediscoverstop.1.pod | 6 +- xCAT-client/pods/man1/nodeimport.1.pod | 148 ++++++++++-------- xCAT-client/pods/man1/nodepurge.1.pod | 10 +- xCAT-client/pods/man1/noderefresh.1.pod | 6 +- 10 files changed, 172 insertions(+), 151 deletions(-) diff --git a/xCAT-client/pods/man1/nodeaddunmged.1.pod b/xCAT-client/pods/man1/nodeaddunmged.1.pod index 788dc672f..9fed86173 100644 --- a/xCAT-client/pods/man1/nodeaddunmged.1.pod +++ b/xCAT-client/pods/man1/nodeaddunmged.1.pod @@ -1,16 +1,16 @@ =head1 NAME -B - Create a un-managed node with hostname and ip address specified. +B - Create a unmanaged node. =head1 SYNOPSIS -B [-h| --help │ -v │ --version] +B [-h| --help | -v | --version] -B hostname= ip= +B hostname= ip= =head1 DESCRIPTION -The B command will add nodes into group __Unmanaged. And we just need to specify hostname and IP for this node. +The B command adds an unmanaged node to the __Unmanaged group. You can specify the node name and IP address of the node. =head1 OPTIONS @@ -22,13 +22,13 @@ B<-v|--version> Command Version. -B> +B> -The hostname of the unmanaged node. +Sets the name of the new unmanaged node, where is the name of the node. -B> +B> -The IP address of the unmanaged node. +Sets the IP address of the unmanaged node, where is the IP address of the new node in the form xxx.xxx.xxx.xxx =head1 RETURN VALUE @@ -38,6 +38,7 @@ The IP address of the unmanaged node. =head1 EXAMPLES +To add an unmanaged node, use the following command: nodeaddunmged hostname=unmanaged01 ip=192.168.1.100 =head1 SEE ALSO diff --git a/xCAT-client/pods/man1/nodechmac.1.pod b/xCAT-client/pods/man1/nodechmac.1.pod index 4d0a1b53a..05c186ff4 100644 --- a/xCAT-client/pods/man1/nodechmac.1.pod +++ b/xCAT-client/pods/man1/nodechmac.1.pod @@ -1,18 +1,18 @@ =head1 NAME -B - Update a profiled node's provisioning NIC's MAC address. +B - Updates the MAC address for a node. =head1 SYNOPSIS -B [-h| --help │ -v │ --version] +B [-h| --help | -v | --version] -B mac= +B mac= =head1 DESCRIPTION -The B command is for changing a node's provisioning NIC's MAC. +The B command changes the MAC address for provisioned node’s network interface. -This command can be used for following use case: The hardware of a node has some problems and this node will be replaced with a new one. However, Admin wants to apply the old node's configurations to the new one. For example: keep the old hostname, network settings...etc. +You can use this command to keep an existing node configuration. For example, if an existing node has hardware problems, the replacement node can use the old configurations. By using the nodechmac command, the node name and network settings of the old node can be used by the new node. =head1 OPTIONS @@ -24,13 +24,13 @@ B<-v|--version> Command Version. -B +B -The node name. +Specifies the name of the node you want to update, where is the node that is updated. -B> +B -The provisioning NIC's MAC address of the new node. +Sets the new MAC address for the NIC used by the provisioning node, where is the NICs new MAC address. =head1 RETURN VALUE @@ -40,6 +40,7 @@ The provisioning NIC's MAC address of the new node. =head1 EXAMPLES +You can update the MAC address for a node, by using the following command: nodechmac compute-000 mac=2F:3C:88:98:7E:01 =head1 SEE ALSO diff --git a/xCAT-client/pods/man1/nodechprofile.1.pod b/xCAT-client/pods/man1/nodechprofile.1.pod index af03b2357..40faba08a 100644 --- a/xCAT-client/pods/man1/nodechprofile.1.pod +++ b/xCAT-client/pods/man1/nodechprofile.1.pod @@ -1,22 +1,26 @@ =head1 NAME -B - Update node profiles for profiled nodes. +B - updates a profile used by a node =head1 SYNOPSIS -B [-h| --help │ -v │ --version] +B [-h| --help | -v | --version] -B [imageprofile=] [networkprofile=] [hardwareprofile=] +B [imageprofile=] [networkprofile=] [hardwareprofile=] =head1 DESCRIPTION -The B command update following profiles for nodes: imageprofile, networkprofile and hardwareprofile. After profiles for nodes changed, the node's status will be changed to "defined", which means we must reinstall them. +The B command updates the profiles used by a node, including: the image profile, network profile, and hardware management profile. -Changing imageprofile will change node's os or provisioning related settings. +If you update the image profile for a node, the operating system and provisioning settings for the node are updated. -Changing networkprofile will change node's network settings. And, B will be able to update node's IP address automatically. +If you update the network profile, the IP address and network settings for the node are updated. -Changing hardwareprofile will change node's hardware settings: BMC, FSP...etc. +If you update the hardware management profile, the hardware settings for the node are updated. + +After nodes' hardware profile or image profile are updated, the status for each node is changed to "defined". A node with a "defined" status must be reinstalled + +After nodes' network profile updated, the status for nodes is not changed. You'll need to run B to re-generate the nodes' IP address and nodes' status may also be updated at this stage. =head1 OPTIONS @@ -32,17 +36,17 @@ B The nodes to be removed. -B> +B> -The new image profile name. If there is a group named "__ImageProfile_imgprofile", then "imgprofile" is the image profile name. A image profile defines provisioning method, os info, kit info, provisioning params...etc for nodes. +Sets the new image profile name used by the node, where is the new image profile. An image profile defines the provisioning method, OS information, kit information, and provisioning parameters for a node. If the "__ImageProfile_imgprofile" group already exists in the nodehm table, then "imgprofile" is used as the image profile name. -B> +B> -The network profile name. If there is a group named "__NetworkProfile_netprofile", then "netprofile" is the network profile name. A network profile defines networks, nics, routes...etc for nodes. +Sets the new network profile name used by the node, where is the new network profile. A network profile defines the network, NIC, and routes for a node. If the "__NetworkProfile_netprofile" group already exists in the nodehm table, then "netprofile" is used as the network profile name. -B> +B> -The hardware profile name. If there is a group named "__HardwareProfile_hwprofile", then "hwprofile" is the hardware profile name. A harddware profile defines hardware management related info like: IPMI, HMC, CEC, CMM...etc for nodes. +Sets the new hardware profile name used by the node, where is the new hardware management profile used by the node. If a "__HardwareProfile_hwprofile" group exists, then "hwprofile" is the hardware profile name. A hardware profile defines hardware management related information for imported nodes, including: IPMI, HMC, CEC, CMM. =head1 RETURN VALUE @@ -52,8 +56,12 @@ The hardware profile name. If there is a group named "__HardwareProfile_hwprofil =head1 EXAMPLES +To change the image profile to rhels6.3_packaged for compute nodes compute-000 and compute-001, use the following command: + nodechprofile compute-000,compute-001 imageprofile=rhels6.3_packaged +To change all of the profiles for compute node compute-000, enter the following command: + nodechprofile compute-000 imageprofile=rhels6.3_packaged networkprofile=default_cn hardwareprofile=default_ipmi =head1 SEE ALSO diff --git a/xCAT-client/pods/man1/nodediscoverls.1.pod b/xCAT-client/pods/man1/nodediscoverls.1.pod index eb9bb0593..a1959c858 100644 --- a/xCAT-client/pods/man1/nodediscoverls.1.pod +++ b/xCAT-client/pods/man1/nodediscoverls.1.pod @@ -1,16 +1,16 @@ =head1 NAME -B - List all discovered profiled nodes +B - List all discovered nodes =head1 SYNOPSIS -B [-h| --help │ -v │ --version] +B [-h| --help | -v | --version] B =head1 DESCRIPTION -The B List all discovered profiled nodes at current discover period. +The B command lists all discovered nodes that use a profile in the current node discovery process =head1 OPTIONS @@ -30,6 +30,8 @@ Command Version. =head1 EXAMPLES +You can get a list of all discovered nodes, by using the following command: + nodediscoverls =head1 SEE ALSO diff --git a/xCAT-client/pods/man1/nodediscoverstart.1.pod b/xCAT-client/pods/man1/nodediscoverstart.1.pod index d3630374e..15e53ada2 100644 --- a/xCAT-client/pods/man1/nodediscoverstart.1.pod +++ b/xCAT-client/pods/man1/nodediscoverstart.1.pod @@ -1,20 +1,20 @@ =head1 NAME -B - Start profiled nodes discovery. +B - starts the node discovery process =head1 SYNOPSIS -B [-h| --help │ -v │ --version] +B [-h| --help | -v | --version] -B networkprofile= imageprofile= hostnameformat= [hardwareprofile=] [groups=] [rack=] [chassis=] [height=] [unit=] [rank=rank] +B networkprofile= imageprofile= hostnameformat= [hardwareprofile=] [groups=] [rack=] [chassis=] [height=] [unit=] [rank=rank-num] =head1 DESCRIPTION -The B command starts profiled nodes discovery. +The B command starts the node discovery process. All nodes discovered by this process will be associated with specified profiles and rack/chassis/unit locations. -Once profiled nodes discovery started, admin can bootup nodes which want to be provisioned with PXE. These nodes will be able to discovered automatically. The nodes' settings like hostname and IP address will be assigned automatically according to specified profiles. +You can PXE boot nodes that you want to provision. PXE booting nodes launches the node discovery process. During the node discovery process, nodes are discovered automatically. Node settings are assigned automatically according to the specified profiles -After nodes discovered, the configuration files related with these nodes will be updated automatically. For example: /etc/hosts, dns configuration, dhcp configuration. And the kits node plugins will also be triggered automatically to update kit related configuration/services. +After the nodes are discovered, their configuration files are updated automatically. Configuration files include the /etc/hosts service file, DNS configuration, and DHCP configuration. Kit plug-ins are automatically triggered to update kit related configurations and services. =head1 OPTIONS @@ -26,58 +26,49 @@ B<-v|--version> Command Version. -B> +B> -The network profile name. If there is a group named "__NetworkProfile_netprofile", then "netprofile" is the network profile name. A network profile defines networks, nics, routes...etc for imported nodes. +Sets the new image profile name used by the node, where is the new image profile. An image profile defines the provisioning method, OS information, kit information, and provisioning parameters for a node. If the "__ImageProfile_imgprofile" group already exists in the nodehm table, then "imgprofile" is used as the image profile name. -B> +B> -The image profile name. If there is a group named "__ImageProfile_imgprofile", then "imgprofile" is the image profile name. A image profile defines provisioning method, os info, kit info, provisioning params...etc for imported nodes. +Sets the new network profile name used by the node, where is the new network profile. A network profile defines the network, NIC, and routes for a node. If the "__NetworkProfile_netprofile" group already exists in the nodehm table, then "netprofile" is used as the network profile name. -B> +B> -The hardware profile name. If there is a group named "__HardwareProfile_hwprofile", then "hwprofile" is the hardware profile name. A harddware profile defines hardware management related info like: IPMI, HMC, CEC, CMM...etc for imported nodes. +Sets the new hardware profile name used by the node, where is the new hardware management profile used by the node. If a "__HardwareProfile_hwprofile" group exists, then "hwprofile" is the hardware profile name. A hardware profile defines hardware management related information for imported nodes, including: IPMI, HMC, CEC, CMM. -B> +B> -The hostname format for generating hostnames for nodes if the hostname for a node is specified as "__hostname__" in hostinfo file. -Following hostname format types are supported: +Sets the node name format for all nodes discovered, where is a supported format. The two types of formats supported are prefix#NNNappendix and prefix#RRand#NNappendix, where wildcard #NNN and #NN are replaced by a system generated number that is based on the provisioning order. Wildcard #RR represents the rack number and stays constant. -B +For example, if the node name format is compute-#NN, the node name is generated as: compute-00, compute-01, ..., compute-99. If the node name format is blade#NNN-x64, the node name is generated as: blade001-x64, blade002-x64, ..., blade999-x64 -For example: - If hostname format is compute-#NN, then node's hostname will be generated automatically like: compute-00, compute-01, ...compute-99 - If hostname format is blade#NNN-x64, then node's hostname will be generated automatically like: blade001-x64, blade002-x64, ..., blade999-x64 +For example, if the node name format is compute-#RR-#NN and the rack number is 2, the node name is generated as: compute-02-00, compute-02-01, ..., compute-02-99. If node name format is node-#NN-in-#RR and rack number is 1, the node name is generated as: node-00-in-01, node-01-in-01, ..., node-99-in-01 -B +B> -For example: - If hostname format is compute-#RR-#NN, then nodes which placed in a rack which rack number is 2 will be generated with hostnames like: compute-02-00, compute-02-01, ..., compute-02-99. And nodes which placed in another rack wich rack number is 5 will be generated with hostnames like: compute-05-00, compute-05-01, ..., compute-05-99. - If hostname format is node-#NN-in-#RR, then hostnames for nodes in rack with rack number 1 will be: node-00-in-01, node-01-in-01, ..., node-99-in-01. And hostnames for nodes in rack with rack number 2 will be: node-00-in-02, node-01-in-02, ..., node-99-in-02. +Sets the node groups that the imported node belongs to, where is a comma-separated list of node groups. -B> +B> -The groups which the imported nodes will belong to. - -B> - -node location info. Specify the rack name which this node will be placed into. +Sets the rack name, where is the rack the node is located on or placed into. -B> +B> -node location info, for blade(or PureFlex) only. Specify the chasiss name which this blade will be placed into. This item can not be specified together with rack. +Sets the chassis name, where is the chassis that the Blade server or PureFlex sysstem is located. This option is used for the Blade server and PureFlex system only. You cannot specify this option with the rack option. -B> +B> -node location info, for rack server only. Specify the server height number, in U. This item must be specified together with rack. If not specified, the default value is 1. +Sets the height of a rack server, where is the server height. You must specify the this option with the rack option. If the rack option is not specified, the default value is 1. -B> +B> -node location info, for rack server only. Specify the node's start unit number in rack, in U. This item must be specified together with rack. If not specified, the default value is 1. +Sets the start unit value for the node, where is the location of the starting rack. This option is for a rack server only. You must specify this option with the rack option. If the unit option is not specified, the default value is 1 -B> +B> -Defines the start number in hostname format. If hostname format specified like "compute#NNN" and rank is set to 5, then hostnames of discovered nodes will be named as: "compute005, compute006, ..." +Specifies the starting rank number that is used in the node name format, where is a valid integer between 0 and 254. This option must be specified with nodenameformat option. For example, if your node name format is compute-#RR-#NN. The rack's number is 2 and rank is specified as 5, the node name is generated as follows: compute-02-05, compute-02-06, ..., compute-02-99. =head1 RETURN VALUE @@ -87,6 +78,8 @@ Defines the start number in hostname format. If hostname format specified like " =head1 EXAMPLES +To discover nodes using the default_cn network profile and the rhels6.3_packaged image profile, use the following command: + nodediscoverstart networkprofile=default_cn imageprofile=rhels6.3_packaged hostnameformat=compute#NNN =head1 SEE ALSO diff --git a/xCAT-client/pods/man1/nodediscoverstatus.1.pod b/xCAT-client/pods/man1/nodediscoverstatus.1.pod index c19eaed39..d78f83bb1 100644 --- a/xCAT-client/pods/man1/nodediscoverstatus.1.pod +++ b/xCAT-client/pods/man1/nodediscoverstatus.1.pod @@ -1,16 +1,16 @@ =head1 NAME -B - Detect whether Profiled nodes discovery is running or not. +B - gets the node discovery process status =head1 SYNOPSIS -B [-h| --help │ -v │ --version] +B [-h| --help | -v | --version] B =head1 DESCRIPTION -The B Detect whether Profiled nodes discovery is running or not. +The B command detects if the node discovery process is running. =head1 OPTIONS @@ -30,6 +30,8 @@ Command Version. =head1 EXAMPLES +To determine if there are some nodes discovered and the discovered nodes' status, enter the following command: + nodediscoverstatus =head1 SEE ALSO diff --git a/xCAT-client/pods/man1/nodediscoverstop.1.pod b/xCAT-client/pods/man1/nodediscoverstop.1.pod index 31978b211..2eb747074 100644 --- a/xCAT-client/pods/man1/nodediscoverstop.1.pod +++ b/xCAT-client/pods/man1/nodediscoverstop.1.pod @@ -1,16 +1,16 @@ =head1 NAME -B - Stop profiled nodes auto discover. +B - stops the node discovery process. =head1 SYNOPSIS -B [-h| --help │ -v │ --version] +B [-h| --help | -v | --version] B =head1 DESCRIPTION -The B command stops profiled nodes discover and the new booted nodes will not be discovered as profiled nodes any more. +The B stops the node discovery process. The node discovery process can discover nodes automatically. If this command is issued, any newly booted nodes can not be discovered any more. =head1 OPTIONS diff --git a/xCAT-client/pods/man1/nodeimport.1.pod b/xCAT-client/pods/man1/nodeimport.1.pod index a4cbda56e..ab4255617 100644 --- a/xCAT-client/pods/man1/nodeimport.1.pod +++ b/xCAT-client/pods/man1/nodeimport.1.pod @@ -4,9 +4,9 @@ B - Create profiled nodes by importing hostinfo file. =head1 SYNOPSIS -B [-h| --help │ -v │ --version] +B [-h| --help | -v | --version] -B file= networkprofile= imageprofile= hostnameformat= [hardwareprofile=] [groups=] +B file= networkprofile= imageprofile= hostnameformat= [hardwareprofile=] [groups=] =head1 DESCRIPTION @@ -24,43 +24,33 @@ B<-v|--version> Command Version. -B> +B> -The full path of the hostinfo file. +Specifies the node information file, where is the full path and file name of the node information file. -B> +B> -The network profile name. If there is a group named "__NetworkProfile_netprofile", then "netprofile" is the network profile name. A network profile defines networks, nics, routes...etc for imported nodes. +Sets the new image profile name used by the node, where is the new image profile. An image profile defines the provisioning method, OS information, kit information, and provisioning parameters for a node. If the "__ImageProfile_imgprofile" group already exists in the nodehm table, then "imgprofile" is used as the image profile name. -B> +B> -The image profile name. If there is a group named "__ImageProfile_imgprofile", then "imgprofile" is the image profile name. A image profile defines provisioning method, os info, kit info, provisioning params...etc for imported nodes. +Sets the new network profile name used by the node, where is the new network profile. A network profile defines the network, NIC, and routes for a node. If the "__NetworkProfile_netprofile" group already exists in the nodehm table, then "netprofile" is used as the network profile name. -B> +B> -The hardware profile name. If there is a group named "__HardwareProfile_hwprofile", then "hwprofile" is the hardware profile name. A harddware profile defines hardware management related info like: IPMI, HMC, CEC, CMM...etc for imported nodes. +Sets the new hardware profile name used by the node, where is the new hardware management profile used by the node. If a "__HardwareProfile_hwprofile" group exists, then "hwprofile" is the hardware profile name. A hardware profile defines hardware management related information for imported nodes, including: IPMI, HMC, CEC, CMM. -B> +B> -The hostname format for generating hostnames for nodes if the hostname for a node is specified as "__hostname__" in hostinfo file. -Following hostname format types are supported: +Sets the node name format for all nodes discovered, where is a supported format. The two types of formats supported are prefix#NNNappendix and prefix#RRand#NNappendix, where wildcard #NNN and #NN are replaced by a system generated number that is based on the provisioning order. Wildcard #RR represents the rack number and stays constant. -B +For example, if the node name format is compute-#NN, the node name is generated as: compute-00, compute-01, ... , compute-99. If the node name format is blade#NNN-x64, the node name is generated as: blade001-x64, blade002-x64, ... , blade999-x64 -For example: - If hostname format is compute-#NN, then node's hostname will be generated automatically like: compute-00, compute-01, ...compute-99 - If hostname format is blade#NNN-x64, then node's hostname will be generated automatically like: blade001-x64, blade002-x64, ..., blade999-x64 +For example, if the node name format is compute-#RR-#NN and the rack number is 2, the node name is generated as: compute-02-00, compute-02-01, ..., compute-02-99. If node name format is node-#NN-in-#RR and rack number is 1, the node name is generated as: node-00-in-01, node-01-in-01, ... , node-99-in-01 -B - -For example: - If hostname format is compute-#RR-#NN, then nodes which placed in a rack which rack number is 2 will be generated with hostnames like: compute-02-00, compute-02-01, ..., compute-02-99. And nodes which placed in another rack wich rack number is 5 will be generated with hostnames like: compute-05-00, compute-05-01, ..., compute-05-99. - If hostname format is node-#NN-in-#RR, then hostnames for nodes in rack with rack number 1 will be: node-00-in-01, node-01-in-01, ..., node-99-in-01. And hostnames for nodes in rack with rack number 2 will be: node-00-in-02, node-01-in-02, ..., node-99-in-02. - -B> - -The groups which the imported nodes will belong to. +B> +Sets the node groups that the imported node belongs to, where is a comma-separated list of node groups. =head1 RETURN VALUE @@ -73,8 +63,10 @@ The groups which the imported nodes will belong to. =head1 EXAMPLES -An example for importing profiled nodes. -1. Run "tabdump nodegroups" to get all groups and find out which ones are avaiable profiles. Then run "lsdef -t group " to get the detailed info for these profiles. like: +To import nodes using a profile, follow the following steps: + +1. Find all node groups and profiles, run the following command "tabdump nodegroups". For detailed profile information run "lsdef -t group ". Example of detailed profile information: + # tabdump nodegroup #groupname,grouptype,members,membergroups,wherevals,comments,disable "compute","static",,,,, @@ -94,60 +86,80 @@ An example for importing profiled nodes. nictypes=eth0:Ethernet primarynic=eth0 -2. Prepare a hostinfo file looks like: +2. Prepare a node information file. -# hostinfo begin + Example of a node information file, a blade and a rack server defined: + # hostinfo begin + # This entry defines a blade. + __hostname__: + mac=b8:ac:6f:37:59:24 + ip=192.168.1.20 + chassis=chassis01 -__hostname__: - mac=b8:ac:6f:37:59:24 - ip=192.168.1.20 - chassis=chassis01 + # This entry defines a rack server. + __hostname__: + mac=b8:ac:6f:37:59:25 + ip=192.168.1.20 + rack=rack01 + height=1 + unit=2 -__hostname__: - mac=b8:ac:6f:37:59:25 - ip=192.168.1.20 - rack=rack01 - height=1 - unit=2 + # hostinfo end. -# hostinfo end. + Another example of a node infomation file, a PureFlex X/P node defined: + # hostinfo begin + # To define a PureFlex P/X node, chassis and slot id must be specified. + # The chassis must be a PureFlex chassis. + __hostname__: + mac=b8:ac:6f:37:59:25 + chassis=cmm01 + slotid=1 + # hostinfo end. -Here, we are going to import 2 nodes, and about each line of this file: -__hostname__: - Mandatory item - Description: The hostname for the node. - If you want to specify the hostname for this node, just write like: "compute-001:" - If you want the hostname auto generated from hostnameformat, just write like: "__hostname__:" +The node information file includes the following items: -mac= - Mandatory item - Description: Specify the node's provisioning nic's MAC address +B<__hostname__:> This is a mandatory item. -ip= - Optional item - Description: Specify the node's provisioing IP address. - If not specify this item, node's provisioning IP will be generated automatically according to NetworkProfile. +Description: The name of the node, where __hostname__ is automatically generated by the node name format. You can also input a fixed node name, for example “compute-node”. -rack= - Optional item - Description: node location info. Specify the rack name which this node will be placed into. - If not specify this item, there will be no node location info set for this node. - this item must be specified together with height + unit. - -chasiss= - Optional item - Description: node location info, for blade(or PureFlex) only. Specify the chasiss name which this blade will be placed into. - this item can not be specified together with rack. +B> This is a mandatory item. -height= - Optional item - Description: node location info, for rack server only. Specify the server height number, in U. - this item must be specified together with rack and unit. +Description: Specify the MAC address for the NIC used by the provisionging node, where is the NICs MAC address. -unit= - Optional item - Description: node location info, for rack server only. Specify the node's start unit number in rack, in U. - this item must be specified together with rack and height. +B> This is a mandatory item while define a PureFlex node. -3. Run nodeimport command: +Description: The node position in the PureFlex Chassis. + +B> This is an optional item. + +Description: Specify the IP address used for provisioning a node, where is in the form xxx.xxx.xxx.xxx. If this item is not included, the IP address used to provision the node is generated automatically according to the Network Profile used by the node. + +B> This is an optional item. + +Description: node location info. Specify the rack name which this node will be placed into. If not specify this item, there will be no node location info set for this node. this item must be specified together with height + unit. + +B> This is an optional item. + +Description: node location info. Specify the rack name which this node will be placed into. If not specify this item, there will be no node location info set for this node. this item must be specified together with height + unit. + +B> This is an optional item. + +Description: node location info, for blade(or PureFlex) only. Specify the chasiss name which this blade will be placed into. this item can not be specified together with rack. + +B> This is an optional item. + +Description: node location info, for rack server only. Specify the server height number, in U. this item must be specified together with rack and unit. + +B> This is an optional item. + +Description: node location info, for rack server only. Specify the node's start unit number in rack, in U. this item must be specified together with rack and height. + +3. Import the nodes, by using the following commands. Note: If we want to import PureFlex X/P nodes, hardware profile must be set to a PureFlex hardware type. nodeimport file=/root/hostinfo.txt networkprofile=default_cn imageprofile=rhels6.3_packaged hostnameformat=compute-#NNN -4. After node import succeeds, we'll get 2 nodes created, And node's configurations like dhcp, dns, /etc/hosts will be updated automatically too. +4. After importing the nodes, the nodes are created and all configuration files used by the nodes are updated, including: /etc/hosts, DNS, DHCP. -5. Reboot the nodes, they will be provisioned automatically. +5. Reboot the nodes. After the nodes are booted they are provisioned automatically. =head1 SEE ALSO diff --git a/xCAT-client/pods/man1/nodepurge.1.pod b/xCAT-client/pods/man1/nodepurge.1.pod index ef180f095..a9ad0b49a 100644 --- a/xCAT-client/pods/man1/nodepurge.1.pod +++ b/xCAT-client/pods/man1/nodepurge.1.pod @@ -1,18 +1,18 @@ =head1 NAME -B - Remove nodes from database, also remove them from system configuration. +B - Removes nodes. =head1 SYNOPSIS -B [-h| --help │ -v │ --version] +B [-h| --help | -v | --version] B =head1 DESCRIPTION -The B command removes nodes records from database, and also remove relative configuration automatically. +The B automatically removes all nodes from the database and any related configurations used by the node. -After nodes removed, the configuration files related with these nodes will be updated automatically. For example: /etc/hosts, dns configuration, dhcp configuration. And the kits node plugins will also be triggered automatically to update kit related configuration/services. +After the nodes are removed, the configuration files related to these nodes are automatically updated, including the following files: /etc/hosts, DNS, DHCP. Any kits that are used by the nodes are triggered to automatically update kit configuration and services. =head1 OPTIONS @@ -36,6 +36,8 @@ The nodes to be removed. =head1 EXAMPLES +To remove nodes compute-000 and compute-001, use the following command: + nodepurge compute-000,compute-001 =head1 SEE ALSO diff --git a/xCAT-client/pods/man1/noderefresh.1.pod b/xCAT-client/pods/man1/noderefresh.1.pod index f91dad194..a5059a445 100644 --- a/xCAT-client/pods/man1/noderefresh.1.pod +++ b/xCAT-client/pods/man1/noderefresh.1.pod @@ -1,16 +1,16 @@ =head1 NAME -B - Re-Call kit plugins for profiled nodes +B - Update nodes configurations by running associated kit plugins. =head1 SYNOPSIS -B [-h| --help │ -v │ --version] +B [-h| --help | -v | --version] B =head1 DESCRIPTION -The B command will just call kit plugins for profiled nodes, in-order to refresh node's related configurations/services. +The B command will update nodes settings, it will call all associated kit plug-in configurations and also services =head1 OPTIONS