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 [OPTIONS] <XML-config file>
   8 .br
   9 .SH DESCRIPTION
  10 .B lconf
  11 , when invoked configures a node following directives in the
  12 <XML-config-file>.Can be used to control recovery and startup/shutdown
  13 . There will be single configuration file for all the nodes in a
  14 single cluster. This file should be distributed to all the nodes in
  15 the cluster or kept in a location accessible to all the nodes. The XML file must be specified. When invoked with no options, lconf will attempt to configure the resources owned by the node it is invoked on
  16 .PP
  17 The arguments that can be used for lconf are:
  18 .PP
  19 .TP
  20 --abort_recovery - Used to start Lustre when you are certian that
  21 recovery will not succeed, as when an OST or MDS is disabled.
  22 .TP
  23 --acl Enable Access Control List support on the MDS
  24 .TP
  25 --allow_unprivileged_port Allows connections from unprivileged ports
  26 .TP
  27 --clientoptions <options>
  28 Additional options for mounting Lustre clients. Obsolete with
  29 zeroconfig mounting..
  30 .TP
  31 --client_uuid <uuid>
  32 The failed client (required for recovery).
  33 .TP
  34 --clumanager Generate a Red Hat Clumanager configuration file for this
  35 node.
  36 .TP
  37 --config <arg>
  38 Cluster configuration name used for LDAP query (depreciated)
  39 .TP
  40 --conn_uuid <uuid>
  41 The failed connection (required for recovery).
  42 .TP
  43 -d|--cleanup
  44 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.
  45 .TP
  46 --debug_path <path>
  47 Path to save debug dumps.(default is /tmp/lustre-log)
  48 .TP
  49 --dump <file>
  50 Dump the kernel debug log to the specified file before portals is unloaded during cleanup.
  51 .TP
  52 --failover
  53 Used to shutdown without saving state. This will allow the node to give up service to another node for failover purposes. This will not be a clean shutdown.
  54 .TP
  55 -f|--force
  56 Forced unmounting and/or obd detach during cleanup.
  57 .TP
  58 --gdb
  59 Causes lconf to create a gdb module script and pause 5 seconds before doing any Lustre configuration (the gdb module script is always created, however).
  60 .TP
  61 --gdb_script <arg>
  62 Full name of gdb debug script. Default is /tmp/ogdb.
  63 .TP
  64 --group <arg>
  65 The group of devices to cleanup/configure.
  66 .TP
  67 --group_upcall <arg>
  68 Pathname to the MDS upcall to resolve secondary group membership.  Defaults to NONE, meaning that the MDS will use whatever group the client supplies, but this is limited to a single supplementary group.
  69 .TP
  70 -h,--help
  71 Print help.
  72 .TP
  73 --inactive <UUID>
  74 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.
  75 .TP
  76 --lctl-dump <arg>
  77 Dump all ioctls to the specified file
  78 .TP
  79 --ldapurl <arg>
  80 LDAP server URL. Depreciated
  81 .TP
  82 --lustre=src_dir
  83 Specify the base directory for Lustre sources, this parameter will cause lconf to load the lustre modules from this source tree.
  84 .TP
  85 --lustre_upcall <path>
  86 Set the location of the Lustre upcall scripts used by the client for recovery
  87 .TP
  88 --make_service_scripts Create per-service symlinks for use with clumanager HA software
  89 .TP
  90 --mds_ost_conn
  91 Open connections to OSTs on MDS.
  92 .TP
  93 --maxlevel <level>
  94 Perform configuration of devices and services up to level given. When
  95 used in conjunction with cleanup, services are torn down up to a
  96 certain level.
  97 Levels are aproximatly like:
  98 10 - network
  99 20 - device, ldlm
 100 30 - osd, mdd
 101 40 - mds, ost
 102 70 - mountpoint, echo_client, osc, mdc, lov
 103 .TP
 104 --minlevel <level>
 105 Specify the minimum level of services to configure/cleanup. Default is 0.
 106 .TP
 107 --mkfsoptions <options>
 108 Specify additional options for the mk*fs command line.
 109 .TP
 110 --mountfsoptions <options>
 111 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.
 112 .TP
 113 --node node_name
 114 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.
 115 .TP
 116 --noexec,-n
 117 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.
 118 .TP
 119 --nomod
 120 Only setup devices and services, do not load modules.
 121 .TP
 122 --nosetup
 123 Only load modules, do not configure devices or services.
 124 .TP
 125 --old_conf Start up service even though config logs appear outdated.
 126 .TP
 127 --portals <path>
 128 Specify portals source directory. If this is a relative path, then it
 129 is assumed to be relative to lustre. (Depreciated)
 130 .TP
 131 --portals_upcall <path>
 132 Specify the location of the Portals upcall scripts used by the client
 133 for recovery (Depreciated)
 134 .TP
 135 --ptldebug debug-level
 136 This options can be used to set the required debug level.
 137 .TP
 138 --quota
 139 Enable quota support for client filesystem
 140 .TP
 141 --rawprimary <arg>  For clumanager, device of the primary quorum
 142 (default=/dev/raw/raw1)
 143 .TP
 144 --rawsecondary <arg>  For clumanager, device of the secondary quorum (default=/dev/raw/raw2)
 145 .TP
 146 --record
 147 Write config information on mds.
 148 .TP
 149 --record_device <arg>
 150 Specify MDS device name that will record the config commands.
 151 .TP
 152 --record_log <arg>
 153 Specify the name of config record log.
 154 .TP
 155 --recover <arg>
 156 Recover a device.
 157 .TP
 158 --reformat
 159 Reformat all the devices. This is essential on the first time the file system is brought up.
 160 .TP
 161 --select <arg>
 162 Select a particular node for a service
 163 .TP
 164 --service <arg>
 165 Shorthand for --group <arg> --select <arg>=<hostname>
 166 .TP
 167 --service_scripts <arg>  For clumanager, directory containing per-service scripts (default=/etc/lustre/services)
 168 .TP
 169 --single_socket The socknal option. Uses only one socket instead of a
 170 bundle.
 171 .TP
 172 --subsystem <arg>
 173 Set the portals debug subsystem.
 174 .TP
 175 --tgt_uuid <uuid>
 176 Specify the failed target (required for recovery).
 177 .TP
 178 --timeout <arg>
 179 Set the recovery timeout period.
 180 .TP
 181 --upcall <path>
 182 Set the location of both Lustre and Portals upcall scripts used by the
 183 client for recovery
 184 .TP
 185 --user_xattr Enable user_xattr support on MDS
 186 .TP
 187 --verbose,-v
 188 Be verbose and show actions while going along.
 189 .TP
 190 --write_conf
 191 Save all client configuration information on the MDS
 192 .SH EXAMPLES
 193 .TP
 194 .B lconf --node client config.xml
 195 This invokes lconf on the client node.
 196 .TP
 197 .B lconf --ptldebug "~(portals | malloc | trace)"
 198 Used to set the required debug levels (all but these).
 199 .TP
 200 .B lconf --ptldebug "ldlm|ha"
 201 Used to turn-on specific debug types.
 202 .TP
 203 .B lconf --inactive OST_ost1_UUID --inactive OST_ost2_UUID config.xml
 204 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.
 205 .SH BUGS
 206 None are known.