diff --git a/xCAT-client/pods/man8/makeroutes.8.pod b/xCAT-client/pods/man8/makeroutes.8.pod index 3fce2f37d..97e14e7ce 100644 --- a/xCAT-client/pods/man8/makeroutes.8.pod +++ b/xCAT-client/pods/man8/makeroutes.8.pod @@ -1,6 +1,6 @@ =head1 NAME -B - add routes to connect the mn to the nodes via the service nodes. +B - add or delete routes to/from the os route table on nodes. =head1 SYNOPSIS @@ -8,15 +8,22 @@ B [B<-r>|B<--routename> I[I<,r2...>]] B B<-d>|B<--delete> [B<-r>|B<--routenames> I[I<,r2...>]] -B [B<-n>|B<--net> I] [B<-g>|B<--gateway> I] [B<-m>|B<--mask> I] +B I [B<-r>|B<--routename> I[I<,r2...>]] -B B<-d>|B<--delete> [B<-n>|B<--net> I] [B<-g>|B<--gateway> I] [B<-m>|B<--mask> I] +B I B<-d>|B<--delete> [B<-r>|B<--routenames> I[I<,r2...>]] B [B<-h> B<--help>|B<-v>|B<--version>] =head1 DESCRIPTION -The B command adds routes to connect the mn to the nodes via the service nodes. It first reads the routing info from xCAT's B table and then adds the routes to the Kernel IP routing table for the os. It also gets all the gateways from the table. If a gateway is a service node, it sets b to 1 and then goes to the service node to enable the ipforwarding. +The B command adds or deletes routes on the management node or any given nodes. The B specifies the nodes where the routes are to be added or removed. When the I is omitted, the action will be done on the management node. The B<-r> option specifies the name of routes. The details of the routes are defined in the B table which contians the route name, subnet, net mask and gateway. If -r option is omitted, the names of the routes found on B for the nodes or on B for the management node will be used. + +If you want the routes be automatically setup during node deployment, first put a list of route names to B and then add I script name to the B for the nodes. + + +=head1 Parameters + +I specifies the nodes where the routes are to be added or removed. If omitted, the operation will be done on the management node. =head1 OPTIONS @@ -29,19 +36,7 @@ Specifies to delete the given routes. If not specified, the action is to add rou =item B<-r|--routename> -Specifies a list of comma separated route names defined in the B table. If omitted, all routes defined in the B table will be used. - -=item B<-n|--net> - -Specifies the network address. - -=item B<-g|--gateway> - -Specifies the gateway that routes the ip traffic from the mn to the nodes. - -=item B<-m|--mask> - -Specified the network mask. +Specifies a list of comma separated route names defined in the B table. If omitted, all routes defined in B for nodes or B for the management node will be used. =item B<-h|--help> @@ -60,29 +55,27 @@ Command Version. =item 1. -To add all routes from the B table to the os route table: +To add all routes from the B to the os route table for the management node. makeroutes =item 2. -To add route rr1 and rr2 to the os route table. +To add all the routes from B to the os route table for node1. - makeroutes -r rr1,rr2 + makeroutes node1 =item 3. -To delete route rr1 and rr2 from the os route table. +To add route rr1 and rr2 to the os route table for the management node. - makeroutes -d -r rr1,rr2 + makeroutes -r rr1,rr2 =item 4. -To add a specific route to the os route table. +To delete route rr1 and rr2 from the os route table on node1 and node1. - makeroutes -n 10.0.1.0 - - The 10.0.1.0 netrwork must be defined in the xCAT's routes table. + makeroutes node1,node2 -d -r rr1,rr2 =back