|
HP OpenVMS Systems Documentation |
|
HP OpenVMS System Services Reference Manual
Note that for volumes mounted in a cluster, only the time of the initial mount is recorded; the time of any subsequent mount is not recorded. DVI$_MOUNTCNTReturns the mount count for the volume as an unsigned integer longword and displays the number of times the volume has been mounted on the local system.The value of MOUNTCNT displayed by the SHOW DEVICE command is the total of all mounts of the volume across all members of the cluster. DVI$_MOUNTVER_ELIGIBLEOn Alpha and Integrity server systems, returns an unsigned longword, which is interpreted as Boolean. A value of 1 indicates the volume is eligible to undergo mount verification. A volume mounted with either the /FOREIGN or /NOMOUNT_VERIFICATION qualifier is not subject to mount verification.DVI$_MPDEV_AUTO_PATH_SW_CNTOn Alpha and Integrity server systems, returns as an unsigned longword the number of times a multipath device has automatically switched paths due to an I/O error, or as the result of automatically "failing back" to a local path from a remote path after the local path became available.DVI$_MPDEV_CURRENT_PATHOn Alpha and Integrity server systems, returns the current path name for multipath devices as a string.If the device is not part of a multipath set, $GETDVI will return the name of the device path if the class driver for this device supports path names. SYS$DKDRIVER, SYS$DUDRIVER, SYS$MKDRIVER, and SYS$GKDRIVER support path names. If the class driver for the device does not support path names, $GETDVI returns a null string. DVI$_MPDEV_MAN_PATH_SW_CNTOn Alpha and Integrity server systems, returns as an unsigned longword the number of times a multipath device has manually switched paths due to a $SET DEVICE /PATH /SWITCH command or the use of the $SET_DEVICE system service.DVI$_MSCP_UNIT_NUMBERReturns the internal coded value for MSCP unit numbers as a longword integer. This item code is reserved to HP.DVI$_MT3_DENSITYReturns the density of the device. Valid for tapes only. This code is an unsigned longword integer.DVI$_MT3_SUPPORTEDThe return value of 1 indicates that the device supports tape density codes defined by MT3DEF. Valid for tapes only. This code is an unsigned longword integer.DVI$_MULTIPATHOn Alpha and Integrity server systems, returns a longword, interpreted as Boolean. A value of 1 indicates the device is a member of a multipath set.DVI$_MVSUPMSGOn Alpha and Integrity server systems, returns an unsigned longword, interpreted as Boolean. A value of 1 indicates that mount verification OPCOM messages are currently being suppressed on this device. See the MVSUPMSG_INTVL AND MVSUPMSG_NUM system parameters for more information on the suppression of mount verification messages.DVI$_NEXTDEVNAMReturns the device name of the next volume in the volume set as a string. The node name is also returned. This item code is applicable only to disks.DVI$_NOCACHE_ON_VOLUMEOn Alpha and Integrity server systems, returns an unsigned longword, which is interpreted as Boolean. A value of 1 indicates the volume is mounted with all caching disabled.DVI$_NOHIGHWATEROn Alpha and Integrity server systems, returns an unsigned longword, which is interpreted as Boolean. A value of 1 indicates that high-water marking is disabled on the volume.DVI$_NOSHARE_MOUNTEDOn Alpha and Integrity server systems, returns an unsigned longword, which is interpreted as Boolean. A value of 1 indicates the volume is mounted /NOSHARE.DVI$_NOXFCCACHE_ON_VOLUMEOn Alpha and Integrity server systems, returns a Boolean value indicating the XFC caching status of the volume. A value of 1 indicates that the XFC caching is disabled on the volume; a value of 0 indicates that the XFC caching is enabled on the volume.DVI$_ODS2_SUBSET0On Alpha and Integrity server systems, returns an unsigned longword, which is interpreted as Boolean. A value of 1 indicates the volume supports only a subset of the ODS-2 file structure.DVI$_ODS5On Alpha and Integrity server systems, returns an unsigned longword, which is interpreted as Boolean. A value of 1 indicates the volume is mounted ODS-5.DVI$_OPCNTReturns the operation count of the device as an unsigned longword. Note that the operation count might have been reset with the SET DEVICE/RESET=OPCNT command.On Alpha and Integrity server systems, this item code can be used with the PATHNAME parameter. If the PATHNAME parameter is omitted, the summation of the operation counts for all paths in a multipath device is returned (which was the behavior prior to the introduction of the PATHNAME parameter). If the PATHNAME parameter is specified, only the operation count for that path is returned. DVI$_OWNUICReturns the user identification code (UIC) of the owner of the device as a standard 4-byte UIC.DVI$_PATH_AVAILABLEOn Alpha and Integrity server systems, returns an unsigned longword, interpreted as Boolean. A value of 1 indicates the specified path is available.This item code is usually used with the PATHNAME parameter. If the PATHNAME parameter is omitted, information about the current path of the multipath device is returned. DVI$_PATH_NOT_RESPONDINGOn Alpha and Integrity server systems, returns an unsigned longword, interpreted as Boolean. A value of 1 indicates the specified path is marked as not responding.This item code is usually used with the PATHNAME parameter. If the PATHNAME parameter is omitted, information about the current path of the multipath device is returned. DVI$_PATH_POLL_ENABLEDOn Alpha and Integrity server systems, returns an unsigned longword, interpreted as Boolean. A value of 1 indicates that the specified path is enabled for multipath polling.This item code is usually used with the PATHNAME parameter. If the PATHNAME parameter is omitted, information about the current path of the multipath device is returned. DVI$_PATH_SWITCH_FROM_TIMEOn Alpha and Integrity server systems, returns the time from which this path was switched, either manually or automatically. Because the returned time is in the standard 64-bit absolute time format, specify 8 (bytes) for the buffer length field in the item descriptor.This item code is usually used with the PATHNAME parameter. If the PATHNAME parameter is omitted, information about the current path of the multipath device is returned. DVI$_PATH_SWITCH_TO_TIMEOn Alpha and Integrity server systems, returns the time to which this path was switched, either manually or automatically. Because the returned time is in the standard 64-bit absolute time format, specify 8 (bytes) for the buffer length field in the item descriptor.This item code is usually used with the PATHNAME parameter. If the PATHNAME parameter is omitted, information about the current path of the multipath device is returned. DVI$_PATH_USER_DISABLEDOn Alpha and Integrity server systems, returns an unsigned longword, interpreted as Boolean. A value of 1 indicates the specified path has been disabled using the $SET DEVICE /PATH /NOENABLE command.This item code is usually used with the PATHNAME parameter. If the PATHNAME parameter is omitted, information about the current path of the multipath device is returned. DVI$_PIDReturns the process identification (PID) of the owner of the device as an unsigned integer longword.DVI$_PREFERRED_CPUDo not use this item code. The service continues to return the correct data for systems with up to 64 CPUs but fails for systems with more than 64 CPUs. Use item code DVI$_PREFERRED_CPU_BITMAP instead.DVI$_PREFERRED_CPU_BITMAPOn Alpha and Integrity server systems, the return argument is a bitmap with a bit indicating the preferred CPU. A return argument containing a bit mask of zero indicates that no preferred CPU exists, either because Fast Path is disabled or the device is not a Fast Path capable device. The return argument serves as a CPU bitmap input argument to the $PROCESS_AFFINITY system service. The argument can be used to assign an application process to the optimal preferred CPU.The size of the returned bitmap is determined by the number of supported CPUs on the system. You can compute the number of bytes needed for the bitmap as follows: Use the $GETSYI system service with an item code of SYI$_MAX_CPUS to find the minimum number of bits needed, round this number up to a multiple of 64, and divide the result by 8. DVI$_PROT_SUBSYSTEM_ENABLEDOn Alpha and Integrity server systems, returns an unsigned longword, which is interpreted as Boolean. A value of 1 indicates the volume is mounted with protected subsystems enabled.DVI$_RECSIZReturns the blocked record size as an unsigned integer longword.DVI$_REFCNTReturns the number of channels assigned to the device as an unsigned integer longword.DVI$_REMOTE_DEVICEReturns a longword, which is interpreted as Boolean. A value of 1 indicates that the device is a remote device; a value of 0 indicates that it is not a remote device. A remote device is a device that is not directly connected to the local node, but instead is visible through the OpenVMS Cluster system.DVI$_ROOTDEVNAMReturns the device name of the root volume in the volume set as a string. This item code is applicable only to disks.DVI$_SCSI_DEVICE_FIRMWARE_REVOn Alpha and Integrity server systems, returns the firmware revision of a SCSI disk or SCSI tape as a four-character string. This item code is valid only for SCSI disks and SCSI tapes; a null string is returned for any other device.DVI$_SECTORSReturns the number of sectors per track as an unsigned integer longword. This item code is applicable only to disks.DVI$_SERIALNUMReturns the serial number of the volume as an unsigned integer longword. This item code is applicable only to disks.DVI$_SERVED_DEVICEReturns a longword, which is interpreted as Boolean. A value of 1 indicates that the device is a served device; a value of 0 indicates that it is not a served device. A served device is one whose local node makes it available to other nodes in the OpenVMS Cluster system.DVI$_SHDW_CATCHUP_COPYINGReturns a longword, which is interpreted as Boolean. The value 1 indicates that the device is the target of a full copy operation.DVI$_SHDW_COPIER_NODEOn Alpha and Integrity server systems, returns the name of the node that is actively performing either the copy or the merge operation, as a string.DVI$_SHDW_DEVICE_COUNTOn Alpha and Integrity server systems, returns the total number of devices in the virtual unit, including devices being added as copy targets, as a longword.DVI$_SHDW_GENERATIONOn Alpha and Integrity server systems, returns the current, internal revision number of the virtual unit, as a quadword.DVI$_SHDW_MASTERReturns a longword, which is interpreted as Boolean. The value 1 indicates that the device is a virtual unit named DSAnnnn:.DVI$_SHDW_MASTER_MBROn Alpha and Integrity server systems, returns the name of the master member device (as a string) that is used for merge and copy repair operations and for shadow set recovery operations.DVI$_SHDW_MASTER_NAMEWhen the specified device is a shadow set member, $GETDVI returns the device name of the virtual unit (DSAnnnn:) that represents the shadow set of which the specified device is a member. $GETDVI returns a null string if the specified device is not a member or is itself a virtual unit (DSAnnnn:).
DVI$_SHDW_MBR_COPY_DONEOn Alpha and Integrity server systems, returns the percentage of the copy operation that is complete on the current member unit, as a longword.DVI$_SHDW_MBR_COUNTOn Alpha and Integrity server systems, returns the number of full source members in the virtual unit, as a longword. Devices added as copy targets are not full source members.DVI$_SHDW_MBR_MERGE_DONEOn Alpha and Integrity server systems, returns the percentage of the merge operation that has been completed on the member, as a longword.DVI$_SHDW_MBR_READ_COSTOn Alpha and Integrity server systems, returns the current value set for the member unit, as a longword. This value can be modified to use a customer-specified value.DVI$_SHDW_MEMBERReturns a longword, which is interpreted as Boolean. The value 1 indicates that the device is a shadow set member.DVI$_SHDW_MERGE_COPYINGOn Alpha and Integrity server systems, returns a longword, which is interpreted as Boolean. The value 1 indicates that the device is a merge member of the shadow set.DVI$_SHDW_MINIMERGE_ENABLEOn Alpha and Integrity server systems, returns a longword, which is interpreted as Boolean. The value 1 indicates that, if a system in the cluster that has this device mounted crashes, the virtual unit will undergo a minimerge and not a full merge.DVI$_SHDW_NEXT_MBR_NAMEReturns the device name of the next member in the shadow set. If you specify a virtual unit with the chan or devnam argument, DVI$_SHDW_NEXT_MBR_NAME returns the device name of a member of a shadow set. If you specify the name of a shadow set member unit with the chan or devnam argument, DVI$_SHDW_NEXT_MBR_NAME returns the name of the next member unit or a null string if there are no more members.To determine all the members of a shadow set, first specify the virtual unit (DSAnnnn:) to $GETDVI. Then, on subsequent calls, specify the member name returned by the previous $GETDVI call until it returns a null member name. When the shadow set members have a nonzero allocation class, the device name returned by $GETDVI contains the allocation class; the name has the form $allocation-class$device. For example, if a shadow set has an allocation class of 255 and the device name is DUA42, $GETDVI returns the string $255$DUA42.
DVI$_SHDW_READ_SOURCEOn Alpha and Integrity server systems, returns the name of the member device that is used for reads, at this point in time, as a string. DVI$_SHDW_READ_SOURCE uses the unit that has the lowest value of the sum of its queue length and read cost for reads. This is a dynamic value.DVI$_SHDW_TIMEOUTOn Alpha and Integrity server systems, returns the customer-specified timeout value set for the device, as a longword.If you do not set a value using the SETSHOWSHADOW utility, the SYSGEN parameter SHADOW_MBR_TWO is used for member units and MVTIMEOUT is used for virtual units. DVI$_SPECIAL_FILESIf the item code DVI$_SPECIAL_FILES is set to 1, special files are enabled. When it is set to 0, special files are disabled.DVI$_STSReturns the device unit status as a 4-byte bit vector. Each bit in the vector, when set, corresponds to a symbolic name that is defined by the $UCBDEF macro. The following table describes each name:
DVI$_TOTAL_PATH_COUNTOn Alpha and Integrity server systems, the number of paths for a multipath-capable device returns as an unsigned longword.DVI$_TRACKSReturns the number of tracks per cylinder as an unsigned integer longword. This item code is applicable only to disks.DVI$_TRANSCNTReturns the transaction count for the volume as an unsigned integer longword.DVI$_QLENOn Alpha and Integrity server systems, returns the queue length for the device as an unsigned integer longword. Note that this value is the number of I/O requests already in the driver and not the depth of the I/O pending queue.DVI$_TT_ACCPORNAMReturns the name of the remote access port associated with a channel number or with a physical or virtual terminal device number. If you specify a device that is not a remote terminal or a remote type that does not support this feature, $GETDVI returns a null string. The $GETDVI service returns the access port name as a string. HP recommends a buffer size of 64 bytes to return the name of the remote access port.The $GETDVI service returns the name in the format of the remote system. If the remote system is a LAT terminal server, $GETDVI returns the name as server_name/port_name. The names are separated by the slash (/) character. If the remote system is an X.29 terminal, the name is returned as network.remote_DTE. For devices using TCP/IP, the name is returned in the format Host: 192.168.1.100 Port: 1. When writing applications, use the string returned by DVI$_ACCPORNAM (instead of the physical device name) to identify remote terminals. DVI$_TT_CHARSETReturns, as a 4-byte bit vector, the character sets supported by the terminal. Each bit in the vector, when set, corresponds to the name of a coded character set. The $TTCDEF macro defines the following coded character sets:
DVI$_TT_CS_HANGULReturns a longword, which is interpreted as Boolean. A value of 1 indicates that the device supports the DEC Korean coded character set; a value of 0 indicates that the device does not support the DEC Korean coded character set.DVI$_TT_CS_HANYUReturns a longword, which is interpreted as Boolean. A value of 1 indicates that the device supports the DEC Hanyu coded character set; a value of 0 indicates that the device does not support the DEC Hanyu coded character set.DVI$_TT_CS_HANZIReturns a longword, which is interpreted as Boolean. A value of 1 indicates that the device supports the DEC Hanzi coded character set; a value of 0 indicates that the device does not support the DEC Hanzi coded character set.DVI$_TT_CS_KANAReturns a longword, which is interpreted as Boolean. A value of 1 indicates that the device supports the DEC Kana coded character set; a value of 0 indicates that the device does not support the DEC Kana coded character set.DVI$_TT_CS_KANJIReturns a longword, which is interpreted as Boolean. A value of 1 indicates that the device supports the DEC Kanji coded character set; a value of 0 indicates that the device does not support the DEC Kanji coded character set.DVI$_TT_CS_THAIReturns a longword, which is interpreted as Boolean. A value of 1 indicates that the device supports the DEC Thai coded character set; a value of 0 indicates that the device does not support the DEC Thai coded character set.DVI$_TT_PHYDEVNAMReturns a string containing the physical device name of a terminal. If the caller specifies a disconnected virtual terminal or a device that is not a terminal, $GETDVI returns a null string. $GETDVI returns the physical device name as a string.DVI$_UNITReturns the unit number as an unsigned longword.DVI$_VOLCHAROn Alpha and Integrity server systems, returns a 128-bit string (16 bytes) that represents the volume characteristics or capabilities of the mounted device. If a bit is set, the volume is capable of performing the function.DVI$_VOLCOUNTReturns the number of volumes in the volume set as an unsigned longword. This item code is applicable only to disks.DVI$_VOLNAMReturns the volume name as a string.DVI$_VOLNUMBERReturns the volume number of this volume in the volume set as an unsigned integer longword. This item code is applicable only to disks.DVI$_VOLSETMEMReturns a longword, which is interpreted as Boolean. A value of 1 indicates that the device is part of a volume set; a value of 0 indicates that it is not. This item code is applicable only to disks.DVI$_VOLSIZEOn Alpha and Integrity server systems, returns the current logical volume size of the volume as an unsigned integer longword.DVI$V_VOL_SPECIAL_FILEIf the item code DVI$V_VOL_SPECIAL_FILE is set to 1, special files are enabled. When the item code is set to 0, special files are disabled.The DVI$_VOLCHAR item code supports DVI$V_VOL_SPECIAL_FILE when the latter is set to 1. DVI$_VOLUME_EXTEND_QUANTITYOn Alpha and Integrity server systems, returns the number of blocks to be used as the default extension size for all files on the volume as an unsigned longword.DVI$_VOLUME_MOUNT_GROUPOn Alpha and Integrity server systems, returns an unsigned longword, interpreted as Boolean. A value of 1 indicates the volume is mounted /GROUP.DVI$_VOLUME_MOUNT_SYSOn Alpha and Integrity server systems, returns an unsigned longword, interpreted as Boolean. A value of 1 indicates the volume is mounted /SYSTEM.DVI$_VOLUME_PENDING_WRITE_ERROn Alpha and Integrity server systems, returns the count of pending write errors on the volume as an unsigned longword.DVI$_VOLUME_RETAIN_MAXOn Alpha and Integrity server systems, returns the maximum retention time for the volume as specified with the DCL command SET VOLUME/RETENTION. Because the returned time is in the standard 64-bit absolute time format, specify 8 bytes for the buffer length field in the item descriptor.DVI$_VOLUME_RETAIN_MINOn Alpha and Integrity server systems, returns the minimum retention time for the volume, as specified with the DCL command bit SET VOLUME/RETENTION. Because the returned time is in the standard 64-bit absolute time format, specify 8 bytes for the buffer length field in the item descriptor.DVI$_VOLUME_SPOOLED_DEV_CNTOn Alpha and Integrity server systems, returns the number of devices spooled to the volume as an unsigned longword.DVI$_VOLUME_WINDOWOn Alpha and Integrity server systems, returns the volume default window size as an unsigned longword.DVI$_VPROTReturns the volume protection mask as a standard 4-byte protection mask.DVI$_TT_xxxxDVI$_TT_xxxx is the format for a series of item codes that return information about terminals. This information consists of terminal characteristics. The xxxx portion of the item code name specifies a single terminal characteristic.Each of these item codes requires that the buffer specify a longword into which $GETDVI will write a 0 or 1: 0 if the terminal does not have the specified characteristic, and 1 if the terminal does have it. The one exception is the DVI$_TT_PAGE item code, which when specified causes $GETDVI to return a decimal longword value that is the page size of the terminal. You can also obtain this terminal-specific information by using the DVI$_DEVDEPEND and DVI$_DEVDEPEND2 item codes. Each of these two item codes specifies a longword bit vector wherein each bit corresponds to a terminal characteristic; $GETDVI sets the corresponding bit for each characteristic possessed by the terminal. Following is a list of the item codes that return information about terminal characteristics. For information about these characteristics, see the description of the F$GETDVI lexical function in the HP OpenVMS DCL Dictionary.
DVI$_WRITETHRU_CACHE_ENABLEDOn Alpha and Integrity server systems, returns an unsigned longword, which is interpreted as Boolean. A value of 1 indicates the volume is mounted with write-through caching enabled.DVI$_WWIDOn Alpha and Integrity server systems, returns the World Wide Identifier (WWID) of Fibre Channel Disk and Tape devices as a string. The maximum length of this string might change with new devices; therefore, HP recommends that a 380-byte buffer be passed to this function.DVI$_XFC_DEPOSINGOn Alpha and Integrity server systems, returns a Boolean value indicating whether the XFC volume depose operation is in progress or not. A value of 1 indicates that the XFC volume depose operation is in progress; a value of 0 indicates that the XFC volume depose operation is not in progress.DVI$_yyyyDVI$_yyyy is the format for a series of item codes that return device-independent characteristics of a device. There is an item code for each device characteristic returned in the longword bit vector specified by the DVI$_DEVCHAR item code.
|