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