share/man/man8/rctladm.8

   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 RCTLADM 8 "Jul 2, 2007"
   7 .SH NAME
   8 rctladm \- display or modify global state of system resource controls
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBrctladm\fR [\fB-lu\fR] [\fB-e\fR \fIaction\fR] [\fB-d\fR \fIaction\fR] [\fIname\fR...]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBrctladm\fR command allows the examination and modification of active
  19 resource controls on the running system. An instance of a resource control is
  20 referred to as an \fBrctl\fR. See \fBsetrctl\fR(2) for a description of an
  21 \fBrctl\fR; see \fBresource_controls\fR(5) for a list of the \fBrctl\fRs
  22 supported in the current release of the Solaris operating system. Logging of
  23 \fBrctl\fR violations can be activated or deactivated system-wide and active
  24 \fBrctl\fRs (and their state) can be listed.
  25 .sp
  26 .LP
  27 An \fBrctladm\fR command without options is the equivalent of an \fBrctladm\fR
  28 with the \fB-l\fR option. See the description of \fB-l\fR below.
  29 .SH OPTIONS
  30 .sp
  31 .LP
  32 The following options are supported:
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fB-d\fR \fIaction\fR\fR
  37 .ad
  38 .br
  39 .na
  40 \fB\fB-e\fR \fIaction\fR\fR
  41 .ad
  42 .sp .6
  43 .RS 4n
  44 Disable (\fB-d\fR) or enable (\fB-e\fR) the global action on the specified
  45 \fBrctl\fRs. If no \fBrctl\fR is specified, no action is taken and an error
  46 status is returned. You can use the special token \fBall\fR with the disable
  47 option to deactivate all global actions on a resource control.
  48 .sp
  49 You can set the \fBsyslog\fR action to a specific degree by assigning a
  50 severity level. To do this, specify \fBsyslog=\fIlevel\fR\fR, where \fIlevel\fR
  51 is one of the string tokens given as valid severity levels in \fBsyslog\fR(3C).
  52 You can omit the common \fBLOG_\fR prefix on the severity level. Note that not
  53 all \fBrctl\fRs support the \fBsyslog\fR action. See
  54 \fBresource_controls\fR(5).
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fB-l\fR\fR
  61 .ad
  62 .sp .6
  63 .RS 4n
  64 List information about \fBrctl\fRs. The name, global event actions and
  65 statuses, and global flags are displayed. If one or more name operands are
  66 specified, only those \fBrctl\fRs matching the names are displayed.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fB-u\fR\fR
  73 .ad
  74 .sp .6
  75 .RS 4n
  76 Configure resource controls based on the contents of \fB/etc/rctladm.conf\fR.
  77 Any name operands are ignored.
  78 .RE
  79
  80 .SH OPERANDS
  81 .sp
  82 .LP
  83 The following operands are supported:
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fIname\fR\fR
  88 .ad
  89 .sp .6
  90 .RS 4n
  91 The name of the \fBrctl\fR to operate on. Multiple \fBrctl\fR names can be
  92 specified. If no names are specified, and the list action has been specified,
  93 then all \fBrctl\fRs are listed. If the enable or disable action is specified,
  94 one or more \fBrctl\fR names must be specified.
  95 .RE
  96
  97 .SH EXAMPLES
  98 .LP
  99 \fBExample 1 \fRActivating System Logging for Specific Violations
 100 .sp
 101 .LP
 102 The following command activates system logging of all violations of
 103 \fBtask.max-lwps\fR.
 104
 105 .sp
 106 .in +2
 107 .nf
 108 # rctladm -e syslog task.max-lwps
 109 #
 110 .fi
 111 .in -2
 112 .sp
 113
 114 .LP
 115 \fBExample 2 \fRExamining the Current Status of a Specific Resource
 116 .sp
 117 .LP
 118 The following command examines the current status of the \fBtask.max-lwps\fR
 119 resource.
 120
 121 .sp
 122 .in +2
 123 .nf
 124 $ rctladm -l task.max-lwps
 125 task.max-lwps               syslog=DEBUG
 126 $
 127 .fi
 128 .in -2
 129 .sp
 130
 131 .SH EXIT STATUS
 132 .sp
 133 .LP
 134 The following exit values are returned:
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fB0\fR\fR
 139 .ad
 140 .sp .6
 141 .RS 4n
 142 Successful completion.
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fB1\fR\fR
 149 .ad
 150 .sp .6
 151 .RS 4n
 152 A fatal error occurred. A message is written to standard error to indicate each
 153 resource control for which the operation failed. The operation was successful
 154 for any other resource controls specified as operands.
 155 .RE
 156
 157 .sp
 158 .ne 2
 159 .na
 160 \fB\fB2\fR\fR
 161 .ad
 162 .sp .6
 163 .RS 4n
 164 Invalid command line options were specified.
 165 .RE
 166
 167 .SH FILES
 168 .sp
 169 .ne 2
 170 .na
 171 \fB\fB/etc/rctladm.conf\fR\fR
 172 .ad
 173 .sp .6
 174 .RS 4n
 175 Each time \fBrctladm\fR is executed, it updates the contents of
 176 \fBrctladm.conf\fR with the current configuration.
 177 .RE
 178
 179 .SH SEE ALSO
 180 .sp
 181 .LP
 182 \fBsetrctl\fR(2), \fBgetrctl\fR(2), \fBprctl\fR(1),
 183 \fBrctlblk_get_global_flags\fR(3C), \fBrctlblk_get_global_action\fR(3C),
 184 \fBattributes\fR(5), \fBresource_controls\fR(5)
 185 .SH NOTES
 186 .sp
 187 .LP
 188 By default, there is no global logging of \fBrctl\fR violations.