1wusbadm(1M) System Administration Commands wusbadm(1M)
2
6 wusbadm - administer wireless USB hosts and devices
7
9 wusbadm list [-h | -d] [-o field[,...]]
10 wusbadm associate [-h host-id] [[-c [-f]] | -n] [-o]
13 wusbadm remove-dev [[-d dev-id] | [-h host-id]] [-f]
16 wusbadm remove-host [-h host-id] [-f]
19 wusbadm enable-host [-h host-id]
22 wusbadm disable-host [-h host-id]
25
28 The wusbadm command provides a command line interface to administer
29 wireless USB hosts and devices, including listing hosts and devices
30 information, associating the host with the device, removing host or
31 device information from the system, and enabling or disabling hosts.
32 Before connecting a wireless USB device to a host for the first time, a
35 user needs to set up the association information between them by run‐
36 ning the wusbadm associate subcommand. Following this, the user can
37 connect or disconnect the device by simply turning on or off the device
38 radio (perhaps a button on the device, depending on the manufacturer).
39 The device radio's turning on and off are analogous to the hotplugging
40 of wired USB devices.
41 The association information created by the associate subcommand is
44 maintained in the non-volatile memory of the device and the host. On
45 the host, it can be removed by the remove-dev or remove-host subcom‐
46 mands. On the device, it can be overwritten by another association. For
47 a device is associated with multiple hosts, the way that the device
48 prioritizes or updates its multiple records of association depends on
49 the manufacturer.
50 Each wusbadm subcommand operates on one of the following objects:
53 host-id
55 A two-digit number (in the range from 01 to 99) that uniquely
57 identifies a wireless USB host on a system. It is generated when
58 the wusb service (see NOTES section) is successfully enabled and
59 finds the host instance for the first time. The number is main‐
60 tained until removed by remove-host subcommand.
61 dev-id
64 A five-digit number that uniquely identifies a wireless USB device
66 associated with a wireless USB host. The first two digits are the
67 host-id of the wireless USB host with which the device is associ‐
68 ated. The last three-digit number (in the range from 001 to 999) is
69 used to differentiate devices associated with the same host. In the
70 five-digit number, the first two digits and the last three are sep‐
71 arated by a dot.
72 dev-id is generated during the device association process. It is
74 maintained for the device until removed by the remove-dev subcom‐
75 mand or until updated by another association between the same host
76 and device.
77
80 The following subcommands are supported. Except for the list subcom‐
81 mand, each subcommand displays subcommand-specific usage information if
82 you run it without any options or operands.
83 list [-h | -d] [-o field[,...]]
85 List wireless USB hosts and devices on a system, displaying the ID,
87 state, and type for all hosts and devices. By default, list will
88 list all hosts and devices and all fields. Each host and its
89 devices will be displayed as a group. This subcommand supports the
90 following options.
91 -o field[,...], --output=field[,...]
93 A case-insensitive, comma-separated list of output fields to
95 display. The field name must be one of the fields listed below,
96 or the special value all to display all fields. By default
97 (without -o), list displays all fields.
98 ID
100 The host-id or dev-id.
102 TYPE
105 The host or device types.
107 For host, the types include whci (on-board host) and hwa
109 (hot-pluggable host).
110 For device, the types include kbd, mouse, storage, printer,
112 dwa (wireless USB hub), audio, video, and so forth.
113 STATE
116 There are the following states for the host:
118 enabled
120 The host is ready to work or is already working,
122 including performing association, connecting devices,
123 performing data communication, and so forth.
124 disabled
127 The host is not ready to work with any devices and no
129 devices are connected to the host. It might be stopped
130 by a disable-host subcommand, or the host might not be
131 available because it is physically unplugged or because
132 of a driver detach.
133 disconnected
136 The host is not attached to the system. An hwa device
138 is in this state after it is unplugged from the USB
139 port on the system.
140 There are the folllowing states for the device:
142 connected
144 The device is connected with a host and ready to be
146 opened, or it is already opened and working. By
147 default, the device tries to get into this state after
148 the association is complete and its radio is turned on.
149 disconnected
152 The device is not connected to a host or not ready to
154 be opened yet. The device might be in this state
155 because its radio is out of range, power is off, hard‐
156 ware problems, and so forth.
157 -h, --host
162 List the wireless USB hosts only.
164 -d, --device
167 List the wireless USB devices only.
169 associate [-h host-id] [[-c [-f]] | -n] [-o]
173 Designate the host to start an association process. Association is
175 the initial step before a wireless USB device can be connected with
176 a wireless USB host.
177 There are two association models:
179 Cable association
181 A user connects the device and host with a USB cable first, and
183 then run this subcommand to designate the host to setup the
184 association information with the device. After the association
185 is in effect, the cable is no longer needed in the subsequent
186 connections between the same host and the device.
187 Numeric association
190 A user turns on the device radio and runs this subcommand to
192 designate the host to talk to the device. A short number is
193 then displayed on both host and device. The user compares the
194 values of the numbers and confirms on both the host and the
195 device.
196 Following a successful association, the associated USB host and
198 device are able to proceed with the wireless connection process. By
199 default, the association information will be kept both on the host
200 and the device until it is removed or overwritten.
201 If there are multiple devices available for association, this sub‐
203 command will list all of them, enabling a user to choose among
204 them. This subcommand has the following options.
205 -h host-id, --host host-id
207 Specify the host for which the association will be done. If
209 this option is not specified, this subcommand lists all enabled
210 hosts for users to choose.
211 -c, --cable
214 Start the cable association process. A user plugs the wireless
216 USB device to the host and runs the associate subcommand with
217 this option.
218 -n, --numeric
221 Start the numeric association process. This subcommand prompts
223 the user to compare the number displayed on the host and the
224 device.
225 If neither of the preceding two association model options (-n or
227 -c) is specified, this subcommand prompts the user to specify one
228 of the following association model options.
229 -f, --force
231 Start the cable association process. A user plugs the wireless
233 USB device to the host and runs the associate subcommand with
234 this option.
235 -o, --onetime
238 Indicate that this association is for a one-time connection.
240 That is, after the association, if the device is connected and
241 then disconnected, the association information for this device
242 will be removed from the host system. A user would need to per‐
243 form another association for the next connection.
244 remove-dev [[-d dev-id] | [-h host-id]][-f]
248 Remove the association information of the wireless USB device from
250 the system. After the removal, the device cannot be connected with
251 the host until the user runs the associate subcommand again, for
252 the host and device. This subcommand has the following options.
253 -d, --device=dev-id
255 Remove the association information of the wireless USB device
257 specified by dev-id.
258 -h host-id, --host=host-id
261 Remove the association information of all the wireless USB
263 devices associated with the host specified by host-id.
264 -f, --force
267 Perform the removal without asking for confirmation. If the
269 device is being connected with the host, then this subcommand
270 will force it to disconnect.
271 remove-host [-h host-id] [-f]
275 Remove the host information from the system, including host-id and
277 the association information of all the devices associated with the
278 host. This subcommand is used most often for removing the temporar‐
279 ily used hot-pluggable wireless USB host, for example, a hwa don‐
280 gle. The host can be brought back by being re-enumerated, for exam‐
281 ple, physically hot-plugging a hwa dongle. The host-id will then be
282 updated and no device association information can be restored. It
283 is not recommended to remove a on-board host. This subcommand has
284 the following options.
285 -h host-id, --host=host-id
287 Specifies the host-id to be removed.
289 -f, --force
292 Perform the removal without asking for confirmation. If there
294 are one or more devices connected with the host, then force
295 them to disconnect.
296 enable-host [-h host-id]
300 Take the host to the enabled state. By default, the host is in the
302 enabled state. This subcommand has the following option.
303 -h host-id, --host=host-id
305 Specifies the host-id to be enabled.
307 disable-host [-h host-id] [-f]
311 Take the host to the disabled state. The host-id and all the asso‐
313 ciation information of the host are maintained. Issuing an enable-
314 host subcommand brings the host back to the enabled state. This
315 subcommand has the following options.
316 -h host-id, --host=host-id
318 Specifies the host-id to be disabled.
320 -f, --force
323 Perform the disable operation without asking for confirmation.
325 If there are one or more devices connected with the host, this
326 option forces them to disconnect.
327
331 Example 1 Listing All Hosts and Devices
332 The following command lists all wireless USB hosts and devices.
335 # wusbadm list
338 01 enabled hwa
339 01.001 connected mouse
340 01.002 connected kbd
341 02 enabled whci
342 02.001 connected printer
343 02.002 disconnected storage
344 03 disabled hwa
345 03.001 disconnected storage
346 03.002 disconnected dwa
347 Example 2 Associating to a Device Using Cable
351 The following command associates a device to a specific host (host-id
354 01), using the cable association approach.
355 # wusbadm associate -h 01 -c
358 Associate a device with host (01) via cable.
359 Continue (yes/no)?
360 Example 3 Removing a Device's Association
364 The following command removes a device's association information from
367 the host system.
368 # wusbadm remove-dev -d 01.002
371 Remove the information of device (01.002) from system.
372 This device can not be connected with the host until it is associated
373 again. Continue (yes/no)?
374 Example 4 Removing Associations for All Devices
378 The following command removes the association information for all
381 devices associated with a specific host.
382 # wusbadm remove-dev -h 02
385 Remove the information of all the devices associated with host (02)
386 from the system.
387 All the devices associated with the host cannot be connected with it
388 until they are associated again. Continue (yes/no)?
389
393 The following exit values are returned:
394 0
396 Successful operation.
398 1
401 Error: the operation failed. For example, a device failed to asso‐
403 ciate with a host.
404 2
407 Usage error.
409
412 See attributes(5) for descriptions of the following attributes:
413 /usr/sbin
416 ┌─────────────────────────────┬─────────────────────────────┐
421 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
422 ├─────────────────────────────┼─────────────────────────────┤
423 │Availability │SUNWusb │
424 ├─────────────────────────────┼─────────────────────────────┤
425 │Interface Stability │Committed │
426 └─────────────────────────────┴─────────────────────────────┘
427
429 attributes(5), hwahc(7D), usba(7D)
430
432 The wusb (wireless USB administration) service is managed by the ser‐
433 vice management facility, smf(5), under the service identifier:
434 svc:/system/wusb:default
436 Administrative actions on this service, such as enabling, disabling, or
441 requesting restart, can be performed using svcadm(1M). The service's
442 status can be queried using the svcs(1) command.
443 The wusb service is implemented by the wusbd daemon, a private inter‐
446 face. As with the wusb service, the daemon is started by the SMF. Spec‐
447 ify the daemon with the service instance:
448 svc:/system/wusbd:default
450 The wusbd daemon should not be invoked directly.
455SunOS 5.11 22 Apr 2009 wusbadm(1M)