1dea673e9SRodney W. Grimes.\" Copyright (c) 1993 2dea673e9SRodney W. Grimes.\" The Regents of the University of California. All rights reserved. 3dea673e9SRodney W. Grimes.\" 4dea673e9SRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without 5dea673e9SRodney W. Grimes.\" modification, are permitted provided that the following conditions 6dea673e9SRodney W. Grimes.\" are met: 7dea673e9SRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright 8dea673e9SRodney W. Grimes.\" notice, this list of conditions and the following disclaimer. 9dea673e9SRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright 10dea673e9SRodney W. Grimes.\" notice, this list of conditions and the following disclaimer in the 11dea673e9SRodney W. Grimes.\" documentation and/or other materials provided with the distribution. 12*fbbd9655SWarner Losh.\" 3. Neither the name of the University nor the names of its contributors 13dea673e9SRodney W. Grimes.\" may be used to endorse or promote products derived from this software 14dea673e9SRodney W. Grimes.\" without specific prior written permission. 15dea673e9SRodney W. Grimes.\" 16dea673e9SRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17dea673e9SRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18dea673e9SRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19dea673e9SRodney W. Grimes.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20dea673e9SRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21dea673e9SRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22dea673e9SRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23dea673e9SRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24dea673e9SRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25dea673e9SRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26dea673e9SRodney W. Grimes.\" SUCH DAMAGE. 27dea673e9SRodney W. Grimes.\" 288e3847b2SGarrett Wollman.\" From: @(#)sysctl.8 8.1 (Berkeley) 6/6/93 297f3dea24SPeter Wemm.\" $FreeBSD$ 30dea673e9SRodney W. Grimes.\" 318020192dSMarcelo Araujo.Dd December 10, 2015 32dea673e9SRodney W. Grimes.Dt SYSCTL 8 33dea673e9SRodney W. Grimes.Os 34dea673e9SRodney W. Grimes.Sh NAME 35dea673e9SRodney W. Grimes.Nm sysctl 36dea673e9SRodney W. Grimes.Nd get or set kernel state 37dea673e9SRodney W. Grimes.Sh SYNOPSIS 387c7fb079SRuslan Ermilov.Nm 398020192dSMarcelo Araujo.Op Fl bdehiNnoRTtqx 4075820005SJohn-Mark Gurney.Op Fl B Ar bufsize 41da178c77SXin LI.Op Fl f Ar filename 429a2402bcSDag-Erling Smørgrav.Ar name Ns Op = Ns Ar value 439a2402bcSDag-Erling Smørgrav.Ar ... 447c7fb079SRuslan Ermilov.Nm 458020192dSMarcelo Araujo.Op Fl bdehNnoRTtqx 4675820005SJohn-Mark Gurney.Op Fl B Ar bufsize 479a2402bcSDag-Erling Smørgrav.Fl a 48dea673e9SRodney W. Grimes.Sh DESCRIPTION 49dea673e9SRodney W. GrimesThe 50d9b1bc77SPhilippe Charnier.Nm 519a2402bcSDag-Erling Smørgravutility retrieves kernel state and allows processes with appropriate 529a2402bcSDag-Erling Smørgravprivilege to set kernel state. 53def778b8SRuslan ErmilovThe state to be retrieved or set is described using a 54def778b8SRuslan Ermilov.Dq Management Information Base 55def778b8SRuslan Ermilov.Pq Dq MIB 56def778b8SRuslan Ermilovstyle name, described as a dotted set of 579a2402bcSDag-Erling Smørgravcomponents. 581d86b91cSPoul-Henning Kamp.Pp 59d9b1bc77SPhilippe CharnierThe following options are available: 60d9b1bc77SPhilippe Charnier.Bl -tag -width indent 61d9b1bc77SPhilippe Charnier.It Fl A 629a2402bcSDag-Erling SmørgravEquivalent to 63def778b8SRuslan Ermilov.Fl o a 649a2402bcSDag-Erling Smørgrav(for compatibility). 659a2402bcSDag-Erling Smørgrav.It Fl a 669a2402bcSDag-Erling SmørgravList all the currently available non-opaque values. 679a2402bcSDag-Erling SmørgravThis option is ignored if one or more variable names are specified on 689a2402bcSDag-Erling Smørgravthe command line. 69c4da2cc9SDima Dorfman.It Fl b 70c4da2cc9SDima DorfmanForce the value of the variable(s) to be output in raw, binary format. 71c4da2cc9SDima DorfmanNo names are printed and no terminating newlines are output. 72c4da2cc9SDima DorfmanThis is mostly useful with a single variable. 7375820005SJohn-Mark Gurney.It Fl B Ar bufsize 7475820005SJohn-Mark GurneySet the buffer size to read from the 7575820005SJohn-Mark Gurney.Nm 7675820005SJohn-Mark Gurneyto 7775820005SJohn-Mark Gurney.Ar bufsize . 7875820005SJohn-Mark GurneyThis is necessary for a 7975820005SJohn-Mark Gurney.Nm 8075820005SJohn-Mark Gurneythat has variable length, and the probe value of 0 is a valid length, such as 8175820005SJohn-Mark Gurney.Va kern.arandom . 826105f815SLuigi Rizzo.It Fl d 836105f815SLuigi RizzoPrint the description of the variable instead of its value. 84d0b8aabbSAnton Berezin.It Fl e 8528dc1d23SAnton BerezinSeparate the name and the value of the variable(s) with 8628dc1d23SAnton Berezin.Ql = . 87d0b8aabbSAnton BerezinThis is useful for producing output which can be fed back to the 88d0b8aabbSAnton Berezin.Nm 89d0b8aabbSAnton Berezinutility. 90d0b8aabbSAnton BerezinThis option is ignored if either 91d0b8aabbSAnton Berezin.Fl N 92d0b8aabbSAnton Berezinor 93d0b8aabbSAnton Berezin.Fl n 94d0b8aabbSAnton Berezinis specified, or a variable is being set. 95da178c77SXin LI.It Fl f Ar filename 96da178c77SXin LISpecify a file which contains a pair of name and value in each line. 97da178c77SXin LI.Nm 98da178c77SXin LIreads and processes the specified file first and then processes the name 99da178c77SXin LIand value pairs in the command line argument. 10045817aaaSDag-Erling Smørgrav.It Fl h 10145817aaaSDag-Erling SmørgravFormat output for human, rather than machine, readability. 10224b2aa32SGavin Atkinson.It Fl i 10324b2aa32SGavin AtkinsonIgnore unknown OIDs. 10424b2aa32SGavin AtkinsonThe purpose is to make use of 10524b2aa32SGavin Atkinson.Nm 10624b2aa32SGavin Atkinsonfor collecting data from a variety of machines (not all of which 10724b2aa32SGavin Atkinsonare necessarily running exactly the same software) easier. 1080ef56fd8SDag-Erling Smørgrav.It Fl N 1090ef56fd8SDag-Erling SmørgravShow only variable names, not their values. 1109a2402bcSDag-Erling SmørgravThis is particularly useful with shells that offer programmable 1119a2402bcSDag-Erling Smørgravcompletion. 1129a2402bcSDag-Erling SmørgravTo enable completion of variable names in 113f0ea72a0SChristian Brueffer.Xr zsh 1 Pq Pa ports/shells/zsh , 1149a2402bcSDag-Erling Smørgravuse the following code: 115def778b8SRuslan Ermilov.Bd -literal -offset indent 1169a2402bcSDag-Erling Smørgravlistsysctls () { set -A reply $(sysctl -AN ${1%.*}) } 1179a2402bcSDag-Erling Smørgravcompctl -K listsysctls sysctl 1189a2402bcSDag-Erling Smørgrav.Ed 119ec3724d9SHiten Pandya.Pp 120ec3724d9SHiten PandyaTo enable completion of variable names in 121ec3724d9SHiten Pandya.Xr tcsh 1 , 122ec3724d9SHiten Pandyause: 12321414470SRuslan Ermilov.Pp 12421414470SRuslan Ermilov.Dl "complete sysctl 'n/*/`sysctl -Na`/'" 125d9b1bc77SPhilippe Charnier.It Fl n 1269a2402bcSDag-Erling SmørgravShow only variable values, not their names. 1279a2402bcSDag-Erling SmørgravThis option is useful for setting shell variables. 128def778b8SRuslan ErmilovFor instance, to save the pagesize in variable 129def778b8SRuslan Ermilov.Va psize , 130def778b8SRuslan Ermilovuse: 131def778b8SRuslan Ermilov.Pp 132def778b8SRuslan Ermilov.Dl "set psize=`sysctl -n hw.pagesize`" 133c4da2cc9SDima Dorfman.It Fl o 1349a2402bcSDag-Erling SmørgravShow opaque variables (which are normally suppressed). 1359a2402bcSDag-Erling SmørgravThe format and length are printed, as well as a hex dump of the first 1369a2402bcSDag-Erling Smørgravsixteen bytes of the value. 137f93d36fdSRobert Watson.It Fl q 138f93d36fdSRobert WatsonSuppress some warnings generated by 139f93d36fdSRobert Watson.Nm 140f93d36fdSRobert Watsonto standard error. 1419ecd2e32SAlfred Perlstein.It Fl T 14275820005SJohn-Mark GurneyDisplay only variables that are settable via loader (CTLFLAG_TUN). 1438020192dSMarcelo Araujo.It Fl t 1448020192dSMarcelo AraujoPrint the type of the variable. 1459ecd2e32SAlfred Perlstein.It Fl W 146b85e9d27SDevin TeskeDisplay only writable variables that are not statistical. 1479ecd2e32SAlfred PerlsteinUseful for determining the set of runtime tunable sysctls. 1489a2402bcSDag-Erling Smørgrav.It Fl X 1499a2402bcSDag-Erling SmørgravEquivalent to 150def778b8SRuslan Ermilov.Fl x a 1519a2402bcSDag-Erling Smørgrav(for compatibility). 1529a2402bcSDag-Erling Smørgrav.It Fl x 1539a2402bcSDag-Erling SmørgravAs 1549a2402bcSDag-Erling Smørgrav.Fl o , 1559a2402bcSDag-Erling Smørgravbut prints a hex dump of the entire value instead of just the first 1569a2402bcSDag-Erling Smørgravfew bytes. 157d9b1bc77SPhilippe Charnier.El 158dea673e9SRodney W. Grimes.Pp 159dea673e9SRodney W. GrimesThe information available from 160d9b1bc77SPhilippe Charnier.Nm 1615bf6a940SMatthew D Flemingconsists of integers, strings, and opaque types. 162629e80efSPhilippe CharnierThe 163629e80efSPhilippe Charnier.Nm 164629e80efSPhilippe Charnierutility 1651d86b91cSPoul-Henning Kamponly knows about a couple of opaque types, and will resort to hexdumps 1661d86b91cSPoul-Henning Kampfor the rest. 1671d86b91cSPoul-Henning KampThe opaque information is much more useful if retrieved by special 168dea673e9SRodney W. Grimespurpose programs such as 1694f898f94SPhilippe Charnier.Xr ps 1 , 1704f898f94SPhilippe Charnier.Xr systat 1 , 171dea673e9SRodney W. Grimesand 1724f898f94SPhilippe Charnier.Xr netstat 1 . 1731d86b91cSPoul-Henning Kamp.Pp 17443308797SChristian BruefferSome of the variables which cannot be modified during normal system 175ab5e6ef0SChristian Bruefferoperation can be initialized via 176ab5e6ef0SChristian Brueffer.Xr loader 8 177ab5e6ef0SChristian Brueffertunables. 178ab5e6ef0SChristian BruefferThis can for example be done by setting them in 17943308797SChristian Brueffer.Xr loader.conf 5 . 180ab5e6ef0SChristian BruefferPlease refer to 181ab5e6ef0SChristian Brueffer.Xr loader.conf 5 182ab5e6ef0SChristian Bruefferfor more information on which tunables are available and how to set them. 18343308797SChristian Brueffer.Pp 1844a8d0283SMike PritchardThe string and integer information is summarized below. 185dea673e9SRodney W. GrimesFor a detailed description of these variable see 186dea673e9SRodney W. Grimes.Xr sysctl 3 . 1871d86b91cSPoul-Henning Kamp.Pp 188dea673e9SRodney W. GrimesThe changeable column indicates whether a process with appropriate 189dea673e9SRodney W. Grimesprivilege can change the value. 1907e265faeSMatthew D FlemingString and integer values can be set using 19142277d47SDima Dorfman.Nm . 192d0615c64SAndrew R. Reiter.Bl -column security.bsd.unprivileged_read_msgbuf integerxxx 193c2965cd1SJoel Dahl.It Sy "Name Type Changeable" 194c2965cd1SJoel Dahl.It "kern.ostype string no" 195c2965cd1SJoel Dahl.It "kern.osrelease string no" 196c2965cd1SJoel Dahl.It "kern.osrevision integer no" 197c2965cd1SJoel Dahl.It "kern.version string no" 198c2965cd1SJoel Dahl.It "kern.maxvnodes integer yes" 199c2965cd1SJoel Dahl.It "kern.maxproc integer no" 200c2965cd1SJoel Dahl.It "kern.maxprocperuid integer yes" 201c2965cd1SJoel Dahl.It "kern.maxfiles integer yes" 202c2965cd1SJoel Dahl.It "kern.maxfilesperproc integer yes" 203c2965cd1SJoel Dahl.It "kern.argmax integer no" 204c2965cd1SJoel Dahl.It "kern.securelevel integer raise only" 205c2965cd1SJoel Dahl.It "kern.hostname string yes" 206c2965cd1SJoel Dahl.It "kern.hostid integer yes" 207c2965cd1SJoel Dahl.It "kern.clockrate struct no" 208c2965cd1SJoel Dahl.It "kern.posix1version integer no" 209c2965cd1SJoel Dahl.It "kern.ngroups integer no" 210c2965cd1SJoel Dahl.It "kern.job_control integer no" 211c2965cd1SJoel Dahl.It "kern.saved_ids integer no" 212c2965cd1SJoel Dahl.It "kern.boottime struct no" 213c2965cd1SJoel Dahl.It "kern.domainname string yes" 214c2965cd1SJoel Dahl.It "kern.filedelay integer yes" 215c2965cd1SJoel Dahl.It "kern.dirdelay integer yes" 216c2965cd1SJoel Dahl.It "kern.metadelay integer yes" 217c2965cd1SJoel Dahl.It "kern.osreldate string no" 218c2965cd1SJoel Dahl.It "kern.bootfile string yes" 219c2965cd1SJoel Dahl.It "kern.corefile string yes" 220c2965cd1SJoel Dahl.It "kern.logsigexit integer yes" 221c2965cd1SJoel Dahl.It "security.bsd.suser_enabled integer yes" 222c2965cd1SJoel Dahl.It "security.bsd.see_other_uids integer yes" 223c2965cd1SJoel Dahl.It "security.bsd.unprivileged_proc_debug integer yes" 224c2965cd1SJoel Dahl.It "security.bsd.unprivileged_read_msgbuf integer yes" 225c2965cd1SJoel Dahl.It "vm.loadavg struct no" 226c2965cd1SJoel Dahl.It "hw.machine string no" 227c2965cd1SJoel Dahl.It "hw.model string no" 228c2965cd1SJoel Dahl.It "hw.ncpu integer no" 229c2965cd1SJoel Dahl.It "hw.byteorder integer no" 230c2965cd1SJoel Dahl.It "hw.physmem integer no" 231c2965cd1SJoel Dahl.It "hw.usermem integer no" 232c2965cd1SJoel Dahl.It "hw.pagesize integer no" 233c2965cd1SJoel Dahl.It "hw.floatingpoint integer no" 234c2965cd1SJoel Dahl.It "hw.machine_arch string no" 235c2965cd1SJoel Dahl.It "hw.realmem integer no" 236c2965cd1SJoel Dahl.It "machdep.adjkerntz integer yes" 237c2965cd1SJoel Dahl.It "machdep.disable_rtc_set integer yes" 238c2965cd1SJoel Dahl.It "machdep.guessed_bootdev string no" 239c2965cd1SJoel Dahl.It "user.cs_path string no" 240c2965cd1SJoel Dahl.It "user.bc_base_max integer no" 241c2965cd1SJoel Dahl.It "user.bc_dim_max integer no" 242c2965cd1SJoel Dahl.It "user.bc_scale_max integer no" 243c2965cd1SJoel Dahl.It "user.bc_string_max integer no" 244c2965cd1SJoel Dahl.It "user.coll_weights_max integer no" 245c2965cd1SJoel Dahl.It "user.expr_nest_max integer no" 246c2965cd1SJoel Dahl.It "user.line_max integer no" 247c2965cd1SJoel Dahl.It "user.re_dup_max integer no" 248c2965cd1SJoel Dahl.It "user.posix2_version integer no" 249c2965cd1SJoel Dahl.It "user.posix2_c_bind integer no" 250c2965cd1SJoel Dahl.It "user.posix2_c_dev integer no" 251c2965cd1SJoel Dahl.It "user.posix2_char_term integer no" 252c2965cd1SJoel Dahl.It "user.posix2_fort_dev integer no" 253c2965cd1SJoel Dahl.It "user.posix2_fort_run integer no" 254c2965cd1SJoel Dahl.It "user.posix2_localedef integer no" 255c2965cd1SJoel Dahl.It "user.posix2_sw_dev integer no" 256c2965cd1SJoel Dahl.It "user.posix2_upe integer no" 257c2965cd1SJoel Dahl.It "user.stream_max integer no" 258c2965cd1SJoel Dahl.It "user.tzname_max integer no" 259dea673e9SRodney W. Grimes.El 2606087df9eSRuslan Ermilov.Sh FILES 2616087df9eSRuslan Ermilov.Bl -tag -width ".In netinet/icmp_var.h" -compact 2626087df9eSRuslan Ermilov.It In sys/sysctl.h 2636087df9eSRuslan Ermilovdefinitions for top level identifiers, second level kernel and hardware 2646087df9eSRuslan Ermilovidentifiers, and user level identifiers 2656087df9eSRuslan Ermilov.It In sys/socket.h 2666087df9eSRuslan Ermilovdefinitions for second level network identifiers 2676087df9eSRuslan Ermilov.It In sys/gmon.h 2686087df9eSRuslan Ermilovdefinitions for third level profiling identifiers 2696087df9eSRuslan Ermilov.It In vm/vm_param.h 2706087df9eSRuslan Ermilovdefinitions for second level virtual memory identifiers 2716087df9eSRuslan Ermilov.It In netinet/in.h 2726087df9eSRuslan Ermilovdefinitions for third level Internet identifiers and 2736087df9eSRuslan Ermilovfourth level IP identifiers 2746087df9eSRuslan Ermilov.It In netinet/icmp_var.h 2756087df9eSRuslan Ermilovdefinitions for fourth level ICMP identifiers 2766087df9eSRuslan Ermilov.It In netinet/udp_var.h 2776087df9eSRuslan Ermilovdefinitions for fourth level UDP identifiers 2786087df9eSRuslan Ermilov.El 279dea673e9SRodney W. Grimes.Sh EXAMPLES 280dea673e9SRodney W. GrimesFor example, to retrieve the maximum number of processes allowed 281b91e5f67SSteve Pricein the system, one would use the following request: 282def778b8SRuslan Ermilov.Pp 283def778b8SRuslan Ermilov.Dl "sysctl kern.maxproc" 284dea673e9SRodney W. Grimes.Pp 285dea673e9SRodney W. GrimesTo set the maximum number of processes allowed 286b91e5f67SSteve Priceper uid to 1000, one would use the following request: 287def778b8SRuslan Ermilov.Pp 2887e7cdfa0SYaroslav Tykhiy.Dl "sysctl kern.maxprocperuid=1000" 289dea673e9SRodney W. Grimes.Pp 290dea673e9SRodney W. GrimesInformation about the system clock rate may be obtained with: 291def778b8SRuslan Ermilov.Pp 292def778b8SRuslan Ermilov.Dl "sysctl kern.clockrate" 293dea673e9SRodney W. Grimes.Pp 294d9b1bc77SPhilippe CharnierInformation about the load average history may be obtained with: 295def778b8SRuslan Ermilov.Pp 296def778b8SRuslan Ermilov.Dl "sysctl vm.loadavg" 2971d86b91cSPoul-Henning Kamp.Pp 2981d86b91cSPoul-Henning KampMore variables than these exist, and the best and likely only place 2991d86b91cSPoul-Henning Kampto search for their deeper meaning is undoubtedly the source where 3001d86b91cSPoul-Henning Kampthey are defined. 3012a6bc064SYaroslav Tykhiy.Sh COMPATIBILITY 3022a6bc064SYaroslav TykhiyThe 3032a6bc064SYaroslav Tykhiy.Fl w 3042a6bc064SYaroslav Tykhiyoption has been deprecated and is silently ignored. 305dea673e9SRodney W. Grimes.Sh SEE ALSO 30697a00e76SAlexey Zelkin.Xr sysctl 3 , 30743308797SChristian Brueffer.Xr loader.conf 5 , 30843308797SChristian Brueffer.Xr sysctl.conf 5 , 30943308797SChristian Brueffer.Xr loader 8 310dea673e9SRodney W. Grimes.Sh HISTORY 311629e80efSPhilippe CharnierA 312629e80efSPhilippe Charnier.Nm 313629e80efSPhilippe Charnierutility first appeared in 31485cf659aSMike Pritchard.Bx 4.4 . 3151d86b91cSPoul-Henning Kamp.Pp 31685cf659aSMike PritchardIn 317d9b1bc77SPhilippe Charnier.Fx 2.2 , 318d9b1bc77SPhilippe Charnier.Nm 31985cf659aSMike Pritchardwas significantly remodeled. 3206087df9eSRuslan Ermilov.Sh BUGS 3216087df9eSRuslan ErmilovThe 3226087df9eSRuslan Ermilov.Nm 3236087df9eSRuslan Ermilovutility presently exploits an undocumented interface to the kernel 3246087df9eSRuslan Ermilovsysctl facility to traverse the sysctl tree and to retrieve format 3256087df9eSRuslan Ermilovand name information. 3266087df9eSRuslan ErmilovThis correct interface is being thought about for the time being. 327