xref: /illumos-gate/usr/src/man/man8/rctladm.8 (revision ddb365bfc9e868ad24ccdcb0dc91af18b10df082)
te
Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
RCTLADM 8 "Jul 2, 2007"
NAME
rctladm - display or modify global state of system resource controls
SYNOPSIS

rctladm [-lu] [-e action] [-d action] [name...]
DESCRIPTION

The rctladm command allows the examination and modification of active resource controls on the running system. An instance of a resource control is referred to as an rctl. See setrctl(2) for a description of an rctl; see resource_controls(7) for a list of the rctls supported in the current release of the Solaris operating system. Logging of rctl violations can be activated or deactivated system-wide and active rctls (and their state) can be listed.

An rctladm command without options is the equivalent of an rctladm with the -l option. See the description of -l below.

OPTIONS

The following options are supported: -d action

-e action

Disable (-d) or enable (-e) the global action on the specified rctls. If no rctl is specified, no action is taken and an error status is returned. You can use the special token all with the disable option to deactivate all global actions on a resource control. You can set the syslog action to a specific degree by assigning a severity level. To do this, specify syslog=level, where level is one of the string tokens given as valid severity levels in syslog(3C). You can omit the common LOG_ prefix on the severity level. Note that not all rctls support the syslog action. See resource_controls(7).

-l

List information about rctls. The name, global event actions and statuses, and global flags are displayed. If one or more name operands are specified, only those rctls matching the names are displayed.

-u

Configure resource controls based on the contents of /etc/rctladm.conf. Any name operands are ignored.

OPERANDS

The following operands are supported: name

The name of the rctl to operate on. Multiple rctl names can be specified. If no names are specified, and the list action has been specified, then all rctls are listed. If the enable or disable action is specified, one or more rctl names must be specified.

EXAMPLES

Example 1 Activating System Logging for Specific Violations

The following command activates system logging of all violations of task.max-lwps.

# rctladm -e syslog task.max-lwps
#

Example 2 Examining the Current Status of a Specific Resource

The following command examines the current status of the task.max-lwps resource.

$ rctladm -l task.max-lwps
task.max-lwps syslog=DEBUG
$
EXIT STATUS

The following exit values are returned: 0

Successful completion.

1

A fatal error occurred. A message is written to standard error to indicate each resource control for which the operation failed. The operation was successful for any other resource controls specified as operands.

2

Invalid command line options were specified.

FILES
/etc/rctladm.conf

Each time rctladm is executed, it updates the contents of rctladm.conf with the current configuration.

SEE ALSO

prctl (1), getrctl (2), setrctl (2), rctlblk_get_global_action (3C), rctlblk_get_global_flags (3C), attributes (7), resource_controls (7)

NOTES

By default, there is no global logging of rctl violations.