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

   1 '\" te
   2 .\" Copyright (c) 2004, 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 INETADM 1M "Jul 5, 2007"
   7 .SH NAME
   8 inetadm \- observe or configure inetd-controlled services
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBinetadm\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBinetadm\fR \fB-?\fR
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBinetadm\fR \fB-p\fR
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBinetadm\fR \fB-l\fR {\fIFMRI\fR | \fIpattern\fR}
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBinetadm\fR \fB-e\fR {\fIFMRI\fR | \fIpattern\fR}
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBinetadm\fR \fB-d\fR {\fIFMRI\fR | \fIpattern\fR}
  38 .fi
  39
  40 .LP
  41 .nf
  42 \fBinetadm\fR \fB-m\fR {\fIFMRI\fR | \fIpattern\fR}... {\fIname\fR=\fIvalue\fR}...
  43 .fi
  44
  45 .LP
  46 .nf
  47 \fBinetadm\fR \fB-M\fR {\fIname\fR=\fIvalue\fR}...
  48 .fi
  49
  50 .SH DESCRIPTION
  51 .sp
  52 .LP
  53 The \fBinetadm\fR utility provides the following capabilities for
  54 \fBinetd\fR-managed SMF services:
  55 .RS +4
  56 .TP
  57 .ie t \(bu
  58 .el o
  59 Provides a list of all such services installed.
  60 .RE
  61 .RS +4
  62 .TP
  63 .ie t \(bu
  64 .el o
  65 Lists the services' properties and values.
  66 .RE
  67 .RS +4
  68 .TP
  69 .ie t \(bu
  70 .el o
  71 Allows enabling and disabling of services.
  72 .RE
  73 .RS +4
  74 .TP
  75 .ie t \(bu
  76 .el o
  77 Allows modification of the services'property values, as well as the default
  78 values provided by \fBinetd\fR.
  79 .RE
  80 .sp
  81 .LP
  82 See \fBsmf\fR(5) for a description of an SMF service.
  83 .sp
  84 .LP
  85 With no arguments, \fBinetadm\fR lists all services under \fBinetd\fR(1M)
  86 control, including such attributes as their current run state and whether or
  87 not they are enabled.
  88 .SH OPTIONS
  89 .sp
  90 .LP
  91 For options taking one or more FMRI operands (see \fBsmf\fR(5) for a
  92 description of an FMRI), if the operand specifies a service (instead of a
  93 service instance), and that service has only a single instance, \fBinetadm\fR
  94 operates on that instance.
  95 .sp
  96 .LP
  97 If a service name is supplied and it contains more than one instances or a
  98 pattern is supplied and and it matches more than one instance, a warning
  99 message is displayed and that operand is ignored.
 100 .sp
 101 .LP
 102 For those options taking \fIname\fR=\fIvalue\fR parameters, a description of
 103 each of the possible names and the allowed values is found in the
 104 \fBinetd\fR(1M) man page.
 105 .sp
 106 .LP
 107 The following options are supported:
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fB-?\fR\fR
 112 .ad
 113 .sp .6
 114 .RS 4n
 115 Display a usage message.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fB-p\fR\fR
 122 .ad
 123 .sp .6
 124 .RS 4n
 125 Lists all default \fBinet\fR service property values provided by \fBinetd\fR in
 126 the form of \fIname\fR=\fIvalue\fR pairs. If the value is of boolean type, it
 127 is listed as TRUE or FALSE.
 128 .RE
 129
 130 .sp
 131 .ne 2
 132 .na
 133 \fB\fB-l\fR {\fIFMRI\fR | \fIpattern\fR}...\fR
 134 .ad
 135 .sp .6
 136 .RS 4n
 137 List all properties for the specified service instances as
 138 \fIname\fR=\fIvalue\fR pairs. In addition, if the property value is inherited
 139 from the default value provided by \fBinetd\fR, the \fIname\fR=\fIvalue\fR pair
 140 is identified by the token (default). Property inheritance occurs when
 141 properties do not have a specified service instance default.
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fB-e\fR {\fIFMRI\fR | \fIpattern\fR}...\fR
 148 .ad
 149 .sp .6
 150 .RS 4n
 151 Enable the specified service instances.
 152 .RE
 153
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fB-d\fR {\fIFMRI\fR | \fIpattern\fR}...\fR
 158 .ad
 159 .sp .6
 160 .RS 4n
 161 Disable the specified service instances.
 162 .RE
 163
 164 .sp
 165 .ne 2
 166 .na
 167 \fB\fB-m\fR {\fIFMRI\fR | \fIpattern\fR}...{\fIname\fR=\fIvalue\fR}...\fR
 168 .ad
 169 .sp .6
 170 .RS 4n
 171 Change the values of the specified properties of the identified service
 172 instances. Properties are specified as whitespace-separated
 173 \fIname\fR=\fIvalue\fR pairs. To remove an instance-specific value and accept
 174 the default value for a property, simply specify the property without a value,
 175 for example, \fBname=\fR .
 176 .RE
 177
 178 .sp
 179 .ne 2
 180 .na
 181 \fB\fB-M\fR {\fIname\fR=\fIvalue\fR}...\fR
 182 .ad
 183 .sp .6
 184 .RS 4n
 185 Change the values of the specified \fBinetd\fR default properties. Properties
 186 are specified as whitespace-separated \fIname\fR=\fIvalue\fR pairs.
 187 .RE
 188
 189 .SH EXAMPLES
 190 .LP
 191 \fBExample 1 \fRDisplaying Properties for a Service
 192 .sp
 193 .LP
 194 The following command displays the properties for the \fBspray\fR service.
 195
 196 .sp
 197 .in +2
 198 .nf
 199 # inetadm -l network/rpc/spray:default
 200 SCOPE    NAME=VALUE
 201          name="sprayd"
 202          endpoint_type="tli"
 203          proto="datagram_v"
 204          isrpc=TRUE
 205          rpc_low_version=1
 206          rpc_high_version=1
 207          wait=TRUE
 208          exec="/usr/lib/netsvc/spray/rpc.sprayd"
 209          user="root"
 210 default  bind_addr=""
 211 default  bind_fail_max=-1
 212 default  bind_fail_interval=-1
 213 default  max_con_rate=-1
 214 default  max_copies=-1
 215 default  con_rate_offline=-1
 216 default  failrate_cnt=40
 217 default  failrate_interval=60
 218 default  inherit_env=TRUE
 219 default  tcp_trace=FALSE
 220 default  tcp_wrappers=FALSE
 221 default  connection_backlog=10
 222 .fi
 223 .in -2
 224
 225 .LP
 226 \fBExample 2 \fRDisplaying Default Properties
 227 .sp
 228 .LP
 229 The following command displays default properties.
 230
 231 .sp
 232 .in +2
 233 .nf
 234 # inetadm -p
 235 NAME=VALUE
 236 bind_addr=""
 237 bind_fail_max=-1
 238 bind_fail_interval=-1
 239 max_con_rate=-1
 240 max_copies=-1
 241 con_rate_offline=-1
 242 failrate_cnt=40
 243 failrate_interval=60
 244 inherit_env=TRUE
 245 tcp_trace=FALSE
 246 tcp_wrappers=FALSE
 247 default  connection_backlog=10
 248 .fi
 249 .in -2
 250
 251 .LP
 252 \fBExample 3 \fRChanging Property Values for a Service
 253 .sp
 254 .LP
 255 The following command changes \fBrpc_high_version\fR to \fB3\fR and
 256 \fBtcp_trace\fR to \fBTRUE\fR for the \fBspray\fR service.
 257
 258 .sp
 259 .in +2
 260 .nf
 261 # inetadm -m network/rpc/spray:default \e
 262          rpc_high_version=3 tcp_trace=TRUE
 263 # inetadm -l network/rpc/spray:default
 264 SCOPE    NAME=VALUE
 265          name="sprayd"
 266          endpoint_type="tli"
 267          proto="datagram_v"
 268          isrpc=TRUE
 269          rpc_low_version=1
 270          rpc_high_version=3
 271          wait=TRUE
 272          exec="/usr/lib/netsvc/spray/rpc.sprayd"
 273          user="root"
 274 default  bind_addr=""
 275 default  bind_fail_max=-1
 276 default  bind_fail_interval=-1
 277 default  max_con_rate=-1
 278 default  max_copies=-1
 279 default  con_rate_offline=-1
 280 default  failrate_cnt=40
 281 default  failrate_interval=60
 282 default  inherit_env=TRUE
 283          tcp_trace=TRUE
 284 default  tcp_wrappers=FALSE
 285 default  connection_backlog=10
 286 .fi
 287 .in -2
 288
 289 .SH EXIT STATUS
 290 .sp
 291 .LP
 292 The following exit values are returned:
 293 .sp
 294 .ne 2
 295 .na
 296 \fB\fB0\fR\fR
 297 .ad
 298 .RS 5n
 299 Operation completed successfully.
 300 .RE
 301
 302 .sp
 303 .ne 2
 304 .na
 305 \fB\fB1\fR\fR
 306 .ad
 307 .RS 5n
 308 A fatal error occurred. An accompanying error message will provide further
 309 information.
 310 .RE
 311
 312 .sp
 313 .ne 2
 314 .na
 315 \fB\fB2\fR\fR
 316 .ad
 317 .RS 5n
 318 Invalid arguments were supplied, such as an ambiguous service FMRI or pattern.
 319 .RE
 320
 321 .SH ATTRIBUTES
 322 .sp
 323 .LP
 324 See \fBattributes\fR(5) for descriptions of the following attributes:
 325 .sp
 326
 327 .sp
 328 .TS
 329 box;
 330 c | c
 331 l | l .
 332 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 333 _
 334 Interface Stability     Evolving
 335 .TE
 336
 337 .SH SEE ALSO
 338 .sp
 339 .LP
 340 \fBinetd\fR(1M), \fBsvccfg\fR(1M), \fBattributes\fR(5), \fBsmf\fR(5)