| Previous | Contents | Index |
Allows you to modify the path and unit number of a device in the permanent list. The changes take place immediately.Requires SYSPRV privilege.
MODIFY DEVICE device-name:
device-name:
The name of the device whose characteristics are to be modified. The device name has the form ddcu,where:
dd is the device code---for example, LP. (The driver name corresponds to the device code; in this case, the driver name would be SYS$LPDRIVER.) c is the controller designation A through Z; unless UCM specifies a different letter, all USB devices are A. u is the unit number (0 through 9999). OpenVMS device names are made up of the two-character device code, followed by the controller designation, the unit number (which can be 1 to 4 characters long), and, finally, a colon (:).
/BUS_NUMBER=number
Specifies the USB bus number of the device. This parameter is required to identify a particular device on a system that has multiple USB buses. If you do not use this qualifier, the bus number defaults to zero.The number can be any number from 0 through 25.
/PATH=(n1[.n2.n3.n4.n5.n6])
Specifies the path to the device on the bus. The path is used to uniquely identify a device if the device does not have a serial number. The path specification is a series of six or fewer numbers,where:
n1 is the number of the root hub (at tier 0). n2 through n6 are port numbers for downstream hubs at tiers 1, 2, 3, 4, and 5. For example, /PATH=1.4.3 indicates that the device is in turn plugged into port 3 of the second tier, which is plugged into port 4 of the first tier, which in turn is plugged into the root hub 1.
/UNIT_NUMBER=number
Unit numbers can be between 0 and 9999. By default, the configuration code selects the next available unit number. This qualifier allows you to change the unit number to suit your needs.
$ UCM
Universal Serial Bus Configuration Manager, Version V1.0
UCM> SHOW DEVICE /UNCONFIGURED
DEVICE
DEVICE_TYPE TENTATIVE
DEVICE_NAME_ROOT AGA
UNIT_NUMBER 0
BUS 1
PATH 1.0.0.0.0.0
END_DEVICE
UCM> ADD DEVICE AGA0:
UCM> MODIFY DEVICE AGA0:/UNIT=9999
UCM> SHOW DEVICE /PERMANENT /FULL AGA9999:
DEVICE
DEVICE_TYPE PERMANENT
DEVICE_NAME_ROOT AGA
UNIT_NUMBER 9999
DRIVER SYS$AGDRIVER.EXE
BUS_NUMBER 1
PATH 1.0.0.0.0.0
HID_USAGE_DATA 65540
BEGIN_INTERFACE
HID_USAGE_DATA 65540
END_INTERFACE
END_DEVICE
UCM>
|
The first SHOW DEVICE command displays information from the generic list about the unconfigured AG device. The ADD DEVICE command adds the device to the permanent list, and the MODIFY DEVICE command changes the unit number of the device. The second SHOW DEVICE command displays this change.
Forces the configuration server to reload the configuration data from the generic and permanent device files and to rebuild the lists. This allows you to add a new device type and lets the server find out about it without restarting UCM.Requires SYSPRV privilege.
RELOAD
Restarts the configuration server.
Note
Use this command only if the server no longer responds to configuration requests or client commands.Requires CMKRNL privilege.
RESTART
/CONFIRM (default)
Asks you to confirm the restart of the configuration server. If you answer yes, the configuration server is restarted. If you answer no, the operation is not performed.
/NOCONFIRM
$ UCM
UCM> RESTART
Restart UCM Server? [N]: yes
Waiting for UCM Server image to exit....
Waiting for UCM Server image to restart....
%USB-S-SRVRRESTART, Identification of new UCM Server is 00000217
UCM>
|
Following the RESTART command, UCM prompts you to confirm this command. The system assigns a new identification number to the UCM server when it restarts.
Changes the setting of auto-load, auto-perm, or exclude and include lists. When used with no qualifiers, this command causes the UCM server to reload the saved settings from disk.
Note
Once a device is made a permanent device, it is always configured and loaded, regardless of the settings for SET AUTO. To remove a permanent device, you must use the DELETE DEVICE command.
SET AUTO
/ENABLE=(LOAD,PERM)
The /ENABLE and /DISABLE qualifiers allow you to disable or selectively enable automatic loading and automatic permanence for all nonpermanent devices. The two qualifiers have these meanings:
/DISABLE=(LOAD,PERM)
Qualifier Explanation /ENABLE Allows you to selectively enable automatic loading permanence. Automatic permanence is ignored if automatic loading is disabled. However, you can enable automatic loading and disable automatic permanence. This allows devices to be configured but does not add them to the permanent database. The OpenVMS device name cannot be persistent. /DISABLE Allows you to disable device loading on a per-device basis. The following table describes the keywords LOAD and PERM:
Keyword Meaning Description LOAD Automatic loading Allows the device to be automatically configured---that is, the device driver is loaded and an OpenVMS device is created for it. PERM Automatic permanence Causes the UCM to add the device to the permanent database. Once a device is added to the permanent database, each time it is connected to the system it will have the driver loaded and the device name will always remain the same---that is, it will be persistent. By default, LOAD and PERM are enabled. Automatic permanence is ignored if automatic loading is disabled. However, you can enable automatic loading and disable automatic permanence. This allows devices to be configured but does not add them to the permanent database. (The OpenVMS device name might not be persistent in this case.)
/EXCLUDE=()
The /EXCLUDE and /INCLUDE qualifiers allow more explicit control over which devices will be automatically configured.
/INCLUDE=()You can give each qualifier one or more device names, or partial device names. When you provide a partial device name, the trailing characters are wildcarded. You can include an explicit wildcard character (such as an asterisk) to indicate all devices.
UCM examines the exclude list before automatically configuring a device that is not in the permanent database. If the device is on the exclude list, UCM examines the include list to determine whether the device is explicitly included for loading. This allows you to specify a broad range of devices in the exclude list and to specify a narrow set of devices in the include list (see the following example).
$ UCM UCM> SET AUTO/EXCLUDE=*/INCLUDE=(tx,dn) UCM> SHOW AUTO
|
In this example, all devices are excluded with the exception of TX and DN devices. For example, a joystick using AGA0 will not be configured, but a disk DNA0 will be configured, as will TXC2.
Tells the configuration server to create a new log file. You must use the /NEW qualifier with this command.Requires OPER privilege.
SET LOG /NEW
/NEW
Creates a new SYS$MANAGER:USB$UCM_EVENTS.DAT file. This qualifier is required with the SET LOG command.
Displays the current settings of auto-load, auto-perm, and any exclude or include lists.
SHOW AUTO
$ UCM
UCM> SHOW AUTO
|
AUTO LOAD ENABLED AUTO PERM ENABLED EXCLUDE = (*) INCLUDE = (TX, DN)This SHOW AUTO example indicates that all devices are excluded with the exception of TX and DN devices.
Displays information about devices.
SHOW DEVICE device-name:
device-name:
The name of the device whose characteristics are to be displayed. The device name has the form ddcu,where:
dd is the device code---for example, LP. (The driver name corresponds to the device code; in this case, the driver name would be SYS$LPDRIVER.) c is the controller designation A through Z; unless UCM specifies a different letter, all USB devices are A. u is the unit number (0 through 9999.) OpenVMS device names are made up of the two-character device code, followed by the controller designation, the unit number (which can be 1 to 4 characters long), and, finally, a colon (:).
/BRIEF (default)
Displays summary information for each device./FULL
Displays complete information for each device.
/ALL (default)
Displays all device entries, including those that the /CONFIGURED, /GENERIC, /PERMANENT, /PHYSICAL, and /UNCONFIGURED qualifiers display./CONFIGURED
Displays all the devices connected to the bus that have been configured successfully./GENERIC
Displays the devices that are on the generic device list./PERMANENT
Displays the devices for which the system automatically loads device drivers if the devices are plugged in./PHYSICAL
Displays the devices that are connected to the bus even if drivers for these devices are not loaded./UNCONFIGURED
Displays devices that are attached to the bus and that have drivers, but that do not have entries in the permanent list. (These are also known as tentative devices.)You must execute an ADD DEVICE command to make these devices part of the permanent list. Once the drivers have been added, the device is automatically configured the next time it is plugged in.
$ UCM
UCM> SHOW DEVICE /PERMANENT /FULL DNA3:
|
DEVICE DEVICE_TYPE PERMANENT DEVICE_NAME_ROOT DNA UNIT_NUMBER 3 DRIVER SYS$DNDRIVER.EXE USB_CONFIG_TYPE INTERFACE VENDOR_ID 3519 PRODUCT_ID 768 RELEASE_NUMBER 4352 BUS_NUMBER 1 PATH 1.0.0.0.0.0 DEVICE_CLASS 0 DEVICE_SUB_CLASS 0 DEVICE_PROTOCOL 0 NUMBER_OF_INTERFACES 1 CONFIGURATION_VALUE 2 NUMBER_OF_CONFIGURATIONS 1 SERIAL_NUMBER 2B0301060D97A4C8 MANUFACTURER_STRING QTS PRODUCT_STRING USB 2.0 ATAPI Bridge CONFIGURATION_NUMBER 0 BEGIN_INTERFACE INTERFACE_CLASS 8 INTERFACE_SUB_CLASS 6 INTERFACE_PROTOCOL 80 END_INTERFACE END_DEVICEIn this example, the SHOW DEVICE command displays complete information about DNA3:.
Displays important events that occur on the USB bus. Data displayed can include information about device events, such as removals, connections, unrecognized devices, new devices, and so on.
SHOW EVENTS
/BEFORE=time
Selects events that occurred before the specified time. You can specify time as an absolute time, as a combination of absolute and delta times, or as the keyword TODAY (default), TOMORROW, or YESTERDAY. Times are expressed in standard OpenVMS date/time format./OUTPUT=file-name
Writes the selected events to the specified file. By default, output is sent to the current SYS$OUTPUT device (usually your terminal).You cannot use the /OUTPUT qualifier with the /PAGE qualifier.
/PAGE
Controls how information is displayed. /PAGE displays events on one screen at a time.
/NOPAGE (default)You cannot use the /PAGE qualifier with the /OUTPUT qualifier.
/PRIORITY=(keyword[,...])
Selects the event priorities to display. By default, only CRITICAL aand NORMAL event priorities are displayed. Additional messages are available as INFORMATIONAL or debug priority information.The keywords in the following table are valid. CRITICAL and NORMAL are the defaults.
Keyword Description CRITICAL Errors and critical information NORMAL Normal event reports such as device configuration INFORMATIONAL Additional informational messages from drivers or UCM DBG1 Debug level 1 information DBG2 Debug level 2 information DBG3 Debug level 3 information ALL All event priorities /SINCE=time
Selects only those events that occurred on or after the specified time. You can specify time as absolute time, as a combination of absolute and delta times, or as the keyword TODAY (default) or YESTERDAY./TYPE=event-type
Selects only the specified type of events. Valid event-types are the following:
ALL All event-types (default). CONFIGURED Device was recognized and configured. DECONFIGURE Device was removed from the bus. DRIVER Driver events. UCM UCM server events. UNCONFIGURE Device was recognized but not configured. UNKNOWN Event type is unknown. /VALUE=event-number
Selects only the events specified by the event number. In a future version of this product, you will be able to use this qualifier as an alternative to the /TYPE qualifier for events that do not have an assigned keyword.
| #1 | |
|---|---|
$ UCM Universal Serial Bus Configuration Manager, Version V1.0 UCM> SHOW EVENTS
|
This example shows the configuration of a DIGI Edgeport 8-line serial multiplexer. Each line is displayed as the device is loaded and made permanent. The last line displays information related to a special driver that is the actual controller for the Edgeport (UCE0).
To display more device-specific information, use the /PRIORITY=INFORMATIONAL or /PRIORITY=ALL qualifier.
| #2 | |
|---|---|
$ UCM Universal Serial Bus Configuration Manager, Version V1.0 UCM> SHOW EVENTS/PRIOR=INFORMATIONAL
|
This SHOW EVENTS example displays /PRIORITY=INFORMATIONAL messages related to the configuration of the 8-port DIGI device from the previous example.
The information provided is usually not shown in order to reduce the amount of output for SHOW EVENTS. However, this information can be useful when you want to see specific information about a device that was configured.
| Previous | Next | Contents | Index |