Whamcloud - gitweb
LU-8851 nodemap: add uid/gid only flags to control mapping
[fs/lustre-release.git] / lustre / doc / lctl-nodemap-modify.8
1 .TH lctl-nodemap-modify 8 "2015 Jan 20" Lustre "configuration utilities"
2 .SH NAME
3 lctl-nodemap-modify \- Modify a nodemap property.
4
5 .SH SYNOPSIS
6 .br
7 .B lctl nodemap_modify <--name nodemap_name> <--property property_name>
8 <--value value>
9 .br
10 .SH DESCRIPTION
11 .B nodemap_modify
12 modifies a property of the given nodemap.
13
14 .SH OPTIONS
15 .I nodemap_name
16 is the name of the nodemap to modify
17
18
19 .I property_name
20 is one of the following properties:
21 .PP
22 admin
23 .RS 4
24 Defaults to off. If set to on, then root will NOT be squashed. By default,
25 the root user is mapped to the value of squash_uid.
26 .RE
27 .PP
28 trusted
29 .RS 4
30 Defaults to off. If set to on, then user mapping will be disabled for all
31 non-root users. This means that the identities provided by the client will be
32 trusted to match the identities of the file system. By default, the client user
33 identities are mapped to the file system identities based on the nodemap rules.
34 .RE
35 .PP
36 squash_uid
37 .RS 4
38 Defaults to 99. The user ID that unknown users (if not trusted) and root (if not admin) should be mapped to.
39 .RE
40 .PP
41 squash_gid
42 .RS 4
43 Defaults to 99. The group ID that unknown groups (if not trusted) and root (if not admin) should be mapped to.
44 .RE
45 .PP
46 deny_unknown
47 .RS 4
48 Defaults to off. If set to on then unknown (squashed) users will be denied
49 access to the filesystem completely instead of just being squashed. Users are
50 considered unknown by nodemap if the admin flag is off and the user is root, or
51 trusted are set to off and the user is not mapped.
52
53 Note: directory entries cached by a Lustre client may be visible to unknown
54 users located on the same client, though the contents of the files will not be.
55 .RE
56
57 .I value
58 is the value to set for the property. Should be 0 or 1 for admin and trusted.
59
60 .SH EXAMPLES
61 .nf
62 # lctl nodemap_modify --name remotesite --property trusted --value 1
63 # lctl nodemap_modify --name remotesite --property admin --value 1
64 # lctl nodemap_modify --name otherremotesite --property squash_uid --value 101
65 .fi
66
67 .SH AVAILABILITY
68 .B lctl
69 is part of the
70 .BR Lustre (7)
71 filesystem package.
72 .SH SEE ALSO
73 .BR lustre (7),
74 .BR lctl-nodemap-activate (8),
75 .BR lctl-nodemap-add (8),
76 .BR lctl-nodemap-del (8),
77 .BR lctl-nodemap-add-range (8),
78 .BR lctl-nodemap-del-range (8),
79 .BR lctl-nodemap-add-idmap (8),
80 .BR lctl-nodemap-del-idmap (8),