zfsadm help

Purpose

Shows syntax of specified zfsadm commands or lists functional descriptions of all zfsadm commands.

Format

zfsadm help [-topic command...] [-level] [-help]

Options

-help: Prints the online help for this command. All other valid options that are specified with this option are ignored.
-level: Prints the level of the zfsadm command. This is useful when you are diagnosing a problem. Except for -help, all other valid options that are specified with -level are ignored.
-topic command: Specifies each command whose syntax is to be displayed. Provide only the second part of the command name (for example, lsfs, not zfsadm lsfs). Multiple topic strings can be specified. If this option is omitted, the output provides a short description of all zfsadm commands.

Usage

The zfsadm help command displays the first line (name and short description) of the online help entry for every zfsadm command if -topic is not provided. For each command name specified with -topic, the output lists the entire help entry.

The online help entry for each zfsadm command consists of the following two lines:

The first line names the command and briefly describes its function.
The second line, which begins with Usage:, lists the command options in the prescribed order.

Use the zfsadm apropos command to show each help entry containing a specified string.

Privilege required

If you are using an IOEFSPRM file in your zFS PROC, the issuer must have READ authority to the data set that contains the IOEFSPRM file. If you are using parmlib (IOEPRMxx), the issuer does not need special authorization.

Examples

The following command displays the online help entry for the zfsadm lsfs command and the zfsadm lsaggr command:

zfsadm help -topic lsfs lsaggr  

zfsadm lsfs: list filesystem information
Usage: zfsadm lsfs [-aggregate <aggregate name>] [{-fast | -long}] [-level] [-help]
zfsadm lsaggr: list aggregates
Usage: zfsadm lsaggr [-level] [-help]

Related information

Command:

zfsadm apropos