1rcapadm(1M) System Administration Commands rcapadm(1M)
2
3
4
6 rcapadm - configure resource capping daemon
7
9 rcapadm
10
11
12 rcapadm [ [-n] -E | -D]
13 [-i interval=value,...,interval=value] [-c percent]
14 [-z zonename -m maxvalue]
15
16
18 The rcapadm command allows a user with the privileges described below
19 to configure various attributes of the resource capping daemon. If used
20 without arguments, rcapadm displays the current status of the resource
21 capping daemon if it has been configured. See rcapd(1M) for more infor‐
22 mation.
23
24
25 In the current release of the Solaris operating environment, rcapadm is
26 available to users with all privileges and to users who have the
27 Process Management profile in their list of profiles. The System Admin‐
28 istrator role includes the Process Management profile.
29
31 -c percent
32
33 Set the minimum physical memory utilization for memory cap enforce‐
34 ment. Caps will not be enforced until the physical memory available
35 to processes is low. The percent value should be in the range 0 to
36 100. The minimum (and default) value is 0, which means that memory
37 caps are always enforced.
38
39
40 -D
41
42 Disable the resource capping daemon so that it will not be started
43 when the system is booted. Also stop the resource capping daemon
44 now, if the -n option is not specified and it is currently running.
45
46
47 -E
48
49 Enable the resource capping daemon so that it will be started each
50 time the system is booted. Also start the resource capping daemon
51 now, if the -n option is not specified and it is not currently run‐
52 ning.
53
54
55 -i interval=value,...,interval=value
56
57 Set intervals for various periodic operations performed by rcapd.
58 All intervals are specified in seconds. You can set the following
59 intervals:
60
61 scan The interval at which rcapd scans for new processes. The
62 default scan interval is every 15 seconds. The minimum
63 value is 1 second.
64
65
66 sample The interval of process resident set size sampling. The
67 default sample interval is every 5 seconds. The minimum
68 value is 1 second.
69
70
71 report The interval at which various paging statistics are
72 updated by rcapd, in seconds. These statistics can be
73 viewed by using rcapstat(1SRM). The default reporting
74 interval is every 5 seconds. When the interval is set to
75 0, statistics will not be updated.
76
77 Note -
78
79 Paging refers to the act of relocating portions of mem‐
80 ory, called pages, to or from physical memory. rcapd
81 pages out the most infrequently used pages.
82
83
84 config The reconfiguration interval, in seconds. At each recon‐
85 figuration event, rcapd checks its configuration file for
86 updates, and scans the project databases for new project
87 caps. The default reconfiguration interval is every 60
88 seconds. The minimum interval is 0. When the interval is
89 set to 0, no periodic reconfiguration occurs, although
90 the running daemon can still be reconfigured by sending
91 it SIGHUP.
92
93
94
95 -m maxvalue
96
97 Used in conjunction with the -z option. Specifies a value for
98 rcap.max-rss, a dynamically-set cap on the usage of physical memory
99 for the zone specified by -z. You can apply a scale (K, M, G, T) to
100 the value you specify. K means kilobyte; M, megabyte; G, gigabyte;
101 and T, terabyte. For example, 100M is 100 megabytes.
102
103
104 -n
105
106 Do not affect the running state of the resource capping daemon when
107 enabling or disabling it.
108
109
110 -z zonename
111
112 Used in conjunction with the -m option. Specifies the zone for
113 which you are dynamically specifying a cap on physical memory usage
114 (using -m).
115
116
117 Note -
118
119 To set a persistent cap on memory usage within a zone, use
120 zonecfg(1M).
121
123 Example 1 Configuring the Resource Capping Daemon with Immediate
124 Enforcement
125
126
127 # rcapadm -E -i scan=15,sample=5,report=5,config=60 -c 0
128
129
130 Example 2 Specifying a Resource Cap for a Zone
131
132
133 The command shown below specifies the maximum amount of memory that can
134 be consumed by a specified zone. Note that this value lasts only until
135 the next reboot. To set a persistent cap, use zonecfg(1M).
136
137
138 # rcapadm -z testzone -m 512M
139
140
141
143 The following exit values are returned:
144
145 0 Successful completion. The modifications to the current configura‐
146 tion were valid and made successfully.
147
148
149 1 An error occurred. A fatal error occurred either in obtaining or
150 modifying the resource capping configuration.
151
152
153 2 Invalid command-line options were specified.
154
155
157 See attributes(5) for descriptions of the following attributes:
158
159
160
161
162 ┌─────────────────────────────┬─────────────────────────────┐
163 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
164 ├─────────────────────────────┼─────────────────────────────┤
165 │Availability │SUNWrcapu │
166 ├─────────────────────────────┼─────────────────────────────┤
167 │Interface Stability │Evolving │
168 └─────────────────────────────┴─────────────────────────────┘
169
170
171 The -z and -m options are committed interfaces.
172
174 rcapstat(1), rcapd(1M), zonecfg(1M), project(4), attributes(5),
175 zones(5)
176
177
178 "Physical Memory Control Using the Resource Capping Daemon" in System
179 Administration Guide: Solaris Containers-Resource Management, and
180 Solaris Zones
181
182
183
184SunOS 5.11 18 Dec 2006 rcapadm(1M)