From d0b8e9c819ce6f4316030668533d0e88902d4126 Mon Sep 17 00:00:00 2001
From: lissav <lissav@8638fb3e-16cb-4fca-ae20-7b5d299a9bcd>
Date: Tue, 8 Jan 2008 15:20:46 +0000
Subject: [PATCH] Add pods for new hardware control commands

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@225 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
---
 xCAT-client-2.0/pods/man1/chvm.1.pod | 56 ++++++++++++++++++++++
 xCAT-client-2.0/pods/man1/mkvm.1.pod | 72 ++++++++++++++++++++++++++++
 xCAT-client-2.0/pods/man1/rmvm.1.pod | 66 +++++++++++++++++++++++++
 3 files changed, 194 insertions(+)
 create mode 100644 xCAT-client-2.0/pods/man1/chvm.1.pod
 create mode 100644 xCAT-client-2.0/pods/man1/mkvm.1.pod
 create mode 100644 xCAT-client-2.0/pods/man1/rmvm.1.pod

diff --git a/xCAT-client-2.0/pods/man1/chvm.1.pod b/xCAT-client-2.0/pods/man1/chvm.1.pod
new file mode 100644
index 000000000..a1a70cb50
--- /dev/null
+++ b/xCAT-client-2.0/pods/man1/chvm.1.pod
@@ -0,0 +1,56 @@
+=head1 NAME
+ 
+B<chvm> - Changes HMC- and IVM-managed partition profiles.  
+ 
+=head1 SYNOPSIS
+ 
+I<chvm [-h| --help]>
+
+I<chvm  [-v| --version]>
+
+
+I<chvm [-V| --verbose] noderange>
+
+
+=head1 DESCRIPTION
+
+The chvm command modifies the partition profile for the partitions specified in noderange. A partitions current profile can be read using lsvm, modified, and piped into the chvm command.
+
+=head1 OPTIONS
+
+
+B<-h>          Display usage message.
+
+B<-v>          Command Version. 
+
+B<-V>          Verbose output. 
+
+
+=head1 RETURN VALUE
+
+0 The command completed successfully.
+
+1 An error has occurred.
+
+=head1 EXAMPLES
+
+1. To change the partition profile for lpar4 using the configuration data in the file /tmp/lparfile, enter: 
+
+I<cat /tmp/lparfile | chvm lpar4> 
+
+Output is similar to:
+
+lpar4: Success
+
+
+=head1 FILES
+ 
+/opt/xcat/bin/chvm
+
+
+=head1 NOTES
+
+This command is part of the xCAT software product.
+
+
+ 
diff --git a/xCAT-client-2.0/pods/man1/mkvm.1.pod b/xCAT-client-2.0/pods/man1/mkvm.1.pod
new file mode 100644
index 000000000..ce0cb60d8
--- /dev/null
+++ b/xCAT-client-2.0/pods/man1/mkvm.1.pod
@@ -0,0 +1,72 @@
+=head1 NAME
+ 
+B<mkvm> - Creates HMC- and IVM-managed partitions.  
+ 
+=head1 SYNOPSIS
+ 
+I<mkvm [-h| --help]>
+
+I<mkvm  [-v| --version]>
+
+I<mkvm [-V| --verbose] singlenode -i id -n name>
+
+I<mkvm [-V| --verbose] src_fsp -c dest_fsp>
+
+
+=head1 DESCRIPTION
+
+The mkvm command creates a new partition with the same profile/resources as the partition specified by singlenode. The -i and -n flags specify the numeric partition number and name of the newly created partition, respectively. The second form of this command duplicates all the partitions associated with src_fsp to dest_fsp. Note that src_dest and dest_fsp must be associated with the same HMC. Newly created partitions are automatically added to the xCAT database.
+
+=head1 OPTIONS
+
+
+B<-h>          Display usage message.
+
+B<-c>          Copy partitions from src_fsp to dest_fsp on single HMC 
+
+B<-i>          New partition numeric id 
+
+B<-n>          New partition name 
+
+B<-v>          Command Version. 
+
+B<-V>          Verbose output. 
+
+
+=head1 RETURN VALUE
+
+0 The command completed successfully.
+
+1 An error has occurred.
+
+=head1 EXAMPLES
+
+1. To create a new partition lpar5 based on the profile/resources of lpar4, enter:  
+
+I<mkvm lpar4 -i 5 -n lpar5> 
+
+Output is similar to:
+
+lpar5: Success
+
+
+
+2. To duplicate all the partitions associated with fsp01 on fsp02, enter:  
+
+I<mkvm fsp01 .c fsp02> 
+
+Output is similar to:
+
+fsp02: Success
+
+=head1 FILES
+ 
+/opt/xcat/bin/mkvm
+
+
+=head1 NOTES
+
+This command is part of the xCAT software product.
+
+
+ 
diff --git a/xCAT-client-2.0/pods/man1/rmvm.1.pod b/xCAT-client-2.0/pods/man1/rmvm.1.pod
new file mode 100644
index 000000000..8a66f5bfa
--- /dev/null
+++ b/xCAT-client-2.0/pods/man1/rmvm.1.pod
@@ -0,0 +1,66 @@
+=head1 NAME
+ 
+B<rmvm> - Removes HMC- and IVM-managed partitions.  
+ 
+=head1 SYNOPSIS
+ 
+I<rmvm [-h| --help]>
+
+I<rmvm  [-v| --version]>
+
+
+I<rmvm [-V| --verbose] noderange>
+
+
+=head1 DESCRIPTION
+
+The rmvm command removes the partitions specified in noderange. If noderange is an FSP, all the partitions associated with that FSP will be removed. Note that removed partitions are automatically removed from the xCAT database. For IVM-managed systems, care must be taken to not remove the VIOS partition, or all the associated partitions will be removed as well.
+
+=head1 OPTIONS
+
+
+B<-h>          Display usage message.
+
+B<-v>          Command Version. 
+
+B<-V>          Verbose output. 
+
+
+=head1 RETURN VALUE
+
+0 The command completed successfully.
+
+1 An error has occurred.
+
+=head1 EXAMPLES
+
+1. To remove the partition lpar3, enter: 
+
+I<rmvm lpar3> 
+
+Output is similar to:
+
+lpar3: Success
+
+2. To remove all the partitions associated with FSP fsp01, enter:
+
+I<rmvm fsp01>
+
+Output is similar to:
+
+ lpar1: Success
+ lpar2: Success
+ lpar3: Success
+
+
+=head1 FILES
+ 
+/opt/xcat/bin/rmvm
+
+
+=head1 NOTES
+
+This command is part of the xCAT software product.
+
+
+