1cfgadm_fp(1M) System Administration Commands cfgadm_fp(1M)
2
6 cfgadm_fp - driver specific commands for cfgadm
7
9 /usr/sbin/cfgadm [-f] [-n | -y] [-v] [-o hardware_options]
10 -c function ap_id [ap_id]
11 /usr/sbin/cfgadm [-v] [-a] [-s listing_options]
14 [-o hardware_options] [-l [ap_id]]
15 /usr/sbin/cfgadm [-v] [-o hardware_options] -h [ap_id]
18
21 The fp port driver plug-in /usr/lib/cfgadm/fp.so.1 provides the func‐
22 tionality for Fibre Channel Fabric device node management through
23 cfgadm(1M). cfgadm operates on attachment points. Attachment points are
24 locations in the system where hardware resources can be dynamically
25 reconfigured. Refer to cfgadm(1M) for additional details on attachment
26 points.
27 For Fibre Channel Fabric device node management, each fp port node is
30 represented by an attachment point in the device tree. In addition,
31 each Fibre Channel device is represented by a dynamic attachment point.
32 Attachment points are named through ap_ids. Two types of ap_ids are
33 defined: logical and physical. The physical ap_id is based on the phys‐
34 ical pathname. The logical ap_id is a shorter, more user-friendly name.
35 For fp port nodes, the logical ap_id is the corresponding disk con‐
36 troller number. For example, c0 is a typical logical ap_id.
37 Fibre Channel devices are named with a port World Wide Name (WWN). If a
40 disk device is connected to controller c0, its ap_id can be:
41 c0::50020f2300006077
43 where 50020f2300006077 identifies the port WWN of a specific Fibre
48 Channel device.
49 Each device on the Fibre Channel private loop port, Fabric port or pub‐
52 lic loop port is probed and made available to Solaris by default.
53 Devices connected to the Fibre Channel Fabric port or public loop port
54 can be made unavailable to Solaris by initiating an application or an
55 end user operation. The operation is similar to the hot unplugging of
56 devices by way of management user interfaces. Applications or users can
57 use the /usr/lib/cfgadm/fp.so.1 library to enable libcfgadm to provide
58 interfaces to accomplish this task.
59 The list of currently connected Fabric devices is generated in the form
62 of the attachment point.
63 A simple listing of attachment points in the system includes attachment
66 points at fp port nodes but not Fibre Channel devices. The following
67 example uses the -a flag to the list option (-l) to list Fibre Channel
68 devices:
69 # cfgadm -l
71 Ap_Id Type Receptacle Occupant Condition
72 c0 fc-fabric connected configured unknown
73 c1 fc-private connected configured unknown
74 c2 fc-pt_to_pt connected configured unknown
75 c3 fc connected unconfigured unknown
76 sysctrl0:slot0 cpu/mem connected configured ok
77 sysctrl0:slot1 sbus-upa connected configured ok
78 The following example lists Fibre Channel devices connected to fp
83 ports.
84 # cfgadm -al
86 Ap_Id Type Receptacle Occupant Condition
87 c0 fc-fabric connected configured unknown
88 c0::50020f2300006077 disk connected configured unknown
89 c0::50020f23000063a9 disk connected configured unknown
90 c0::50020f2300005f24 disk connected configured unknown
91 c0::50020f2300006107 disk connected configured unknown
92 c1 fc-private connected configured unknown
93 c1::220000203708b69c disk connected configured unknown
94 c1::220000203708ba7d disk connected configured unknown
95 c1::220000203708b8d4 disk connected configured unknown
96 c1::220000203708b9b2 disk connected configured unknown
97 c2 fc-pt_to_pt connected configured unknown
98 c2::500104f000937528 tape connected configured unknown
99 c3 fc connected unconfigured unknown
100 sysctrl0:slot0 cpu/mem connected configured ok
101 sysctrl0:slot1 sbus-upa connected configured ok
102 In this example, the fc-fabric type of ap_id c0 indicates that the fp
107 port is connected to Fabric. For an fp port with a Fabric-related type
108 such as fc-fabric and fc-public, device node creation happens by
109 default at the boot time and can be managed by the cfgadm configure and
110 unconfigure operations. The fc-private type of ap_id c1 indicates
111 that fp port is connected to private-loop and device node creation hap‐
112 pens by default as well. The fc-pt_to_pt type of ap_id c2 indicates
113 that the fp port is directly connected to another N_port and device
114 node creation also happens by default. The fc type of ap_id c3 indi‐
115 cates that nothing is attached to fp port c2. The Type field of a Fibre
116 Channel device ap_id shows the SCSI device type of LUN 0 in the
117 device.
118 A Fibre Channel device with multiple FCP SCSI LUNs is configured into
121 Solaris and each FCP SCSI LUN is available as a Solaris device. Suppose
122 that ap_ids c0::50020f2300006077 and c0::50020f23000063a9 represent
123 Fibre Channel devices with multiple FCP SCSI LUNs.
124 The following example shows how to list ap_ids with FCP SCSI LUN infor‐
127 mation:
128 # cfgadm -al -o show_SCSI_LUN
130 Ap_Id Type Receptacle Occupant Condition
131 c0 fc-fabric connected configured unknown
132 c0::50020f2300006077,0 disk connected configured unknown
133 c0::50020f2300006077,1 disk connected configured unknown
134 c0::50020f2300006077,2 disk connected configured unknown
135 c0::50020f2300006077,3 disk connected configured unknown
136 c0::50020f23000063a9,0 disk connected configured unknown
137 c0::50020f23000063a9,1 disk connected configured unknown
138 c0::50020f23000063a9,2 disk connected configured unknown
139 c0::50020f23000063a9,3 disk connected configured unknown
140 c0::50020f2300005f24,0 disk connected unconfigured unknown
141 c0::50020f2300005f24,1 disk connected unconfigured unknown
142 c0::50020f2300006107,0 disk connected unconfigured unknown
143 c0::50020f2300006107,1 disk connected unconfigured unknown
144 c1 fc-private connected configured unknown
145 c1::220000203708b69c,0 disk connected configured unknown
146 c1::220000203708ba7d,0 disk connected configured unknown
147 c1::220000203708b8d4,0 disk connected configured unknown
148 c1::220000203708b9b2,0 disk connected configured unknown
149 c2 fc-pt_to_pt connected configured unknown
150 c2::500104f000937528,0 tape connected configured unknown
151 c3 fc connected unconfigured unknown
152 In this example, the ap_id c0::50020f2300006077,0 identifies the FCP
157 SCSI LUN 0 of the Fibre Channel device which is represented by port WWN
158 50020f2300006077. The Fibre Channel device is reported to have 4 FCP
159 SCSI LUNs and they are all configured. 4 FCP SCSI LUN level ap_ids
160 associated with port WWN 50020f2300006077 are listed. The listing also
161 displays FCP SCSI LUNs for unconfigured Fibre Channel devices. The
162 Fibre Channel device represented by c0::50020f2300005f24 is reported to
163 have two FCP SCSI LUNs. The configure operation on c0::50020f2300005f24
164 creates two Solaris devices. The Type field of FCP SCSI LUN level
165 ap_ids show the SCSI device type of each LUN. When a Fibre Channel
166 device has different device type LUNs, the Type field reflects that.
167 The receptacle and occupant state for attachment points at the fp port
170 have the following meanings:
171 configured
173 One or more devices configured on the fp port
175 connected
178 fp port active
180 disconnected
183 fp port quiesced (IO activity is suspended)
185 empty
188 Not applicable
190 unconfigured
193 No devices configured on the fp port
195 The state for individual Fibre Channel devices on an fp port:
199 configured
201 Device is configured into Solaris and is available for use
203 connected
206 fp port to which the device is connected to is active
208 disconnected
211 fp port to which the device is attached is quiesced
213 unconfigured
216 Device is available to be configured
218 The condition field for attachment points at the fp port has the fol‐
222 lowing meanings:
223 failed
225 An error condition has prevented the fp port from being able to
227 detect the presence or type of a Fibre Channel connection.
228 The condition field for individual Fibre Channel devices on an fp port
232 has the following meanings:
233 failed
235 An error is encountered while probing a device on Fabric.
237 failing
240 A device was configured on a host and its state as seen by Solaris
242 appears to be normal (i.e., online) but it is either not currently
243 present or visible in the fabric or its presence could not be veri‐
244 fied due to an error condition on the local port through which the
245 device was configured.
246 unusable
249 A device has been configured on the host, but is currently offline
251 or failed.
252 The unknown condition indicates that probing a device on Fabric com‐
256 pleted without an error and the device state within Solaris host is
257 normal if the device was configured previously. The internal condition
258 of the device cannot be guaranteed.
259
261 cfgadm defines several types of operations in addition to listing (-l).
262 These operations include invoking configuration state changes and
263 obtaining configuration administration help messages (-h).
264 The following options are supported:
267 -c function
269 The following generic commands are defined for the fp-transport-
271 specific library:
272 For Fibre Channel device attachment points on the fc-fabric type fp
274 port attachment point, the following configuration state change
275 operations are supported:
276 configure
278 Configure a connected Fibre Channel Fabric device to a host.
280 When a Fibre Channel device is listed as an unknown type in the
281 output of the list operation the device might not be config‐
282 urable. No attempt is made to configure devices with unknown
283 types. The force option (-f) can be used to force the fp port
284 driver plug-in to make an attempt to configure any devices. Any
285 errors in the process are reported. By default, each FCP SCSI
286 LUN that is discovered on a Fibre channel Fabric device is con‐
287 figured. However, FCP SCSI LUNs that are specified in the
288 "pwwn-lun-blacklist" property in the fp.conf file will remain
289 unconfigured. The FCP SCSI LUN level listing reflects the state
290 of such FCP SCSI LUNs. They stay in the "unconfigured" state
291 after reboot or Solaris Dynamic Reconfiguration on the con‐
292 troller that they are connected through. Refer to fp(7D) for
293 additional details on the "pwwn-lun-blacklist" property.
294 unconfigure
297 Unconfigure a Fibre Channel Fabric device from a host. This
299 device stays unconfigured until the next reboot or Solaris
300 Dynamic Reconfiguration on the controller that the device is
301 connected, at which time all fabric devices are automatically
302 enumerated. The default behavior may be changed through the use
303 of the "manual_configuration_only" property in the fp.conf
304 file. If the property is set, the device remains unconfigured
305 after reboot. Refer to fp(7D) for additional details on the
306 "manual_configuration_only" property.
307 For Fibre Channel private loop devices and N_Port point-to-point
309 devices, the configure command returns success without doing any
310 operation. The unconfigure command is not supported on the private
311 loop devices and N_Port point-to-point devices. The private loop
312 devices and N_Port point-to-point devices are configured by Solaris
313 Fibre Channel drivers by default and are not managed through end
314 user- or application-initiated operations. The pwwn-lun-blacklist
315 property in the fp.conf file is applied to the private loop device
316 and N_Port point-to-point device in the same way it is applied to a
317 Fabric device.
318 -f
321 Force the configure change state operation to occur irrespective of
323 the condition or type. Refer to the above description of the con‐
324 figure change state operation.
325 -h ap_id
328 Obtain fp—transport-specific help. Specify any fp attachment point.
330 -o hardware_options
333 The following hardware options are supported.
335 show_SCSI_LUN
337 Lists ap_ids associated with each FCP SCSI LUN for discovered
339 Fibre Channel devices when specified with the list option -al.
340 Refer to the previously mentioned description and example of
341 FCP SCSI LUN level listing. Device node creation is not sup‐
342 ported on the FCP SCSI LUN level. See NOTES.
343 All Fibre Channel devices are available to Solaris by default.
345 Enabling only a subset of Fabric devices available to Solaris by
346 default can be accomplished by setting the property "manual_config‐
347 uration_only" in /kernel/drv/fp.conf file. When "manual_configura‐
348 tion_only" in fp.conf is set, all Fabric devices are not available
349 to Solaris unless an application or an end user had previously
350 requested the device be configured into Solaris. The configure
351 state-change command makes the device available to Solaris. After a
352 successful configure operation on a Fabric device, the associated
353 links are added to the /dev namespace. The unconfigure state-change
354 command makes a device unavailable to Solaris.
355 When a Fibre Channel Fabric device is configured successfully to a
357 host using the -c configure operation, its physical ap_id is stored
358 in a repository. When a Fibre Channel Fabric device is unconfigured
359 using the -c unconfigure operation, its physical ap_id is deleted
360 from the same repository. All fabric devices are automatically enu‐
361 merated by default and the repository is used only if the fp.conf
362 "manual_configuration_only" property is set. Refer to fp(7D) for
363 additional details on the "manual_configuration_only" property.
364 You can specify the following commands with the -c option to con‐
366 trol the update behavior of the repository:
367 force_update
369 For configure, the attachment point is unconditionally added to
371 the repository; for unconfigure, the attachment point is uncon‐
372 ditionally deleted.
373 no_update
376 No update is made to the repository regardless of the opera‐
378 tion.
379 These options should not be used for normal configure and unconfig‐
381 ure operations. See WARNINGS.
382 When a Fibre Channel device has multiple FCP SCSI LUNs configured
384 and any Solaris device associated with its FCP SCSI LUN is in the
385 unusable condition, the whole Fibre Channel device is reported as
386 unusable. The following option with the -c unconfigure command
387 removes only Solaris devices with the unusable condition for a
388 Fibre Channel device.
389 unusable_SCSI_LUN
391 For unconfigure operation, any offlined device nodes for a tar‐
393 get device is removed.
394 -s listing_options
398 Refer to cfgadm(1M) for usage information.
400 -t ap_id
403 No test commands are available at present.
405 -x hardware_function
408 No hardware specific functions are available at present.
410 All other options have the same meaning as defined in the cfgadm(1M)
414 man page.
415
417 Example 1 Unconfiguring a Disk
418 The following command unconfigures a disk:
421 # cfgadm -c unconfigure c0::210000203708b606
424 Example 2 Unconfigure all the Configured Disks under Single Attachment
428 Point
429 The following command unconfigures all configured disks under the
432 attachment point c0.
433 # cfgadm -c unconfigure c0
436 Example 3 Configuring a Disk
440 The following command configures a disk:
443 # cfgadm -c configure c0::210000203708b606
446 Example 4 Configure all the Unconfigured Disks under Single Attachment
450 Point
451 The following command configures all unconfigured disks under the
454 attachment point c0.
455 # cfgadm -c configure c0
458 Example 5 Removing the Fibre Channel Fabric Device Attachment Point
462 from Repository
463 The following command unconditionally removes the fibre channel fabric
466 device attachment point from the Fabric device repository.
467 # cfgadm -c unconfigure -o force_update c0::210000203708b606
470 Example 6 Removing Offlined Solaris Device Nodes for a Target Device
474 The following command removes offlined Solaris device nodes for a tar‐
477 get device:
478 # cfgadm -c unconfigure -o unusable_SCSI_LUN c0::210000203708b606
481
485 /usr/lib/cfgadm/fp.so.1
486 Hardware-specific library for Fibre Channel Fabric device node man‐
488 agement.
489 /etc/cfg/fp/fabric_WWN_map
492 Repository of physical ap_ids of Fabric devices currently config‐
494 ured. It is used only to reconfigure those Fabric devices at boot
495 time. This repository is only used when the "manual_configura‐
496 tion_only" /kernel/drv/fp.conf file is set.
497 /etc/rcS.d/fdevattach
500 Reconfigures Fabric device(s) of which physical ap_id is listed in
502 /etc/cfg/fp/fabric_WWN_map on boot time.
503
506 See attributes(5) for descriptions of the following attributes:
507 ┌─────────────────────────────┬─────────────────────────────┐
512 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
513 ├─────────────────────────────┼─────────────────────────────┤
514 │Availability │SUNWcfpl, SUNWcfplx │
515 └─────────────────────────────┴─────────────────────────────┘
516
518 svcs(1), cfgadm(1M), svcadm(1M), config_admin(3CFGADM), libcf‐
519 gadm(3LIB), attributes(5), smf(5), fp(7D)
520
522 Do not use hardware-specific options for the repository update under
523 normal configure/unconfigure operations. The hardware-specific options
524 are expected to be used when the node creation of a Fabric device fails
525 at boot time and the error condition is considered to be permanent. The
526 unconfigure command with force_update hardware-specific option uncondi‐
527 tionally removes the attachment point of a failing Fabric device from
528 the repository.
529
531 For devices with unknown or no SCSI device type (for example, a Fibre
532 Channel Host Bus Adapter), the configure operation might not be appli‐
533 cable.
534 The configure and unconfigure commands operate on the Fibre Channel
537 device level which is represented by port WWN ap_id. If a Fibre Channel
538 device has multiple FCP SCSI LUNs configured, the configure command on
539 the associated port WWN ap_id results in creating a Solaris device for
540 each FCP SCSI LUN unless it is specified in the "pwwn-lun-blacklist"
541 property in the fp.conf file. The unconfigure command removes all
542 Solaris devices associated with the port WWN ap_id. The FCP SCSI LUN
543 level ap_id is not valid for the configure and unconfigure commands.
544 The deprecated show_FCP_dev option has been replaced by the new
547 show_SCSI_LUN option, and the deprecated unusable_FCP_dev option has
548 been replaced by the new unusable_SCSI_LUN option.
549 The cfgadm_fp service is managed by the service management facility,
552 smf(5), under the service identifier:
553 svc:/system/device/fc-fabric:default
555 Administrative actions on this service, such as enabling, disabling, or
560 requesting restart, can be performed using svcadm(1M). The service's
561 status can be queried using the svcs(1) command.
562 No administrative actions on this service are required for Fabric
565 device configuration once this service is started on boot time.
566SunOS 5.11 10 Jan 2008 cfgadm_fp(1M)