From 60a2d36b37e171393a51344580f10e3854db386a Mon Sep 17 00:00:00 2001
From: nott <nott@8638fb3e-16cb-4fca-ae20-7b5d299a9bcd>
Date: Mon, 1 Mar 2010 13:45:38 +0000
Subject: [PATCH] Add support for diskless dump.

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@5322 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
---
 xCAT-client/pods/man1/mkdsklsnode.1.pod |   8 ++
 xCAT-client/pods/man1/mknimimage.1.pod  | 111 +++++++++++++++++++++++-
 2 files changed, 115 insertions(+), 4 deletions(-)

diff --git a/xCAT-client/pods/man1/mkdsklsnode.1.pod b/xCAT-client/pods/man1/mkdsklsnode.1.pod
index 240baf3ed..09c78fa3f 100644
--- a/xCAT-client/pods/man1/mkdsklsnode.1.pod
+++ b/xCAT-client/pods/man1/mkdsklsnode.1.pod
@@ -47,6 +47,14 @@ Specifies the speed setting (optional). Used when defining the NIM machine. This
 
 Specifies the size in Megabytes of the paging space for the diskless node.(optional) Used when initializing the NIM machine. The minimum and default size is 64 MB of paging space. (ex. "psize=64")
 
+=item B<dump_iscsi_port>
+
+The tcpip port number to use to communicate dump images from the client to the dump	resource server. Normally set by default. This port number is used by a dump resource server.
+
+=item B<configdump>
+
+Specifies the type dump to be collected at the client.  The values are "selective", "full", and	"none".  If the configdump attribute is set to "full" or "selective" the client will automatically be setup to dump to an iSCSI Target device. The "selective" memory dump will avoid dumping user data. The "full" memory dump will dump all the memory of the client partition. Selective and full memory dumps will be collected in the dump resource allocated to the client. Only POWER6 clients an dump to the dump resource.
+
 =back
 
 =item B<-f |--force>
diff --git a/xCAT-client/pods/man1/mknimimage.1.pod b/xCAT-client/pods/man1/mknimimage.1.pod
index f0f339fdf..979174e0f 100644
--- a/xCAT-client/pods/man1/mknimimage.1.pod
+++ b/xCAT-client/pods/man1/mknimimage.1.pod
@@ -8,7 +8,7 @@ B<mknimimage [-h | --help ]>
 
 B<mknimimage [-V] -u osimage_name [attr=val [attr=val ...]]>
 
-B<mknimimage [-V] [-f|--force] [-r|--sharedroot] [-l location] [-s image_source] [-i current_image] [-t nimtype] [-m nimmethod] [-n mksysbnode] [-b mksysbfile] osimage_name [attr=val [attr=val ...]]>
+B<mknimimage [-V] [-f|--force] [-r|--sharedroot] [-D|--mkdumpres] [-l location] [-s image_source] [-i current_image] [-t nimtype] [-m nimmethod] [-n mksysbnode] [-b mksysbfile] osimage_name [attr=val [attr=val ...]]>
 
 =head1 DESCRIPTION
 
@@ -48,7 +48,104 @@ To remove specific NIM resource definitons use the AIX nim command.
 
 =item B<attr=val [attr=val ...]>
 
-Specifies one or more "attribute equals value" pairs, separated by spaces. Attr=val pairs must be specified last on the command line. These are used to specify additional or different information to use when creating the the xCAT osimage definition.  Note that you may specify multiple "script", "otherpkgs", and "installp_bundle" resources by using a comma seperated list. (ex. "script=ascript,bscript"). RPM names may be included in the "otherpkgs" list by using a "R:" prefix(ex. "R:whatever.rpm"). Valid attribute names include any of the attributes of the xCAT osimage object plus "installp_flags". (The default for installp_flags is "-agQX".)
+Specifies one or more "attribute equals value" pairs, separated by spaces. Attr=val pairs must be specified last on the command line. 
+
+Currently supported attributes:
+
+=over 3
+
+=item B<bosinst_data>
+
+The name of a NIM bosinst_data resource.
+
+=item B<dump>
+
+The name of the NIM dump resource.
+
+=item B<fb_script>
+
+The name of a NIM fb_script resource.
+
+=item B<home>
+
+The name of the NIM home resource.
+
+=item B<installp_bundle>
+
+One or more comma separated NIM installp_bundle resources.
+
+=item B<lpp_source>
+
+The name of the NIM lpp_source resource.
+
+=item B<mksysb>
+
+The name of a NIM mksysb resource.
+
+=item B<otherpkgs>
+
+One or more comma separated installp or rpm packages.  The rpm packages must have a prefix of 'R:', (ex. R:foo.rpm)
+
+=item B<paging> 
+
+The name of the NIM paging resource.
+
+=item B<resolv_conf> 
+
+The name of the NIM resolv_conf resource.
+
+=item B<root>
+
+The name of the NIM root resource.
+
+=item B<script>
+
+The name of a NIM script resource.
+
+=item B<shared_home>
+
+The name of the NIM shared_home resource.
+
+=item B<shared_root>
+
+A shared_root resource represents a directory that can be used as a / (root) directory by one or more diskless clients.
+
+=item B<spot>
+
+The name of the NIM SPOT resource.
+
+=item B<synclists>
+
+The fully qualified name of a file containing a list of files to synchronize on the nodes.
+
+=item B<tmp>
+
+The name of the NIM tmp resource.
+
+=item B<installp_flags>
+
+The alternate flags to be passed along to the AIX installp command. (The default for installp_flags is "-agQX".)
+
+=item B<dumpsize>
+
+The maximum size for a single dump image the dump resource will accept. Space is not allocated until a client starts to dump. The default size is 50GB. The dump resource should be large enough to hold the expected AIX dump and snap data.  
+
+=item B<max_dumps>
+
+The maximum number of archived dumps for an individual client. The default is one. 
+
+=item B<notify>
+
+An administrator supplied script that will be invoked when a new dump is captured, or when a dump error occurs on the client.
+
+=item B<snapcollect>
+
+Indicates that after a dump is collected then snap data should be collected. The snap data will be collected in the clients dump resource directory.  Values are "yes" or "no". The default is "no".
+
+
+=back
+
+Note that you may specify multiple "script", "otherpkgs", and "installp_bundle" resources by using a comma seperated list. (ex. "script=ascript,bscript"). RPM names may be included in the "otherpkgs" list by using a "R:" prefix(ex. "R:whatever.rpm"). 
 
 =item B<-b mksysbfile>
 
@@ -66,6 +163,10 @@ Display usage message.
 
 The name of the xCAT osimage definition.  This will be used as the name of the xCAT osimage definition as well as the name of the NIM SPOT resource.
 
+=item B<-D|--mkdumpres>
+
+Create a diskless dump resource.
+
 =item B<-i current_image>
 
 The name of an existing xCAT osimage that should be copied to make a new xCAT osimage definition. Only valid when defining a "diskless" or "dataless" type image.
@@ -152,9 +253,11 @@ This command defines a NIM mksysb resource and a spot definition using mysysbima
 
 B<mknimimage -t diskless -s /AIX/instimages 61dskls>
 
-7) Create a diskless image called "614dskls" that includes a NIM "shared_root" resource.  Use the existing NIM lpp_resource called "614_lpp_source". Also specify verbose output.
+7) Create a diskless image called "614dskls" that includes a NIM "shared_root" and a "dump" resource.  Use the existing NIM lpp_resource called "614_lpp_source". Also specify verbose output.
 
-B<mknimimage -V -r -t diskless -s 614_lpp_source 614dskls>
+B<mknimimage -V -r -D -t diskless -s 614_lpp_source 614dskls snapcollect=yes>
+
+The "snapcollect" attribute specifies that AIX "snap" data should be include when a system dump is initiated.
 
 8) Create a new diskless image by copying an existing image.