Whamcloud - gitweb
LU-4315 doc: add separate lctl-list_param man page
[fs/lustre-release.git] / lustre / doc / lfs-getname.1
1 .TH LFS-GETSOM 1 2018-10-04 "Lustre" "lustre Utilities"
2 .SH NAME
3 lfs getname \- retrieve the filesystem name and instance ID
4 .SH SYNOPSIS
5 .B lfs getname
6 .RB [ --help | -h "] [" --instance | -i "] [" --fsname | -n ]
7 .RI [ pathname ...]
8 .SH DESCRIPTION
9 Print the filesystem name, instance ID, and mountpoint for all
10 Lustre mount points on the local client. If one or more
11 .I pathname
12 arguments are provided, then only print the Lustre filesystem name
13 and instance ID for these mount points.
14 .SH OPTIONS
15 .TP
16 .BR --help | -h
17 Print the usage message.
18 .TP
19 .BR --fsname | -n
20 Print only the Lustre filesystem name for each filesystem.  If
21 .B -n
22 is used with a single
23 .I pathname
24 then the filesystem name is printed without the mountpoint.
25 .TP
26 .BR --instance | -i
27 Only show the mount instance ID for each filesystem.  If
28 .B -i
29 is used with a single
30 .I pathname
31 then the instance ID is printed without the mountpoint.
32 .SH EXAMPLES
33 .TP
34 .B $ lfs getname
35 myth-ffff880428703400 /myth
36 .br
37 testfs-ffff937009271000 /mnt/testfs
38 .TP
39 .B $ lfs getname -n /mnt/testfs
40 testfs
41 .SH SEE ALSO
42 .BR lfs (1),
43 .BR lustre (7)