share/man/man8/isns.8

   1 '\" te
   2 .\" Copyright (c) 2007, 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 ISNS 8 "Nov 8, 2007"
   7 .SH NAME
   8 isns \- Internet Storage Name Service
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/isns\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The Internet Storage Name Service (iSNS) provides consolidated discovery
  19 services for Internet SCSI (iSCSI) and Internet Fibre Channel Protocol (iFCP)
  20 devices in an IP network.  iSNS uses a client/server mechanism: servers store
  21 configuration  information for clients, and provide that information upon a
  22 client's request. IETF RFC  4171 describes the protocols between the server and
  23 client.
  24 .sp
  25 .LP
  26 This man page provides a summary of the Solaris iSNS server implementation. The
  27 current implementation does not support iFCP devices.
  28 .sp
  29 .LP
  30 Solaris iSNS server is implemented as the daemon \fBisns\fR, which binds to the
  31 well -known port 3205 to service client requests. The daemon is started by the
  32 service management facility (\fBsmf\fR(5)), using the fault management resource
  33 identifier (FMRI):
  34 .sp
  35 .in +2
  36 .nf
  37 svc:/network/isns_server
  38 .fi
  39 .in -2
  40 .sp
  41
  42 .sp
  43 .LP
  44 Use \fBsvcadm\fR(8) to enable \fBisns\fR. Enabling the service means that it
  45 starts and runs automatically whenever the operating system is booted. The
  46 state of service can be displayed with the \fBsvcs\fR(1) command.
  47 .sp
  48 .LP
  49 The service properties listed below can be managed using \fBsvccfg\fR(8). The
  50 default value is assigned per RFC 4171 and implementation choice.
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBdata_store_location\fR\fR
  55 .ad
  56 .sp .6
  57 .RS 4n
  58 Configuration data store location. The default location is
  59 \fB/etc/isns/isnsdata.xml\fR.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBESI_retry_threshold_count\fR\fR
  66 .ad
  67 .sp .6
  68 .RS 4n
  69 Entity Status Inquiry retry threshold counter. The default count is \fB3\fR.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBManagement_SCNs_Enabled\fR\fR
  76 .ad
  77 .sp .6
  78 .RS 4n
  79 Boolean that determines whether Management State Change Notification is
  80 enabled. The default is \fByes\fR.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBAuthorized_Control_Nodes\fR\fR
  87 .ad
  88 .sp .6
  89 .RS 4n
  90 Control node names.
  91 .RE
  92
  93 .sp
  94 .LP
  95 After changing a property value, you must use \fBsvcadm\fR(8) \fBrefresh\fR to
  96 enable \fBisns\fR to recognize the new value. If you change the
  97 \fBdata_store_location\fR property, you must enter a \fBsvcadm restart\fR
  98 command for the change to take effect.
  99 .sp
 100 .LP
 101 RFC 4171 defines the default discovery domain, the default domain set, and the
 102 "Default DD/DDS" setting with the intent of managing clients that have not been
 103 assigned to any user-defined discovery domain. The server adopts the following
 104 behaviors with respect to the default discovery domain and domain set:
 105 .RS +4
 106 .TP
 107 .ie t \(bu
 108 .el o
 109 An unassigned client is added to the default discovery domain. A newly
 110 registered client or a client that was removed from its last discovery domain
 111 membership is considered to be an unassigned client.
 112 .RE
 113 .RS +4
 114 .TP
 115 .ie t \(bu
 116 .el o
 117 When a client gets assigned to a user-defined discovery domain, the server will
 118 remove the client from the default discovery domain.
 119 .RE
 120 .RS +4
 121 .TP
 122 .ie t \(bu
 123 .el o
 124 The default discovery domain set is allowed to be administratively activated or
 125 deactivated in order to let the administrator control discovery among clients
 126 in the default discovery domain.
 127 .RE
 128 .RS +4
 129 .TP
 130 .ie t \(bu
 131 .el o
 132 It is not allowed to administratively add a client to the default discovery
 133 domain, nor to administratively add a user-defined discovery domain to the
 134 default discovery domain set.
 135 .RE
 136 .RS +4
 137 .TP
 138 .ie t \(bu
 139 .el o
 140 The default state of the Default discovery domain set is inactive.
 141 .RE
 142 .sp
 143 .LP
 144 The \fBisns\fR server supports certain \fBrbac\fR(5) authorizations that allow
 145 you to administer \fBisns\fR activity. These authorizations include the
 146 following \fBauth_attr\fR(4) privileges:
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fBsolaris.isnsmgr.write\fR\fR
 151 .ad
 152 .sp .6
 153 .RS 4n
 154 Required to create a discovery domain or domain set, to enable/disable a
 155 discovery domain set and to change grouping of iSNS  clients in a discovery
 156 domain or grouping of discovery domains in a discovery domain set.
 157 .RE
 158
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fBsolaris.smf.manage.isns\fR\fR
 163 .ad
 164 .sp .6
 165 .RS 4n
 166 Required to manage the \fBisns\fR server through  the \fBsmf\fR(5).
 167 .RE
 168
 169 .sp
 170 .ne 2
 171 .na
 172 \fB\fBsolaris.smf.value.isns\fR\fR
 173 .ad
 174 .sp .6
 175 .RS 4n
 176 Required to change the SMF service properties associated with \fBisns\fR.
 177 .RE
 178
 179 .sp
 180 .LP
 181 The iSNS Server Management profile (see \fBprof_attr\fR(4)) includes all of the
 182 preceding authorizations. See \fBrbac\fR(5) for an overview of roles and
 183 authorizations.
 184 .SH OPTIONS
 185 .sp
 186 .LP
 187 There are no options supported by the \fBisns\fR daemon.
 188 .SH EXAMPLES
 189 .LP
 190 \fBExample 1 \fRStarting an \fBisns\fR Server
 191 .sp
 192 .LP
 193 The following command starts the \fBisns\fR server.
 194
 195 .sp
 196 .in +2
 197 .nf
 198 # \fBsvcadm enable svc:/network/isns_server\fR
 199 .fi
 200 .in -2
 201 .sp
 202
 203 .LP
 204 \fBExample 2 \fRStopping an \fBisns\fR Server
 205 .sp
 206 .LP
 207 The following command stops the \fBisns\fR server.
 208
 209 .sp
 210 .in +2
 211 .nf
 212 # \fBsvcadm disable svc:/network/isns_server\fR
 213 .fi
 214 .in -2
 215 .sp
 216
 217 .LP
 218 \fBExample 3 \fRChanging an \fBisns\fR Property
 219 .sp
 220 .LP
 221 The following sequence of commands changes the value of the
 222 \fBESI_retry_threshold_count\fR property.
 223
 224 .sp
 225 .in +2
 226 .nf
 227 # \fBsvccfg -s svc:/network/isns_server setprop \e
 228 config/ESI_retry_threshold_count = 6\fR
 229 # \fBsvcadm refresh svc:/network/isns_server\fR
 230 .fi
 231 .in -2
 232 .sp
 233
 234 .SH FILES
 235 .sp
 236 .ne 2
 237 .na
 238 \fB\fB/usr/sbin/isns\fR\fR
 239 .ad
 240 .sp .6
 241 .RS 4n
 242 iSNS daemon binary.
 243 .RE
 244
 245 .SH ATTRIBUTES
 246 .sp
 247 .LP
 248 See \fBattributes\fR(5) for descriptions of the following attributes:
 249 .sp
 250
 251 .sp
 252 .TS
 253 box;
 254 c | c
 255 l | l .
 256 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 257 _
 258 Interface Stability     Standard
 259 .TE
 260
 261 .SH SEE ALSO
 262 .sp
 263 .LP
 264 \fBsvcs\fR(1), \fBisnsadm\fR(8), \fBsvcadm\fR(8), \fBsvccfg\fR(8),
 265 \fBauth_attr\fR(4), \fBprof_attr\fR(4), \fBattributes\fR(5), \fBrbac\fR(5),
 266 \fBsmf\fR(5)
 267 .SH NOTES
 268 .sp
 269 .LP
 270 It is strongly recommended that you restart the server (\fBsvcadm restart\fR)
 271 after a service property is changed. This allows the server to apply a uniform
 272 setting for existing and new clients.
 273 .sp
 274 .LP
 275 A control node, as described in RFC 4171, is not required to administer the
 276 server. Control node operations can be achieved through the \fBisnsadm\fR(8)
 277 command interface on the local host. For example, \fBisnsadm\fR enables you to
 278 create a discovery domain and a discovery domain set and to add a member to it,
 279 in order to create discovery domain and discovery domain set associations.