From 05926e3cd5d49c8eff23c63f40efd0b96e748252 Mon Sep 17 00:00:00 2001 From: ligc Date: Wed, 8 Jul 2009 03:14:41 +0000 Subject: [PATCH] automatic retry feature manpage updates git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@3724 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd --- xCAT-client/pods/man1/rnetboot.1.pod | 11 ++++++++++- xCAT-client/pods/man1/rpower.1.pod | 18 +++++++++++++++++- 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/xCAT-client/pods/man1/rnetboot.1.pod b/xCAT-client/pods/man1/rnetboot.1.pod index 3b4f692dd..2ee7e1afb 100644 --- a/xCAT-client/pods/man1/rnetboot.1.pod +++ b/xCAT-client/pods/man1/rnetboot.1.pod @@ -4,7 +4,7 @@ B - Cause the range of nodes to boot to network. =head1 SYNOPSIS -B [B<-V>|B<--verbose>] B<[-s boot_device_order]> B<[-f]> I +B [B<-V>|B<--verbose>] B<[-s boot_device_order]> B<[-f]> I [-m table.column==expectedstatus [-m table.col-umn=~expectedstatus]] [-t timeout] [-r retrycount] B [B<-h>|B<--help>] [B<-v>|B<--version>] @@ -21,6 +21,15 @@ B<-s> Set the boot device order. Accepted boot devices are hd and net. B<-f> Force immediate shutdown of the partition. +B<-m> Use one or multiple -m flags to specify the node attributes and the expected status for the node installation monitor +ing and automatic retry mechanism. The operators ==, !=, =~ and !~ are valid. This flag must be used with -t flag. + +Note: if the "val" fields includes spaces or any other characters that will be parsed by shell, the "attrval" needs to be quoted. If the operator is "!~", the "attrval" needs to be quoted using single quote. + +B<-r> specify the number of retries that the monitoring process will perform before declare the failure. The default value is 3. Setting the retrycount to 0 means only monitoring the os installation progress and will not re-initiate the installation if the node status has not been changed to the expected value after timeout. This flag must be used with -m flag. + +B<-t> Specify the the timeout, in minutes, to wait for the expectedstatus specified by -m flag. This is a required flag if the -m flag is specified. + B<-V> Verbose output. B<-h> Display usage message. diff --git a/xCAT-client/pods/man1/rpower.1.pod b/xCAT-client/pods/man1/rpower.1.pod index 16beb96fc..2e34b02a2 100644 --- a/xCAT-client/pods/man1/rpower.1.pod +++ b/xCAT-client/pods/man1/rpower.1.pod @@ -4,7 +4,7 @@ B - remote power control of nodes =head1 SYNOPSIS -B I [B<--nodeps>] {B|B|B|B|B|B|B} +B I [B<--nodeps>] {B|B|B|B|B|B|B} [-m table.column==expectedstatus [-m table.column=~expectedstatus]] [-t timeout] [-r retrycount] B [B<-h>|B<--help>|B<-v>|B<--version>] @@ -66,10 +66,26 @@ Power off, then on. Boot the node to open firmware mode. +=item B<-m table.column==expectedstatus -m table.column=~expectedstatus> + +Use one or multiple -m flags to specify the node attributes and the expected status for the node installation monitoring and automatic retry mechanism. The operators ==, !=, =~ and !~ are valid. This flag must be used with -t flag. + +Note: if the "val" fields includes spaces or any other characters that will be parsed by shell, the "attrval" needs to be quoted. If the operator is "!~", the "attrval" needs to be quoted using single quote. + =item B<--nodeps> Do not use dependency table (default is to use dependency table). Valid only with on|off|boot|reset|cycle for blade power method. +=item B<-r retrycount> + +specify the number of retries that the monitoring process will perform before declare the failure. The default value is 3. Setting the retrycount to 0 means only monitoring the os installation progress and will not re-initiate the installation if the node status has not been changed to the expected value after timeout. This flag must be used with -m flag. + +=item B<-t timeout> + +Specify the the timeout, in minutes, to wait for the expectedstatus specified by -m flag. This is a required flag if the -m flag is specified. + +Power off, then on. + =item B<-h>|B<--help> Prints out a brief usage message.