defect 3341: Add notes in the man page for how to use softoff and suspend function

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@15023 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
daniceexi 2013-01-31 06:31:30 +00:00
parent 625bbecc44
commit 32e11e9d60

View File

@ -8,6 +8,10 @@ B<rpower> I<noderange> [B<--nodeps>] [B<on>|B<onstandby>|B<off>|B<suspend>|B<sta
B<rpower> [B<-h>|B<--help>|B<-v>|B<--version>]
=head2 BMC (using IPMI) specific:
B<rpower> I<noderange> [B<on>|B<off>|B<softoff>|B<reset>|B<boot>|B<stat>|B<state>|B<status>|B<wake>|B<suspend> [B<-w> I<timeout>] [B<-o>] [B<-r>]]
=head2 PPC (with IVM or HMC) specific:
B<rpower> I<noderange> [B<--nodeps>] {B<of>}
@ -80,13 +84,40 @@ Reboot the service processor. If there are primary and secondary FSPs/BPAs of on
Attempt to request clean shutdown of OS (may not detect failures in completing command)
For stateless osimage, the 'acpid' package needs to be added to the .pkglist configuration file for the stateless osimage to enable the 'softoff' function.
=item B<off>
Turn power off.
=item B<suspend>
Suspend the target nodes execution
Suspend the target nodes execution.
The B<suspend> action could be run together with B<-w> B<-o> B<-r>.
Refer to the following steps to enable the B<suspend> function:
1. Add the 'acpid' and 'suspend' package to the .pkglist of your osimage so that the required package could be installed correctly to your target system.
2. Add two configuration files for the base function:
/etc/pm/config.d/suspend
S2RAM_OPTS="--force --vbe_save --vbe_post --vbe_mode"
/etc/acpi/events/suspend_event
event=button/sleep.*
action=/usr/sbin/pm-suspend
3. Add the hook files for your specific applications which need specific action before or after the suspend action.
Refer to the 'pm-utils' package for how to create the specific hook files.
=item B<wake>
Wake up the target nodes which is in B<suspend> state.
Don't try to run B<wake> against the 'on' state node, it would cause the node gets to 'off' state.
=item B<stat>|B<state>
@ -134,6 +165,18 @@ Specify the the timeout, in minutes, to wait for the expectedstatus specified by
Power off, then on.
=item B<-w> I<timeout>
To set the I<timeout> for the B<suspend> action to wait for the success.
=item B<-o>
To specify that the target node will be power down if B<suspend> action failed.
=item B<-r>
To specify that the target node will be reset if B<suspend> action failed.
=item B<-h>|B<--help>
Prints out a brief usage message.