From 7be4bec3e6078b60fc025b000f17e7779a8fa6a7 Mon Sep 17 00:00:00 2001
From: lissav <lissav@us.ibm.com>
Date: Thu, 13 Mar 2014 07:52:31 -0400
Subject: [PATCH]  add and improve zone manpages

---
 xCAT-client/pods/man1/rmzone.1.pod | 84 ++++++++++++++++++++++++++++++
 1 file changed, 84 insertions(+)
 create mode 100644 xCAT-client/pods/man1/rmzone.1.pod

diff --git a/xCAT-client/pods/man1/rmzone.1.pod b/xCAT-client/pods/man1/rmzone.1.pod
new file mode 100644
index 000000000..77b7682a8
--- /dev/null
+++ b/xCAT-client/pods/man1/rmzone.1.pod
@@ -0,0 +1,84 @@
+=head1 B<NAME>
+
+B<rmzone> - Removes a zone from the cluster. 
+
+=head1 B<SYNOPSIS>
+
+B<rmzone> <zonename>  [B<-g>] [B<-f>] 
+
+B<rmzone> [B<-h> | B<-v>]
+
+
+=head1 B<DESCRIPTION>
+
+The B<rmzone> command is designed to remove a previously defined zone from the cluster.
+It will remove the zone entry in the zone table.  It will remove the zone from the zonename attributes on the nodes that were assigned to the zone. Optionally, it will remove the zonename group from the nodes that were assigned to the zone. 
+It will also remove the root ssh keys that were created for that zone on the Management Node. 
+The rmzone command is only supported on Linux ( No AIX support).
+The nodes are not automatically updated with new root ssh keys by rmzone.  You must run updatenode -k  or xdsh -K to the nodes to update the root ssh keys. The nodes new ssh key will be assigned from the defaultzone in the zone table, or if  no entries in the zone table,  the keys will come from /root/.ssh.   
+Note: if any zones in the zone table, there must be one and only one defaultzone. Otherwise, errors will occur.  
+
+
+=head1 B<OPTIONS>
+
+=over 5
+
+=item B<-h>|B<--help> 
+
+Displays usage information. 
+
+=item B<-v>|B<--version> 
+
+Displays command version and build date. 
+
+=item B<-f | --force> 
+
+Used to remove a zone that is defined as current default zone.  This should only be done if you are removing all zones, or you will
+adding a new zone or changing an existing zone to be the default zone. 
+
+=item B<-g | --assigngroup> 
+
+Remove the assigned group named B<zonename> from all nodes assigned to the zone being removed. 
+
+=item B<-V>|B<--Verbose>
+
+Verbose mode.
+
+
+=back
+
+
+=head1 B<Examples>
+
+=over 3
+
+=item *
+
+To remove zone1 from the zone table and the zonename attribute on all it's assigned nodes , enter:
+
+B<rmzone> I<zone1>
+
+
+=item *
+
+To remove zone2 from the zone table, the zone2 zonename attribute, and the zone2 group assigned to all nodes that were in zone2, enter:
+
+B<rmzone> I<zone2> -g 
+
+=item *
+
+To remove zone3 from the zone table, all the node zone attributes and  override the fact it is the defaultzone,  enter:
+
+B<rmzone> I<zone3> -g -f
+
+=back
+
+B<Files>
+
+B</opt/xcat/bin/rmzone/>
+
+Location of the rmzone command.
+
+=head1 B<SEE ALSO>
+
+L <xdsh(1)|xdsh.1>, L<updatenode(1)|updatenode.1>