Whamcloud - gitweb
LU-930 doc: fix format man page sections for lctl
[fs/lustre-release.git] / lustre / doc / lctl-nodemap-add-range.8
1 .TH LCTL-NODEMAP_ADD_RANGE 8 "2015-01-20" Lustre "configuration utilities"
2 .SH NAME
3 lctl-nodemap_add_range \- define a range of NIDs for a nodemap
4 .SH SYNOPSIS
5 .br
6 .B lctl nodemap_add_range <--name name> <--range range>
7 .br
8 .SH DESCRIPTION
9 .B nodemap_add_range adds a range of NIDs to an existing nodemap. The NID range
10 cannot overlap with an existing NID range. Clients with NIDs that fall into the
11 new range will be moved into the given nodemap.
12
13 .SH OPTIONS
14 .I name
15 is the name of the nodemap that this range should be added to.
16
17 .I range
18 is the NID range that should be added to the nodemap. The syntax for the range
19 is the same as the rootsquash syntax, with the added constraint that the range
20 must be contiguous.
21
22 .SH Formal LNET Range Definition
23
24 .nf
25 <nidlist>       :== <nidrange> [ ' ' <nidrange> ]
26 <nidrange>      :== <addrrange> '@' <net>
27 <addrrange>     :== '*' |
28                         <ipaddr_range> |
29                         <numaddr_range>
30 <ipaddr_range>  :==
31         <numaddr_range>.<numaddr_range>.<numaddr_range>.<numaddr_range>
32 <numaddr_range> :== <number> |
33                         <expr_list>
34 <expr_list>     :== '[' <range_expr> [ ',' <range_expr>] ']'
35 <range_expr>    :== <number> |
36                         <number> '-' <number> |
37                         <number> '-' <number> '/' <number>
38 <net>           :== <netname> | <netname><number>
39 <netname>       :== "lo" | "tcp" | "o2ib" | "cib" | "openib" | "iib" |
40                         "vib" | "ra" | "elan" | "gm" | "mx" | "ptl"
41 <number>        :== <nonnegative decimal> | <hexadecimal>
42 .fi
43
44 .SH EXAMPLES
45 .nf
46 # lctl nodemap_add_range --name remotesite --range 192.168.1.[1-254]@tcp
47 # lctl nodemap_add_range --name otherremotesite --range 192.168.2.[1-254]@tcp
48 .fi
49
50 .SH AVAILABILITY
51 .B lctl
52 is part of the
53 .BR Lustre (7)
54 filesystem package.
55 .SH SEE ALSO
56 .BR lustre (7),
57 .BR lctl-nodemap-activate (8),
58 .BR lctl-nodemap-add (8),
59 .BR lctl-nodemap-del (8),
60 .BR lctl-nodemap-del-range (8),
61 .BR lctl-nodemap-add-idmap (8),
62 .BR lctl-nodemap-del-idmap (8),
63 .BR lctl-nodemap-modify (8)