lustre/doc/lustre_routes_config.8

   1 .TH lustre_routes_config 8 "Apr 23, 2013" Lustre "utilities"
   2 .SH NAME
   3 lustre_routes_config \- Configure routes dynamically
   4 .SH SYNOPSIS
   5 .B "lustre_routes_config"
   6 .SH DESCRIPTION
   7 lustre_route_config sets or cleans up LNET routes from the specified config
   8 file.  /etc/lnet_routes.conf file can be used to automatically
   9 configure routes on LNET startup.
  10 .LP
  11 The format of the config file is:
  12 .br
  13 <network>: { gateway: <gateway>@<exit network> [hop: <hop>]
  14              [priority: <prioirty>] }
  15 .LP
  16 Usage:
  17 .br
  18 lustre_routes_config [--setup|--cleanup|--dry-run|--verbose] <config_file>
  19 .TP
  20 .I "\-\-setup"
  21 Configure routes listed in config_file
  22 .TP
  23 .I "\-\-cleanup"
  24 Unconfigure routes listed in config_file
  25 .TP
  26 .I "\-\-dry-run"
  27 Echo commands to be run, but do not execute them
  28 .TP
  29 .I "\-\-verbose"
  30 Echo commands before they are executed
  31 .LP
  32 NOTE: An LNET router is identified when its local NID appears within the
  33 list of routes.  However, this can not be achieved by the use of this
  34 script, since the script only adds extra routes after the role of the
  35 router is determined.  To ensure that a router is identified correctly,
  36 make sure to add its local NID in the routes parameter in the modprobe
  37 lustre configuration file.
  38 .SH EXAMPLE
  39 An example of a config file that the script expects:
  40 .LP
  41 tcp1: { gateway: 10.1.1.2@tcp0, priority: 3 }
  42 .br
  43 tcp4: { gateway: 10.3.3.4@tcp }
  44 .br
  45 tcp6: { gateway: 10.3.3.6@tcp, hop: 2, priority: 5 }
  46 .br
  47 tcp7: { gateway: 10.3.3.[6-12]@tcp, priority: 20, hop: 8 }
  48 .LP
  49 An example of script execution:
  50 .LP
  51 lustre_routes_config --setup <path/to/routes_config_file>
  52 .br
  53 lustre_routes_config --cleanup <path/to/routes_config_file>
  54 .SH SEE ALSO
  55 .BR lustre (7)
  56 .BR nids (5)
  57 .BR lctl (8)
  58 .BR lustre_routes_conversion (8)
  59 .SH FILES
  60 /etc/lnet_routes.conf
  61 .SH AUTHOR
  62 Amir Shehata