usr/src/man/man1m/rcapadm.1m

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH RCAPADM 1M "Mar 5, 2017"
   7 .SH NAME
   8 rcapadm \- configure resource capping daemon
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBrcapadm\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBrcapadm\fR [ [\fB-n\fR] \fB-E\fR | \fB-D\fR]
  18      [\fB-i\fR \fIinterval=value\fR,...,\fIinterval=value\fR] [\fB-c\fR \fIpercent\fR]
  19      [\fB-z\fR \fIzonename\fR \fB-m\fR \fImaxvalue\fR]
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .LP
  24 The \fBrcapadm\fR command allows a user with the privileges described below to
  25 configure various attributes of the resource capping daemon. If used without
  26 arguments, \fBrcapadm\fR displays the current status of the resource capping
  27 daemon if it has been configured. See \fBrcapd\fR(1M) for more information.
  28 .sp
  29 .LP
  30 In the current release of the Solaris operating environment, \fBrcapadm\fR is
  31 available to users with all privileges and to users who have the Process
  32 Management profile in their list of profiles. The System Administrator role
  33 includes the Process Management profile.
  34 .SH OPTIONS
  35 .ne 2
  36 .na
  37 \fB\fB-c\fR \fIpercent\fR\fR
  38 .ad
  39 .sp .6
  40 .RS 4n
  41 Set the minimum physical memory utilization for memory cap enforcement. Caps
  42 will not be enforced until the physical memory available to processes is low.
  43 The \fIpercent\fR value should be in the range 0 to 100. The minimum (and
  44 default) value is \fB0\fR, which means that memory caps are always enforced.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fB-D\fR\fR
  51 .ad
  52 .sp .6
  53 .RS 4n
  54 Disable the resource capping daemon so that it will not be started when the
  55 system is booted. Also stop the resource capping daemon now, if the \fB-n\fR
  56 option is not specified and it is currently running.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fB-E\fR\fR
  63 .ad
  64 .sp .6
  65 .RS 4n
  66 Enable the resource capping daemon so that it will be started each time the
  67 system is booted. Also start the resource capping daemon now, if the \fB-n\fR
  68 option is not specified and it is not currently running.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fB-i\fR \fIinterval=value\fR,...,\fIinterval=value\fR\fR
  75 .ad
  76 .sp .6
  77 .RS 4n
  78 Set intervals for various periodic operations performed by \fBrcapd\fR. All
  79 intervals are specified in seconds. You can set the following intervals:
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBscan\fR\fR
  84 .ad
  85 .RS 10n
  86 The interval at which \fBrcapd\fR scans for new processes. The default scan
  87 interval is every 15 seconds. The minimum value is 1 second.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBsample\fR\fR
  94 .ad
  95 .RS 10n
  96 The interval of process resident set size sampling. The default sample interval
  97 is every 5 seconds. The minimum value is 1 second.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBreport\fR\fR
 104 .ad
 105 .RS 10n
 106 The interval at which various paging statistics are updated by \fBrcapd\fR, in
 107 seconds. These statistics can be viewed by using \fBrcapstat\fR(1). The
 108 default reporting interval is every 5 seconds. When the interval is set to
 109 \fB0\fR, statistics will not be updated.
 110 .LP
 111 Note -
 112 .sp
 113 .RS 2
 114 Paging refers to the act of relocating portions of memory, called pages, to or
 115 from physical memory. \fBrcapd\fR pages out the most infrequently used pages.
 116 .RE
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBconfig\fR\fR
 123 .ad
 124 .RS 10n
 125 The reconfiguration interval, in seconds. At each reconfiguration event,
 126 \fBrcapd\fR checks its configuration file for updates, and scans the project
 127 databases for new project caps. The default reconfiguration interval is every
 128 60 seconds. The minimum interval is \fB0\fR. When the interval is set to
 129 \fB0\fR, no periodic reconfiguration occurs, although the running daemon can
 130 still be reconfigured by sending it \fBSIGHUP\fR.
 131 .RE
 132
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fB-m\fR \fImaxvalue\fR\fR
 139 .ad
 140 .sp .6
 141 .RS 4n
 142 Used in conjunction with the \fB-z\fR option. Specifies a value for
 143 \fBrcap.max-rss\fR, a dynamically-set cap on the usage of physical memory for
 144 the zone specified by \fB-z\fR. You can apply a scale (\fBK\fR, \fBM\fR,
 145 \fBG\fR, \fBT\fR) to the value you specify. \fBK\fR means kilobyte; \fBM\fR,
 146 megabyte; \fBG\fR, gigabyte; and \fBT\fR, terabyte. For example, \fB100M\fR is
 147 100 megabytes.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fB-n\fR\fR
 154 .ad
 155 .sp .6
 156 .RS 4n
 157 Do not affect the running state of the resource capping daemon when enabling or
 158 disabling it.
 159 .RE
 160
 161 .sp
 162 .ne 2
 163 .na
 164 \fB\fB-z\fR \fIzonename\fR\fR
 165 .ad
 166 .sp .6
 167 .RS 4n
 168 Used in conjunction with the \fB-m\fR option. Specifies the zone for which you
 169 are dynamically specifying a cap on physical memory usage (using \fB-m\fR).
 170 .RE
 171
 172 .LP
 173 Note -
 174 .sp
 175 .RS 2
 176 To set a persistent cap on memory usage within a zone, use \fBzonecfg\fR(1M).
 177 .RE
 178 .SH EXAMPLES
 179 .LP
 180 \fBExample 1 \fRConfiguring the Resource Capping Daemon with Immediate
 181 Enforcement
 182 .sp
 183 .LP
 184 #
 185 .BI "rcapadm -E -i scan=" 15 ,sample= 5 ,report= 5 ,config= 60 " -c 0"
 186
 187 .LP
 188 \fBExample 2 \fRSpecifying a Resource Cap for a Zone
 189 .sp
 190 .LP
 191 The command shown below specifies the maximum amount of memory that can be
 192 consumed by a specified zone. Note that this value lasts only until the next
 193 reboot. To set a persistent cap, use \fBzonecfg\fR(1M).
 194
 195 .sp
 196 .in +2
 197 .nf
 198 # \fBrcapadm -z testzone -m 512M\fR
 199 .fi
 200 .in -2
 201 .sp
 202
 203 .SH EXIT STATUS
 204 .LP
 205 The following exit values are returned:
 206 .sp
 207 .ne 2
 208 .na
 209 \fB\fB0\fR\fR
 210 .ad
 211 .RS 5n
 212 Successful completion. The modifications to the current configuration were
 213 valid and made successfully.
 214 .RE
 215
 216 .sp
 217 .ne 2
 218 .na
 219 \fB\fB1\fR\fR
 220 .ad
 221 .RS 5n
 222 An error occurred. A fatal error occurred either in obtaining or modifying the
 223 resource capping configuration.
 224 .RE
 225
 226 .sp
 227 .ne 2
 228 .na
 229 \fB\fB2\fR\fR
 230 .ad
 231 .RS 5n
 232 Invalid command-line options were specified.
 233 .RE
 234
 235 .SH ATTRIBUTES
 236 .LP
 237 See \fBattributes\fR(5) for descriptions of the following attributes:
 238 .sp
 239
 240 .sp
 241 .TS
 242 box;
 243 c | c
 244 l | l .
 245 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 246 _
 247 Interface Stability     Evolving
 248 .TE
 249
 250 .sp
 251 .LP
 252 The \fB-z\fR and \fB-m\fR options are committed interfaces.
 253 .SH SEE ALSO
 254 .LP
 255 \fBrcapstat\fR(1), \fBrcapd\fR(1M), \fBzonecfg\fR(1M), \fBproject\fR(4),
 256 \fBattributes\fR(5), \fBzones\fR(5)
 257 .sp
 258 .LP
 259 "Physical Memory Control Using the Resource Capping Daemon" in \fISystem
 260 Administration Guide: Solaris Containers-Resource Management, and Solaris
 261 Zones\fR