arif/xcat-core
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

man page update for makeroutes

Browse Source 
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@9259 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
linggao 2011-04-08 20:38:18 +00:00
parent f140c19e7a
commit b73e44ef64
1 changed files with 19 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
xCAT-client/pods/man8/makeroutes.8.pod
View File

@ -1,6 +1,6 @@
=head1 NAME
B<makeroutes> - add routes to connect the mn to the nodes via the service nodes.
B<makeroutes> - add or delete routes to/from the os route table on nodes.
=head1 SYNOPSIS
@ -8,15 +8,22 @@ B<makeroutes> [B<-r>|B<--routename> I<r1>[I<,r2...>]]
B<makeroutes> B<-d>|B<--delete> [B<-r>|B<--routenames> I<r1>[I<,r2...>]]
B<makeroutes> [B<-n>|B<--net> I<net>] [B<-g>|B<--gateway> I<gw>] [B<-m>|B<--mask> I<netmask>]
B<makeroutes> I<noderange> [B<-r>|B<--routename> I<r1>[I<,r2...>]]
B<makeroutes> B<-d>|B<--delete> [B<-n>|B<--net> I<net>] [B<-g>|B<--gateway> I<gw>] [B<-m>|B<--mask> I<netmask>]
B<makeroutes> I<noderange> B<-d>|B<--delete> [B<-r>|B<--routenames> I<r1>[I<,r2...>]]
B<makeroutes> [B<-h> B<--help>|B<-v>|B<--version>]
=head1 DESCRIPTION
The B<makeroutes> command adds routes to connect the mn to the nodes via the service nodes. It first reads the routing info from xCAT's B<routes> 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<servicenode.ipforward> to 1 and then goes to the service node to enable the ipforwarding.
The B<makeroutes> command adds or deletes routes on the management node or any given nodes. The B<noderange> specifies the nodes where the routes are to be added or removed. When the I<noderange> 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<routes> table which contians the route name, subnet, net mask and gateway. If -r option is omitted, the names of the routes found on B<noderes.routenames> for the nodes or on B<site.routenames> 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<noderes.routenames> and then add I<setroute> script name to the B<postscripts.postbootscripts> for the nodes.
=head1 Parameters
I<noderange> 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<routes> table. If omitted, all routes defined in the B<routes> 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<routes> table. If omitted, all routes defined in B<noderes.routenames> for nodes or B<site.routenames> 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<routes> table to the os route table:
To add all routes from the B<site.routenames> 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<noderes.routenames> 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