Add man pages for mkconn,lsconn and rmconn

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@3575 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd

xCAT-client/pods/man1/lsconn.1.pod

@@ -0,0 +1,72 @@
+=head1 NAME
+
+B<lsconn> - Use this command to display the connection status from FSP and BPA nodes.
+
+=head1 SYNOPSIS
+
+B<lsconn> [B<-h>| B<--help>]
+
+B<lsconn> [B<-v>| B<--version>]
+
+B<lsconn> [B<-V>| B<--verbose>] noderange
+
+=head1 DESCRIPTION
+
+This command is used to display the connection status for FSP and BPA node. 
+=head1 OPTIONS
+
+=over 5
+
+=item B<-h|--help>
+
+Display usage message.
+
+=item B<-V|--verbose>
+
+Verbose output.
+
+=back
+
+
+=head1 RETURN VALUE
+
+0 The command completed successfully.
+
+1 An error has occurred.
+
+=head1 EXAMPLES
+
+=over 3
+
+=item 1.
+
+To display connection status for all FSP nodes in node group fsp:
+
+ lsconn fsp
+
+Output is similar to:
+cec1: ipaddr=192.168.200.245,alt_ipaddr=unavailable,state=Connected
+cec2: Connection not found
+
+To display connection status for BPA node frame1:
+frame1: side=a,ipaddr=192.168.200.247,alt_ipaddr=unavailable,state=Connected
+frame1: side=b,ipaddr=192.168.200.248,alt_ipaddr=unavailable,state=Connected
+
+=back
+
+
+=head1 FILES
+
+$XCATROOT/bin/lsconn
+
+(The XCATROOT environment variable is set when xCAT is installed. The
+default value is "/opt/xcat".)
+
+=head1 NOTES
+
+This command is part of the xCAT software product.
+
+
+=head1 SEE ALSO
+
+L<rmconn(1)|rmconn.1>, L<mkconn(1)|mkconn.1>

xCAT-client/pods/man1/mkconn.1.pod

@@ -0,0 +1,93 @@
+=head1 NAME
+
+B<mkconn> - Use this command to setup connections for FSP and BPA nodes to HMC nodes.
+
+=head1 SYNOPSIS
+
+B<mkconn> [B<-h>| B<--help>]
+
+B<mkconn> [B<-v>| B<--version>]
+
+B<mkconn> [B<-V>| B<--verbose>] noderange B<-t>
+
+B<mkconn> [B<-V>| B<--verbose>] noderange B<-H> hmc [B<-P> passwd]
+
+=head1 DESCRIPTION
+
+This command is used to setup connections for FSP and BPA nodes to HMC nodes. If the connection already exists, it will not bread this connection. 
+
+When -t is specified, this command reads the connection information from xCAT ppc table, and read the user/password from ppcdirect table. Then this command will assign FSP nodes and BPA nodes to HMC nodes. 
+
+When -H is specified, this command read the connection information from command line. The default user/password for FSP and BPA nodes are admin/admin.
+
+In any case, before running this command, the FSP and BPA nodes need be defined with correct nodetype.nodetype value (fsp or bpa) and nodehm.mgt value (hmc).
+
+Note: If a CEC (FSP node represents) belongs to a frame, which has a BPA installed, this CEC should not be assigned to an HMC individually. Instead, the whole frame (BPA node represents) should be assigned to the HMC.
+
+=head1 OPTIONS
+
+=over 5
+
+=item B<-h|--help>
+
+Display usage message.
+
+=item B<-t>
+
+Read connection information from xCAT DB.
+
+=item B<-H>
+
+The HMC node name. Only one HMC nodes can be specified by this flag. To setup connection for multiple HMC nodes, use flag -t.
+
+=item B<-P>
+
+The password of user 'admin' on FSP and BPA nodes. This flag is optional. Default password is 'admin'.
+
+=item B<-V|--verbose>
+
+Verbose output.
+
+=back
+
+
+=head1 RETURN VALUE
+
+0 The command completed successfully.
+
+1 An error has occurred.
+
+=head1 EXAMPLES
+
+=over 3
+
+=item 1.
+
+To setup the connection for all FSP nodes in node group fsp, according to the definition in xCAT DB:
+
+ mkconn fsp -t
+
+=item 2.
+
+To setup the connection for BPA nodes in node group frame_grp1 to HMC node hmc1, with password 'abc123':
+
+ mkconn frame_grp1 -H hmc1 -P abc123
+
+=back
+
+
+=head1 FILES
+
+$XCATROOT/bin/mkconn
+
+(The XCATROOT environment variable is set when xCAT is installed. The
+default value is "/opt/xcat".)
+
+=head1 NOTES
+
+This command is part of the xCAT software product.
+
+
+=head1 SEE ALSO
+
+L<lsconn(1)|lsconn.1>, L<rmconn(1)|rmconn.1>

xCAT-client/pods/man1/rmconn.1.pod

@@ -0,0 +1,70 @@
+=head1 NAME
+
+B<rmconn> - Use this command to remove connections from FSP and BPA nodes to HMC nodes.
+
+=head1 SYNOPSIS
+
+B<rmconn> [B<-h>| B<--help>]
+
+B<rmconn> [B<-v>| B<--version>]
+
+B<rmconn> [B<-V>| B<--verbose>] noderange
+
+=head1 DESCRIPTION
+
+This command is used to disconnect FSP and BPA nodes from HMC nodes, according to the connection information defined in ppc talbe in xCAT DB. 
+
+Note: If a CEC (FSP node represents) belongs to a frame with a BPA installed, this CEC cannot be disconnected individually. Instead, the whole frame (BPA node represents) should be disconnected.
+
+=head1 OPTIONS
+
+=over 5
+
+=item B<-h|--help>
+
+Display usage message.
+
+=item B<-V|--verbose>
+
+Verbose output.
+
+=back
+
+
+=head1 RETURN VALUE
+
+0 The command completed successfully.
+
+1 An error has occurred.
+
+=head1 EXAMPLES
+
+=over 3
+
+=item 1.
+
+To disconnect all FSP nodes in node group fsp from their HMC nodes:
+
+ rmconn fsp
+
+To remove the connection for BPA node frame1:
+ rmconn frame1
+
+=back
+
+
+=head1 FILES
+
+$XCATROOT/bin/rmconn
+
+(The XCATROOT environment variable is set when xCAT is installed. The
+default value is "/opt/xcat".)
+
+=head1 NOTES
+
+This command is part of the xCAT software product.
+
+
+=head1 SEE ALSO
+
+L<lsconn(1)|lsconn.1>, L<mkconn(1)|mkconn.1>