rcapadm - man pages section 1M: System Administration Commands

Language:

rcapadm(1M)

Name

rcapadm - configure resource capping daemon

Synopsis

rcapadm

rcapadm [ [-n] -E | -D] 
     [-i {sample|mode}=value]....
     [-z zonename -m maxvalue]

Description

The rcapadm command allows a user with the privileges described below to configure various attributes of the resource capping daemon. If used without arguments, rcapadm displays the current status of the resource capping daemon. See rcapd(1M) for more information.

In the current release of the Solaris operating environment, rcapadm is available to users with all privileges and to users who have the Process Management profile in their list of profiles. The System Administrator role includes the Process Management profile.

Options

–D

Disable the resource capping daemon so that it will not be started when the system is booted. Also stop the resource capping daemon now, if the –n option is not specified and it is currently running.

–E

Enable the resource capping daemon so that it will be started each time the system is booted. Also start the resource capping daemon now, if the –n option is not specified and it is not currently running.

–i {sample|mode}=value,....

Set configuration for rcapd operations. Two parameters that are used by rcapd can be set by using this option.

sample

The interval of sampling resident set size for collections. The default sample interval is 30 seconds. The minimum value is 5 seconds.

mode

Set the mode of operation for rcapd. You can either set the mode for rcapd to just log the results of the scan or enforce the rss caps by paging out resident pages.

The following values are allowed by mode:

log-only: Do not enforce caps. Log the rss cap and usage statistics for all capped collections.
pageout: Pageout resident pages for processes of collections that are above their rss caps. This is the default mode for rcapd(1M).

–m maxvalue

Used in conjunction with the –z option. Specifies a value for rcap.max-rss, a dynamically-set cap on the usage of physical memory for the zone specified by –z. You can apply a scale (K, M, G, T) to the value you specify. K means kilobyte; M, megabyte; G, gigabyte; and T, terabyte. For example, 100M is 100 megabytes.

To remove an existing cap, specify 0M.

–n

Do not affect the running state of the resource capping daemon when enabling or disabling it.

–z zonename

Used in conjunction with the –m option. Specifies the zone for which you are dynamically specifying a cap on physical memory usage (using –m).

Note - To set a persistent cap on memory usage within a zone, use zonecfg(1M).

Examples

Example 1 Configuring the Resource Capping Daemon with Memory Cap Enforcement With a 5 Second RSS Sampling Interval

# rcapadm -E -i sample=5,mode=pageout

Example 2 Configuring the Resource Capping Daemon With Log Mode and a 60 Second RSS Sampling Interval

# rcapadm -E -i sample=60,mode=log-only

Example 3 Specifying a Resource Cap for a Zone

The command shown below specifies the maximum amount of memory that can be consumed by a specified zone. Note that this value lasts only until the next reboot. To set a persistent cap, use zonecfg(1M).

# rcapadm -z testzone -m 512M

Exit Status

The following exit values are returned:

0: Successful completion. The modifications to the current configuration were valid and made successfully.
1: An error occurred. A fatal error occurred either in obtaining or modifying the resource capping configuration.
2: Invalid command-line options were specified.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	system/resource-mgmt/resource-caps
Interface Stability	Committed

The –z and –m options are committed interfaces.

man pages section 1M: System Administration Commands