lustre/doc/lctl-nodemap-modify.8

   1 .TH LCTL-NODEMAP_MODIFY 8 "2019-01-22" Lustre "configuration utilities"
   2 .SH NAME
   3 lctl-nodemap_modify \- modify a nodemap property
   4 .SH SYNOPSIS
   5 .br
   6 .B lctl nodemap_modify <--name nodemap_name> <--property property_name>
   7 <--value value>
   8 .br
   9 .SH DESCRIPTION
  10 .B nodemap_modify
  11 modifies a property of the given nodemap.
  12
  13 .SH OPTIONS
  14 .I nodemap_name
  15 is the name of the nodemap to modify
  16
  17 .I property_name
  18 is one of the following properties:
  19 .RS 0.3i
  20 .PP
  21 admin
  22 .RS 4
  23 Defaults to off. If set to on, then root will NOT be squashed. By default,
  24 the root user is mapped to the value of squash_uid.
  25 .RE
  26 .PP
  27 trusted
  28 .RS 4
  29 Defaults to off. If set to on, then user mapping will be disabled for all
  30 non-root users. This means that the identities provided by the client will be
  31 trusted to match the identities of the file system. By default, the client user
  32 identities are mapped to the file system identities based on the nodemap rules.
  33 .RE
  34 .PP
  35 squash_uid
  36 .RS 4
  37 Defaults to 99. The user ID that unknown users (if not trusted) and root (if not admin) should be mapped to.
  38 .RE
  39 .PP
  40 squash_gid
  41 .RS 4
  42 Defaults to 99. The group ID that unknown groups (if not trusted) and root (if not admin) should be mapped to.
  43 .RE
  44 .PP
  45 squash_projid
  46 .RS 4
  47 Defaults to 99. The project ID that unknown projects (if not trusted) should be mapped to.
  48 .RE
  49 .PP
  50 deny_unknown
  51 .RS 4
  52 Defaults to off. If set to on then unknown (squashed) users will be denied
  53 access to the filesystem completely instead of just being squashed. Users are
  54 considered unknown by nodemap if the admin flag is off and the user is root, or
  55 trusted are set to off and the user is not mapped.
  56
  57 Note: directory entries cached by a Lustre client may be visible to unknown
  58 users located on the same client, though the contents of the files will not be.
  59 .RE
  60 .PP
  61 audit_mode
  62 .RS 4
  63 Defaults to on, which lets clients record file system access events to the
  64 Changelogs, if Changelogs are otherwise activated. If set to 0, events from
  65 these clients are not logged into the Changelogs, no matter if Changelogs are
  66 activated or not.
  67 The reason not to record file system events from given clients is to prevent
  68 some nodes (e.g. backup, HSM agent nodes) from flooding the Changelogs.
  69 .RE
  70 .PP
  71 map_mode
  72 .RS 4
  73 Defaults to all, which means the nodemap maps UIDs, GIDs, and PROJIDs.
  74 Other possible values (multiple can be specified, comma separated) are uid to
  75 map UIDs, gid to map GIDs, both to map UIDs and GIDs, and projid to map PROJIDs.
  76 .RE
  77
  78 .RE
  79 .I value
  80 is the value to set for the property. Should be 0 or 1 for admin and trusted.
  81
  82 .SH EXAMPLES
  83 .nf
  84 # lctl nodemap_modify --name remotesite --property trusted --value 1
  85 # lctl nodemap_modify --name remotesite --property admin --value 1
  86 # lctl nodemap_modify --name remotesite --property map_mode --value uid_only
  87 # lctl nodemap_modify --name otherremotesite --property squash_uid --value 101
  88 .fi
  89
  90 .SH AVAILABILITY
  91 .B lctl
  92 is part of the
  93 .BR Lustre (7)
  94 filesystem package.
  95 .SH SEE ALSO
  96 .BR lustre (7),
  97 .BR lctl-nodemap-activate (8),
  98 .BR lctl-nodemap-add (8),
  99 .BR lctl-nodemap-del (8),
 100 .BR lctl-nodemap-add-range (8),
 101 .BR lctl-nodemap-del-range (8),
 102 .BR lctl-nodemap-add-idmap (8),
 103 .BR lctl-nodemap-del-idmap (8),