lustre/doc/lconf.8

   1 .TH lconf 1 "2004 Sep 16" Lustre "configuration utilities"
   2 .SH NAME
   3 lconf \- Lustre filesystem configuration utility
   4 .SH SYNOPSIS
   5 .br
   6 .B lconf
   7 [--node <node_name>] [-d,--cleanup] [--noexec] [--gdb] [--nosetup] [--nomod] [-n,--noexec] [-v,--verbose] [-h,--help] <XML-config file>
   8 [options] --add <objecttype> [args]
   9 .br
  10 .SH DESCRIPTION
  11 .B lconf
  12 , when invoked configures a node following directives in the <XML-config-file>. There will be single configuration file for all the nodes in a single cluster. This file should be distributed to all the nodes in the cluster or kept in a location accessible to all the nodes. One option is to store the cluster configuration information in LDAP format on an LDAP server that can be reached from all the cluster nodes.
  13 .PP
  14 The arguments that can be used for lconf are:
  15 .PP
  16 .TP
  17 --client_uuid <uuid>
  18 The failed client (required for recovery).
  19 .TP
  20 --clientoptions <options>
  21 Additional options for Lustre.
  22 .TP
  23 --config <arg>
  24 Cluster configuration name used for LDAP query
  25 .TP
  26 --conn_uuid <uuid>
  27 The failed connection (required for recovery).
  28 .TP
  29 --d|--cleanup
  30 Unconfigure a node. The same config and --node argument used for configuration needs to be used for cleanup as well. This will attempt to undo all of the configuration steps done by lconf, including unloading the kernel modules.
  31 .TP
  32 --debug_path <path>
  33 Path to save debug dumps.
  34 .TP
  35 --dump <file>
  36 Dump the kernel debug log to the specified file before portals is unloaded during cleanup.
  37 .TP
  38 --dump_path <arg>
  39 Path to save debug dumps. Default is /tmp/lustre_log
  40 .TP
  41 --failover
  42 Used to shutdown without saving state. Default is 0. This will allow the node to give up service to another node for failover purposes. This will not be a clean shutdown.
  43 .TP
  44 --force
  45 Forced unmounting and/or obd detach during cleanup. Default is 0.
  46 .TP
  47 --gdb
  48 Causes lconf to print a message and pause for 5 seconds after creating a gdb module script and before doing any Lustre configuration (the gdb module script is always created, however).
  49 .TP
  50 --gdb_script <arg>
  51 Full name of gdb debug script. Default is /tmp/ogdb.
  52 .TP
  53 --group <arg>
  54 The group of devices to cleanup/configure.
  55 .TP
  56 -h,--help
  57 Print help.
  58 .TP
  59 --inactive <UUID>
  60 The UUID of the service to be ignored by a client mounting Lustre. Allows the client to mount in the presence of some inactive services. (currently OST only). Multiple UUIDs can be specified by repeating the option.
  61 .TP
  62 --lctl-dump <arg>
  63 Dump all ioctls to the specified file
  64 .TP
  65 --ldapurl <arg>
  66 LDAP server URL
  67 .TP
  68 --lustre_upcall <path>
  69 Set the location of the Lustre upcall scripts used by the client for recovery
  70 .TP
  71 --lustre=src_dir
  72 Specify the base directory for Lustre sources, this parameter will cause lconf to load the lustre modules from this soure tree.
  73 .TP
  74 --mds_ost_conn
  75 Open connections to OSTs on MDS.
  76 .TP
  77 --maxlevel <level>
  78 Perform configuration of devices and services up to level given. level can take the values net, dev, svc, fs. When used in conjunction with cleanup, services are torn down up to a certain level. Default is 100.
  79 .TP
  80 --minlevel <level>
  81 Specify the minimum level of services to configure/cleanup. Default is 0.
  82 .TP
  83 --mkfsoptions <options>
  84 Specify additional options for the mk*fs command line.
  85 .TP
  86 --mountfsoptions <options>
  87 Specify additional options for mount fs command line. Mount options will be passed by this argument. For example, extents are to be enabled by adding ",extents" to the --mountfsoptions option. "errors=remount-ro" and "asyncdel" can also be added to it.
  88 .TP
  89 --node node_name
  90 Specify a specific node to configure. By default, lconf will search for nodes with the local hostname and 'localhost'. When --node is used, only node_name is searched for. If a matching node is not found in the config, then lconf exits with an error.
  91 .TP
  92 --noexec,-n
  93 Print, but don't execute, the steps lconf will perform. This is useful for debugging a configuration, and when used with --node, can be run on any host.
  94 .TP
  95 --nomod
  96 Only setup devices and services, do not load modules.
  97 .TP
  98 --nosetup
  99 Only load modules, do not configure devices or services.
 100 .TP
 101 --portals <path>
 102 Specify portals source directory. If this is a relative path, then it is assumed to be relative to lustre.
 103 .TP
 104 --portals_upcall <path>
 105 Specify the location of the Portals upcall scripts used by the client for recovery
 106 .TP
 107 --ptldebug debug-level
 108 This options can be used to set the required debug level.
 109 .TP
 110 --record
 111 Write config information on mds.
 112 .TP
 113 --record_log <arg>
 114 Specify the name of config record log.
 115 .TP
 116 --record_device <arg>
 117 Specify MDS device name that will record the config commands.
 118 .TP
 119 --recover <arg>
 120 Recover a device.
 121 .TP
 122 --reformat
 123 Reformat all the devices. This is essential on the first time the file system is brought up.
 124 .TP
 125 --select <arg>
 126 Select a particular node for a service
 127 .TP
 128 --subsystem <arg>
 129 Set the portals debug subsystem.
 130 .TP
 131 --tgt_uuid <uuid>
 132 Specify the failed target (required for recovery).
 133 .TP
 134 --timeout <arg>
 135 Set the recovery timeout period.
 136 .TP
 137 --upcall <path>
 138 Set the location of both Lustre and Portals upcall scripts used by the client for recovery
 139 .TP
 140 --verbose,-v
 141 Be verbose and show actions while going along.
 142 .TP
 143 --write_conf
 144 Save all client configuration information on the MDS
 145 .SH EXAMPLES
 146 .TP
 147 .B lconf --node client config.xml
 148 This invokes lconf on the client node.
 149 .TP
 150 .B lconf --ptldebug "~(portals | malloc | trace)"
 151 Used to set the required debug levels (all but these).
 152 .TP
 153 .B lconf --ptldebug "ldlm|ha"
 154 Used to turn-on specific debug types.
 155 .TP
 156 .B lconf --inactive OST_ost1_UUID --inactive OST_ost2_UUID config.xml
 157 A subset of failed OSTs can be ignored during Lustre mount on the clients by using this option. Here OST1 and OST2 have failed and need to be ignored.
 158 .SH BUGS
 159 None are known.