Das LPAR-Tool bietet einen sehr umfangreichen Satz an Funktionalitäten. Alle Kommandos, und Optionen sind in der Online-Hilfe ausführlich dokumentiert und zusätzlich in Form von einigen Beispielen gezeigt. Im Folgenden soll die Benutzung der Online-Hilfe gezeigt werden. Unser Ziel bei der Entwicklung der Online-Hilfe war es, das der Benutzer nach Möglichkeit alle benötigten Informationen direkt auf der Kommandozeile anzeigen lassen kann.

Den Subkommandos der LPAR-Tool Kommandos hmc, ms, lpar und vios sind Kategorien zugeordnet, wie z.B. processor, memory, fc, oder lpm (und einige weitere). Welche Kategorien ein Kommando kennt und unterstützt, kann man mit dem Schlüsselwort „help“ anzeigen lassen. Wir haben im folgenden als Beispiel das Kommando lpar verwendet, die anderen drei Kommandos unterstützen aber genau die gleich Art an Online-Hilfe.

Führen Sie das Kommando „lpar help“ aus:

$ lpar help
Help is available for the following categories:

   lpar help blueprint eth fc io led lic lpm
   lpar help mem memory npiv pgdev power proc processor
   lpar help prof profile scsi serial sriov vnic vnicbkdev

Specific help is available for each of the supported keywords:

   lpar help <keyword>

For a complete list of all keywords try:

   lpar help usage
$

Im oberen Teil der Ausgabe sind die verfügbaren Kategorien aufgelistet. Jede dieser Kategorien kann dem Kommando „lpar help“ als Argument mitgegeben werden. Möchten Sie z.B. irgendeine Aktion auf einer LPAR durchführen, die etwas mit FibreChannel (FC) zu tun hat, haben aber das entsprechende Subkommando vergessen? Dann können Sie sich einfach alle Subkommandos der Kategorie fc anzeigen lassen.

Probieren Sie es aus:

$ lpar help fc
USAGE: lpar [<option> ...] <keyword> [<option> ...] [<argument> ...]

Recognized keywords for topic 'fc' are:
   [-h <hmc>] [-m <ms>] [-p <profile>] addfc [-c] [-d] [-f] [-l <detail_level>] [-w <wait_time>] [-v] <lpar> [<slot>] <remote_lpar_name> [<remote_slot_num>] [<wwpns>] [<fcsX>]
   [-h <hmc>] [-m <ms>] [-p <profile>] chfc [-r] [-R] [-v] <lpar> <slot> [<attributes> ...]
   [-h <hmc>] [-m <ms>] [-p <profile>] lsfc [{-o <format>|-f|-j|-y}] [-F <fields>] [-s <selections>] [-v] [<lpar> ...]
   [-h <hmc>] [-m <ms>] lsnpiv [{-o <format>|-f|-j|-y}] [-F <fields>] [-s <selections>] [-v] <lpar>
   [-h <hmc>] [-m <ms>] [-p <profile>] lsvslot [{-o <format>|-f|-j|-y}] [-t <type>] [-F <fields>] [-s <selections>] [-v] <lpar>
   [-h <hmc>] [-m <ms>] [-p <profile>] rmfc [-c] [-d] [-f] [-l <detail_level>] [-w <wait_time>] [-v] <lpar> <slot>
$

Es werden alle Subkommandos (Schlüsselwörter) angezeigt, die etwas mit dem Thema FC zu tun haben. Nehmen wir an, Sie wollten sich die virtuellen FC-Adapter einer LPAR anzeigen lassen und haben anhand der Ausgabe erkannt, das das Subkommando lsfc das gesuchte Subkommando ist. Sie sind aber noch nicht so schlüssig wie die genaue Kommandozeile aussehen muss, bzw. welche Argumente Sie in welcher Reihenfolge mit welchen Optionen angeben müssen. Für diesen Fall empfiehlt es sich die Online-Hilfe noch ein weiteres Mal in Anspruch zu nehmen und dieses Mal das Schlüsselwort lsfc bei „lpar help“ anzugeben.

Machen Sie das bitte, starten Sie „lpar help lsfc“:

$ lpar help lsfc
USAGE:
   lpar [-h <hmc>] [-m <ms>] [-p <profile>] lsfc [{-o <format>|-f|-j|-y}] [-F <fields>] [-s <selections>] [-v] [<lpar> ...]

DESCRIPTION:

Show virtual FC adapters for the specified LPARs.

   -f : short form for '-o stanza'
   -F : show selected fields only
   -j : short form for '-o json'
   -o : use the specified output format
      json - output in JSON format
      stanza - output in stanza format
      yaml - output in YAML format
   -p : profile name
   -s|-S : select or select not specific records
   -y : short form for '-o yaml'

EXAMPLE:

Show virtual FC adapters for all LPARs:
   lpar lsfc

Show virtual FC adapters in JSON format for all LPARs connected to
HMC hmc02:
   lpar -h hmc02 lsfc -o json
   lpar -h hmc02 lsfc -j

Show virtual FC adapters for LPAR aix02 from profile 'standard':
   lpar -p standard lsfc aix02
$

Es wird die genaue Benutzung (Usage) gezeigt, die auch schon beim Auflisten der Subkommandos der Kategorie fc zu sehen war. Es wird eine kurze Beschreibung angezeigt, die erklärt was das Subkommando macht. Zusätzlich sind nun alle Optionen aufgelistet, mit einer kurzen Beschreibung. An Ende der Ausgabe sind einige konkrete Beispiele gezeigt, wie man das Kommando benutzen kann.

Der Vorteil dieser relativ detaillierten Online-Hilfe besteht darin, das diese sofort auf der Kommandozeile verfügbar ist. Sie müssen in den meisten Fällen nicht erst in einem externen Dokument (PDF, Webseite) nachschauen. Hat man das LPAR-Tool eine Weile benutzt, wird man in aller Regel immer seltener auf die Online-Hilfe zurückgreifen.

Aber auch für den Experten kann die Online-Hilfe sehr nützlich sein, wenn man einen Attribut-Namen vergessen hat, oder sich nicht mehr an die möglichen erlaubten Werte eines Attributes erinnert. Ein Blick in die Online-Hilfe liefert dann fast immer die gesuchte Information.