share/man/man8/dcs.8

   1 '\" te
   2 .\" Copyright 2005 (c), 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 DCS 8 "Apr 25, 2006"
   7 .SH NAME
   8 dcs \- domain configuration server
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/lib/dcs\fR [\fB-s\fR \fIsessions\fR]
  13      [ [\fB-a\fR \fIauth\fR] [\fB-e\fR \fIencr\fR] [\fB-u\fR \fIesp_auth\fR] ] [\fB-l\fR]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The Domain Configuration Server (DCS) is a daemon process that runs on Sun
  20 servers that support remote Dynamic Reconfiguration (DR) clients. It is started
  21 by the Service Management Facility (see \fBsmf\fR(5)) when the first DR request
  22 is received from a client connecting to the network service \fBsun-dr\fR. After
  23 the DCS accepts a DR request, it uses the \fBlibcfgadm\fR(3LIB) interface to
  24 execute the DR operation. After the operation is performed, the results are
  25 returned to the client.
  26 .sp
  27 .LP
  28 The DCS listens on the network service labeled \fBsun-dr\fR. Its underlying
  29 protocol is TCP. It is invoked as a server program by the SMF using the TCP
  30 transport. The fault management resource identifier (FMRI) for DCS is:
  31 .sp
  32 .in +2
  33 .nf
  34 svc:/platform/sun4u/dcs:default
  35 .fi
  36 .in -2
  37 .sp
  38
  39 .sp
  40 .LP
  41 If you disable this service, DR operations initiated from a remote host fail.
  42 There is no negative impact on the server.
  43 .sp
  44 .LP
  45 Security for the DCS connection is provided differently based upon the
  46 architecture of the system. The SMF specifies the correct options when invoking
  47 the DCS daemon, based upon the current architecture. For all architectures,
  48 security is provided on a per-connection basis.
  49 .sp
  50 .LP
  51 The DCS daemon has no security options that are applicable when used on a Sun
  52 Enterprise 10000 system. So there are no options applicable to that
  53 architecture.
  54 .sp
  55 .LP
  56 The security options for Sun Fire high-end systems are based on IPsec options
  57 defined as SMF properties. These options include the \fB-a\fR \fIauth\fR,
  58 \fB-e\fR \fIencr\fR, and \fB-u\fR \fIesp_auth\fR options, and can be set using
  59 the \fBsvccfg\fR(8) command. These options must match the IPsec policies
  60 defined for DCS on the system controller. Refer to the \fBkmd(8)\fR man page
  61 in the \fISystem Management Services (SMS) Reference Manual\fR. The
  62 \fBkmd(8)\fR man page is not part of the SunOS man page collection.
  63 .sp
  64 .LP
  65 Security on SPARC Enterprise Servers is not configurable. The DCS daemon uses a
  66 platform-specific library to configure its security options when running on
  67 such systems. The \fB-l\fR option is provided by the SMF when invoking the DCS
  68 daemon on SPARC Enterprise Servers. No other security options to the DCS daemon
  69 should be used on SPARC Enterprise Servers.
  70 .SH OPTIONS
  71 .sp
  72 .LP
  73 The following options are supported:
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fB-a\fR \fIauth\fR\fR
  78 .ad
  79 .RS 15n
  80 Controls the IPsec Authentication Header (AH) algorithm. \fIauth\fR can be one
  81 of \fBnone\fR, \fBmd5\fR, or \fBsha1\fR.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fB-e\fR \fIencr\fR\fR
  88 .ad
  89 .RS 15n
  90 Controls the IPsec Encapsulating Security Payload (ESP) encryption algorithm.
  91 \fIencr\fR can be one of \fBnone\fR, \fBdes\fR, or \fB3des\fR.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fB-l\fR\fR
  98 .ad
  99 .RS 15n
 100 Enables the use of platform-specific security options on SPARC Enterprise
 101 Servers.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fB-s\fR \fIsessions\fR\fR
 108 .ad
 109 .RS 15n
 110 Sets the number of active sessions that the DCS allows at any one time. When
 111 the limit is reached, the DCS stops accepting connections until active sessions
 112 complete the execution of their DR operation. If this option is not specified,
 113 a default value of 128 is used.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fB-u\fR \fIesp_auth\fR\fR
 120 .ad
 121 .RS 15n
 122 Controls the IPsec Encapsulating Security Payload (ESP) authentication
 123 algorithm. \fIesp_auth\fR can be one of \fBnone\fR, \fBmd5\fR, or \fBsha1\fR.
 124 .RE
 125
 126 .SH EXAMPLES
 127 .LP
 128 \fBExample 1 \fRSetting an IPSec Option
 129 .sp
 130 .LP
 131 The following command sets the Authentication Header algorithm for the DCS
 132 daemon to use the HMAC-MD5 authentication algorithm. These settings are only
 133 applicable for using the DCS daemon on a Sun Fire high-end system.
 134
 135 .sp
 136 .in +2
 137 .nf
 138 # \fBsvccfg -s svc:/platform/sun4u/dcs setprop dcs/ah_auth = "md5"\fR
 139 # \fBsvccfg -s svc:/platform/sun4u/dcs setprop dcs/esp_encr = "none"\fR
 140 # \fBsvccfg -s svc:/platform/sun4u/dcs setprop dcs/esp_auth = "none"\fR
 141 # \fBsvcadm refresh svc:/platform/sun4u/dcs\fR
 142 .fi
 143 .in -2
 144 .sp
 145
 146 .SH ERRORS
 147 .sp
 148 .LP
 149 The DCS uses \fBsyslog\fR(3C) to report status and error messages. All of the
 150 messages are logged with the \fBLOG_DAEMON\fR facility. Error messages are
 151 logged with the \fBLOG_ERR\fR and \fBLOG_NOTICE\fR priorities, and
 152 informational messages are logged with the \fBLOG_INFO\fR priority. The default
 153 entries in the \fB/etc/syslog.conf\fR file log all of the DCS error messages to
 154 the \fB/var/adm/messages\fR log.
 155 .SH ATTRIBUTES
 156 .sp
 157 .LP
 158 See \fBattributes\fR(5) for descriptions of the following attributes:
 159 .sp
 160
 161 .sp
 162 .TS
 163 box;
 164 c | c
 165 l | l .
 166 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 167 _
 168 Interface Stability     Evolving
 169 .TE
 170
 171 .SH SEE ALSO
 172 .sp
 173 .LP
 174 \fBsvcs\fR(1), \fBcfgadm_sbd\fR(8), \fBsvcadm\fR(8), \fBsvccfg\fR(8),
 175 \fBsyslog\fR(3C), \fBconfig_admin\fR(3CFGADM), \fBlibcfgadm\fR(3LIB),
 176 \fBsyslog.conf\fR(4), \fBattributes\fR(5), \fBsmf\fR(5), \fBdr\fR(7D)
 177 .SH NOTES
 178 .sp
 179 .LP
 180 The \fBdcs\fR service is managed by the service management facility,
 181 \fBsmf\fR(5), under the fault management resource identifier (FMRI):
 182 .sp
 183 .in +2
 184 .nf
 185 svc:/platform/sun4u/dcs:default
 186 .fi
 187 .in -2
 188 .sp
 189
 190 .sp
 191 .LP
 192 Administrative actions on this service, such as enabling, disabling, or
 193 requesting restart, can be performed using \fBsvcadm\fR(8). The service's
 194 status can be queried using the \fBsvcs\fR(1) command.