Difference between revisions of "F$GETDVI()"

From VSI OpenVMS Wiki
Jump to: navigation, search
(Created page with "'''F$GETDVI()''' is a [Lexical functions|lexical function] that returns information about a specified device. =Format= F$GETDVI(device-name,item[,pathname]) ==device-name=...")
 
 
(14 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
'''F$GETDVI()''' is a [Lexical functions|lexical function] that returns information about a specified device.  
+
'''F$GETDVI()''' is a [[Lexical functions|lexical function]] that returns information about a specified device.  
  
 
=Format=
 
=Format=
Line 7: Line 7:
 
==device-name==
 
==device-name==
  
−
Specifies a physical device name or a logical name equated to a physical device name. Specify the device name as a character string expression.
+
Specifies a physical device name or a [[Logical Name|logical name]] equated to a physical device name. Specify the device name as a character string expression.
  
−
After the device-name argument is evaluated, the F$GETDVI function examines the first character of the name. If the first character is an underscore (_), the name is considered a physical device name; otherwise, a single level of [[Logical names|logical name]] translation is performed and the equivalence name, if any, is used.
+
After the device-name argument is evaluated, the F$GETDVI function examines the first character of the name. If the first character is an underscore (_), the name is considered a physical device name; otherwise, a single level of [[Logical Name|logical name]] translation is performed and the equivalence name, if any, is used.
  
 
==item==
 
==item==
Line 24: Line 24:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Item !! Value returned !! Description
+
! Item !! Value Returned !! Description
 
|-
 
|-
−
| CONCEALED|| String|| TRUE or FALSE to indicate whether the logical device name translates to a concealed device.
+
| CONCEALED|| style="text-align:center;" | String || TRUE or FALSE to indicate whether the [[Logical name|logical device name]] translates to a [[Concealed logical|concealed]] device.
 
|}
 
|}
  
Line 33: Line 33:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Item !! Value returned !! Description
+
! Item !! Value Returned !! Description
 
|-
 
|-
−
| ACCESSTIMES_RECORDED || String || TRUE or FALSE to indicate whether the volume supports the recording of access times  
+
| ACCESSTIMES_RECORDED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume supports the recording of access times  
 
|-
 
|-
−
| CLUSTER || Integer || Volume cluster size  
+
| CLUSTER || style="text-align:center;" | Integer || Volume cluster size  
 
|-
 
|-
−
| CYLINDERS || Integer || Number of cylinders on the volume (disks only)  
+
| CYLINDERS || style="text-align:center;" | Integer || Number of cylinders on the volume (disks only)  
 
|-
 
|-
−
| DIR || String || TRUE or FALSE to indicate whether the device is directory structured  
+
| DIR || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is directory structured  
 
|-
 
|-
−
| EXPSIZE || Integer || Current expansion limit on the volume  
+
| EXPSIZE || style="text-align:center;" | Integer || Current [[Volume expansion limit|expansion limit]] on the volume  
 
|-
 
|-
−
| ERASE_ON_DELETE || String|| TRUE or FALSE to indicate whether disk blocks are zeroed upon file deletion on the volume.
+
| ERASE_ON_DELETE || style="text-align:center;" | String || TRUE or FALSE to indicate whether disk blocks are zeroed upon file deletion on the volume.
 
|-
 
|-
−
| FREEBLOCKS || Integer|| Number of free blocks on the volume (disks only)
+
| FREEBLOCKS || style="text-align:center;" | Integer || Number of free blocks on the volume (disks only)
 
|-
 
|-
−
| HARDLINKS_SUPPORTED || String|| TRUE or FALSE to indicate whether hardlinks, rather than aliases, are supported on the volume
+
| HARDLINKS_SUPPORTED || style="text-align:center;" | String || TRUE or FALSE to indicate whether [[Hardlink|Hardlinks]], rather than [[Alias|aliases]], are supported on the volume
 
|-
 
|-
−
| LOGVOLNAM || String|| Logical volume name
+
| LOGVOLNAM || style="text-align:center;" | String || Logical volume name
 
|-
 
|-
−
| MAXBLOCK || Integer || Number of logical blocks on the volume
+
| MAXBLOCK || style="text-align:center;" | Integer || Number of [[Logical block|logical blocks]] on the volume
 
|-
 
|-
−
| MAXFILES || Integer || Maximum number of files on the volume
+
| MAXFILES || style="text-align:center;" | Integer || Maximum number of files on the volume
 
|-
 
|-
−
| NEXTDEVNAM || String || Device name of the next volume in a volume set
+
| NEXTDEVNAM || style="text-align:center;" | String || Device name of the next volume in a [[Volume set|volume set]]
 
|-
 
|-
−
| ROOTDEVNAM || String || Device name of the root volume in a volume set (disks only)
+
| ROOTDEVNAM || style="text-align:center;" | String || Device name of the root volume in a volume set (disks only)
 
|-
 
|-
−
| NOCACHE_ON_VOLUME || String|| TRUE or FALSE to indicate whether the volume is mounted with all caching disabled
+
| NOCACHE_ON_VOLUME || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is mounted with all caching disabled
 
|-
 
|-
−
| NOHIGHWATER || String || TRUE or FALSE to indicate whether high-water marking is disabled on the volume
+
| NOHIGHWATER || style="text-align:center;" | String || TRUE or FALSE to indicate whether [[High-water marking|high-water marking]] is disabled on the volume
 
|-
 
|-
−
| NOSHARE_MOUNTED || String || TRUE or FALSE to indicate whether the volume is mounted with /NOSHARE
+
| NOSHARE_MOUNTED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is mounted with /NOSHARE
 
|-
 
|-
−
| NOXFCCACHE_ON_VOLUME || String || TRUE or FALSE to indicate whether the XFC caching is disabled on the volume
+
| NOXFCCACHE_ON_VOLUME || style="text-align:center;" | String || TRUE or FALSE to indicate whether the XFC caching is disabled on the volume
 
|-
 
|-
−
| ODS2_SUBSET0 || String || TRUE or FALSE to indicate whether the volume mounted supports only a subset of the ODS-2 file structure
+
| ODS2_SUBSET0 || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume mounted supports only a subset of the [[ODS-2]] file structure
 
|-
 
|-
−
| ODS5 || String || TRUE or FALSE to indicate whether the volume is mounted ODS-5
+
| ODS5 || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is mounted [[ODS-5]]
 
|-
 
|-
−
| SDI || String || TRUE or FALSE to indicate whether the device is single-directory structured
+
| SDI || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is single-directory structured
 
|-
 
|-
−
| SECTORS || Integer || Number of sectors per track (disks only)
+
| SECTORS || style="text-align:center;" | Integer || Number of sectors per track (disks only)
 
|-
 
|-
−
| SERIALNUM || Integer || Volume serial number (disks only)
+
| SERIALNUM || style="text-align:center;" | Integer || Volume serial number (disks only)
 
|-
 
|-
−
| TRACKS || Integer || Number of tracks per cylinder (disks only)
+
| TRACKS || style="text-align:center;" | Integer || Number of tracks per cylinder (disks only)
 
|-
 
|-
−
| TRANSCNT || Integer || Volume transaction count
+
| TRANSCNT || style="text-align:center;" | Integer || Volume [[Transaction count|transaction count]]
 
|-
 
|-
−
| VOLCHAR || String || 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
+
| VOLCHAR || style="text-align:center;" | String || 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
 
|-
 
|-
−
| VOLCOUNT || Integer || The count of volumes in a volume set (disks only)
+
| VOLCOUNT || style="text-align:center;" | Integer || The count of volumes in a volume set (disks only)
 
|-
 
|-
−
| VOLNAM || String || The volume name
+
| VOLNAM || style="text-align:center;" | String || The volume name
 
|-
 
|-
−
| VOLNUMBER || Integer || Number of the current volume in a volume set (disks only)
+
| VOLNUMBER || style="text-align:center;" | Integer || Number of the current volume in a volume set (disks only)
 
|-
 
|-
−
| VOLSETMEM || String || TRUE or FALSE to indicate whether the device is a volume set (disks only)
+
| VOLSETMEM || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a volume set (disks only)
 
|-
 
|-
−
| VOLSIZE || Integer || The volume's current logical volume size
+
| VOLSIZE || style="text-align:center;" | Integer || The volume's current logical volume size
 
|-
 
|-
−
| VOLUME_EXTEND_QUANTITY || Integer || Number of blocks to be used as the default extension size for all files on the volume
+
| VOLUME_EXTEND_QUANTITY || style="text-align:center;" | Integer || Number of blocks to be used as the default extension size for all files on the volume
 
|-
 
|-
−
| VOLUME_MOUNT_GROUP || String || TRUE or FALSE to indicate whether the volume is mounted /GROUP
+
| VOLUME_MOUNT_GROUP || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is mounted /GROUP
 
|-
 
|-
−
| VOLUME_MOUNT_SYS || String || TRUE or FALSE to indicate whether the volume is mounted /SYSTEM
+
| VOLUME_MOUNT_SYS || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is mounted /SYSTEM
 
|-
 
|-
−
| VOLUME_PENDING_WRITE_ERR || строка || The number of pending write errors on the volume
+
| VOLUME_PENDING_WRITE_ERR || style="text-align:center;" | String || The number of pending write errors on the volume
 
|-
 
|-
−
| VOLUME_RETAIN_MAX || String || The maximum retention time for the volume, as specified with the DCL command SET VOLUME/RETENTION
+
| VOLUME_RETAIN_MAX || style="text-align:center;" | String || The maximum retention time for the volume, as specified with the DCL command SET VOLUME/RETENTION
 
|-
 
|-
−
| VOLUME_RETAIN_MIN || String || The minimum retention time for the volume, as specified with the DCL command SET VOLUME/RETENTION
+
| VOLUME_RETAIN_MIN || style="text-align:center;" | String || The minimum retention time for the volume, as specified with the DCL command SET VOLUME/RETENTION
 
|-
 
|-
−
| VOLUME_SPOOLED_DEV_CNT || Integer|| The number of devices spooled to the volume
+
| VOLUME_SPOOLED_DEV_CNT || style="text-align:center;" | Integer || The number of devices [[Spooling|spooled]] to the volume
 
|-
 
|-
−
| VOLUME_WINDOW || Integer || The default window size for the volume
+
| VOLUME_WINDOW || style="text-align:center;" | Integer || The default window size for the volume
 
|-
 
|-
−
| VPROT || String || The volume protection mask
+
| VPROT || style="text-align:center;" | String || The volume [[Protection mask|protection mask]]
 
|-
 
|-
−
| WRITETHRU_CACHE_ENABLED || String || TRUE or FALSE to indicate whether the volume is mounted with write through caching enabled
+
| WRITETHRU_CACHE_ENABLED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is mounted with [[Write-through caching|write through caching]] enabled
 
|}
 
|}
  
Line 119: Line 119:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Item !! Value returned !! Description
+
! Item !! Value Returned !! Description
 
|-
 
|-
−
| MT3_DENSITY || String || Current density of the device
+
| MT3_DENSITY || style="text-align:center;" | String || Current density of the device
 
|-
 
|-
−
| MT3_SUPPORTED || String || TRUE or FALSE to indicate whether the device supports densities defined in the MT3DEF (for Alpha tapes only)
+
| MT3_SUPPORTED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device supports densities defined in MT3DEF (for Alpha tapes only)
 
|-
 
|-
−
| SQD || String || TRUE or FALSE to indicate whether the device is sequential block-oriented
+
| SQD || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is sequential block-oriented
 
|}
 
|}
  
Line 131: Line 131:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Item !! Value returned !! Description
+
! Item !! Value Returned !! Description
 
|-
 
|-
−
| FC_HBA_FIRMWARE_REV || String || Firmware revision information of a Fibre Channel host bus adapter. A null string is returned for all other devices
+
| FC_HBA_FIRMWARE_REV || style="text-align:center;" | String || Firmware revision information of a Fibre Channel host bus adapter. A null string is returned for all other devices
 
|-
 
|-
−
| FC_NODE_NAME || String || The Fibre Channel host bus adapter node name
+
| FC_NODE_NAME || style="text-align:center;" | String || The Fibre Channel host bus adapter node name
 
|-
 
|-
−
| FC_PORT_NAME || String || The Fibre Channel host bus adapter node name
+
| FC_PORT_NAME || style="text-align:center;" | String || The Fibre Channel host bus adapter node name
 
|-
 
|-
−
| WWID || String || Worldwide Identifier for a Fibre Channel device
+
| WWID || style="text-align:center;" | String || Worldwide Identifier for a Fibre Channel device
 
|}
 
|}
  
Line 145: Line 145:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Item !! Value returned !! Description
+
! Item !! Value Returned !! Description
 
|-
 
|-
−
| SCSI_DEVICE_FIRMWARE_REV || String || Firmware revision number of a SCSI disk or SCSI tape. A null string is returned for any other device
+
| SCSI_DEVICE_FIRMWARE_REV || style="text-align:center;" | String || Firmware revision number of a SCSI disk or SCSI tape. A null string is returned for any other device
 
|}
 
|}
  
Line 153: Line 153:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Item !! Value returned !! Description
+
! Item !! Value Returned !! Description
 
|-
 
|-
−
| SHDW_CATCHUP_COPYING || String || TRUE or FALSE to indicate whether the device is a member that is the target of a full copy operation
+
| SHDW_CATCHUP_COPYING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a member that is the target of a full copy operation
 
|-
 
|-
−
| SHDW_COPIER_NODE || String || The name of the node that is actively performing the copy or merge operation
+
| SHDW_COPIER_NODE || style="text-align:center;" | String || The name of the node that is actively performing the copy or merge operation
 
|-
 
|-
−
| SHDW_DEVICE_COUNT || Integer || The total number of devices in the virtual unit, including devices being added as copy targets
+
| SHDW_DEVICE_COUNT || style="text-align:center;" | Integer || The total number of devices in the virtual unit, including devices being added as copy targets
 
|-
 
|-
−
| SHDW_GENERATION || String || The current internal revision number for the virtual unit. This value is subject to change
+
| SHDW_GENERATION || style="text-align:center;" | String || The current internal revision number for the virtual unit. This value is subject to change
 
|-
 
|-
−
| SHDW_MASTER || String || TRUE or FALSE to indicate whether the device is a virtual unit
+
| SHDW_MASTER || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a virtual unit
 
|-
 
|-
−
| SHDW_MASTER_MBR || String || The name of the master member unit that will be used for merge and copy repair operations and for shadow set recovery operations
+
| SHDW_MASTER_MBR || style="text-align:center;" | String || The name of the master member unit that will be used for merge and copy repair operations and for shadow set recovery operations
 
|-
 
|-
−
| SHDW_MASTER_NAME || String || Device name of the virtual unit that represents the shadow set of which the specified device is a member. F$GETDVI returns a null string ("") if the specified device is not a member, or is itself a virtual unit
+
| SHDW_MASTER_NAME || style="text-align:center;" | String || Device name of the virtual unit that represents the shadow set of which the specified device is a member. F$GETDVI returns a null string ("") if the specified device is not a member, or is itself a virtual unit
 
|-
 
|-
−
| SHDW_MBR_COPY_DONE || String || The percent of the copy operation completed on this member unit
+
| SHDW_MBR_COPY_DONE || style="text-align:center;" | String || The percentage of the copy operation completed on this member unit
 
|-
 
|-
−
| SHDW_MBR_COUNT || Integer || The number of full source members in the virtual unit. Devices being added as copy targets are not full source members
+
| SHDW_MBR_COUNT || style="text-align:center;" | Integer || The number of full source members in the virtual unit. Devices being added as copy targets are not full source members
 
|-
 
|-
−
| SHDW_MBR_MERGE_DONE || String || The percent of the merge operation completed on this member unit
+
| SHDW_MBR_MERGE_DONE || style="text-align:center;" | String || The percentage of the merge operation completed on this member unit
 
|-
 
|-
−
| SHDW_MBR_READ_COST || String || The current value set for the member unit. This value can be modified to use a user-specified value
+
| SHDW_MBR_READ_COST || style="text-align:center;" | String || The current value set for the member unit. This value can be modified to use a user-specified value
 
|-
 
|-
−
| SHDW_MEMBER || String || TRUE or FALSE to indicate whether the device is a shadow set member
+
| SHDW_MEMBER || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a shadow set member
 
|-
 
|-
−
| SHDW_MERGE_COPYING || String || TRUE or FALSE to indicate whether the device is a merge member of the shadow set
+
| SHDW_MERGE_COPYING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a merge member of the shadow set
 
|-
 
|-
−
| SHDW_MINIMERGE_ENABLE || String || A value of TRUE indicates that the virtual unit will undergo a mini-merge, not a full merge, if a system in the cluster crashes
+
| SHDW_MINIMERGE_ENABLE || style="text-align:center;" | String || A value of TRUE indicates that the virtual unit will undergo a mini-merge, not a full merge, if a system in the cluster crashes
 
|-
 
|-
−
| SHDW_NEXT_MBR_NAME || String || Device name of the next member in the shadow set. If you specify a virtual unit, F$GETDVI returns the device name of a member of the shadow set. If you specify the name of a shadow set member unit with the device name and item arguments, F$GETDVI 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 to F$GETDVI; on subsequent calls, specify the member name returned by the previous F$GETDVI call until it has finished, when it returns a null member name. The device name includes the allocation class if the allocation class is not zero; otherwise it includes the device name of the disk controller
+
| SHDW_NEXT_MBR_NAME || style="text-align:center;" | String || Device name of the next member in the shadow set. If you specify a virtual unit, F$GETDVI returns the device name of a member of the shadow set. If you specify the name of a shadow set member unit with the device name and item arguments, F$GETDVI 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 to F$GETDVI; on subsequent calls, specify the member name returned by the previous F$GETDVI call until it has finished, when it returns a null member name. The device name includes the allocation class if the allocation class is not zero; otherwise it includes the device name of the disk controller
 
|-
 
|-
−
| SHDW_READ_SOURCE || String || The name of the member unit that will be used for reads at this time. The unit with the lowest sum total of its queue length and read cost is used. This is a dynamic value
+
| SHDW_READ_SOURCE || style="text-align:center;" | String || The name of the member unit that will be used for reads at this time. The unit with the lowest sum total of its queue length and read cost is used. This is a dynamic value
 
|-
 
|-
−
| SHDW_SITE || Integer || The site value for the specified device. This value is set by the SET DEVICE or SET SHADOW command
+
| SHDW_SITE || style="text-align:center;" | Integer || The site value for the specified device. This value is set by the SET DEVICE or SET SHADOW command
 
|-
 
|-
−
| SHDW_TIMEOUT || Integer || The user-specified timeout value set for the device. If the user has not set a value by using the SETSHOSHADOW utility, the value of the SYSGEN parameter SHADOW_MBR_TMO is used for member units and the value of MVTIMEOUT is used for virtual units
+
| SHDW_TIMEOUT || style="text-align:center;" | Integer || The user-specified timeout value set for the device. If the user has not set a value by using the SETSHOSHADOW utility, the value of the SYSGEN parameter SHADOW_MBR_TMO is used for member units and the value of [[MVTIMEOUT]] is used for virtual units
 
|}
 
|}
  
Line 195: Line 195:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Item !! Value returned !! Description
+
! Item !! Value Returned !! Description
 
|-
 
|-
−
| MULTIPATH || String || TRUE or FALSE to indicate whether the device is a member of a multipath set
+
| MULTIPATH || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a member of a multipath set
 
|-
 
|-
−
| ALT_HOST_AVAIL || String || TRUE or FALSE to indicate whether the host serving the alternate path is available
+
| ALT_HOST_AVAIL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the host serving the alternate path is available
 
|-
 
|-
−
| ALT_HOST_NAME || String || Name of the host serving the alternate path
+
| ALT_HOST_NAME || style="text-align:center;" | String || Name of the host serving the alternate path
 
|-
 
|-
−
| ALT_HOST_TYPE || String || Hardware type of the host serving the alternate path
+
| ALT_HOST_TYPE || style="text-align:center;" | String || Hardware type of the host serving the alternate path
 
|-
 
|-
−
| AVAILABLE_PATH_COUNT || Integer || Number of available, working paths for a multipath-capable device
+
| AVAILABLE_PATH_COUNT || style="text-align:center;" | Integer || Number of available, working paths for a multipath-capable device
 
|-
 
|-
−
| HOST_AVAIL || String || TRUE or FALSE to indicate whether the host serving the primary path is available
+
| HOST_AVAIL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the host serving the primary path is available
 
|-
 
|-
−
| HOST_COUNT || Integer || Number of hosts that make the device available to other nodes in the OpenVMS Cluster
+
| HOST_COUNT || style="text-align:center;" | Integer || Number of hosts that make the device available to other nodes in the OpenVMS Cluster
 
|-
 
|-
−
| HOST_NAME || String || Name of the host serving the primary path
+
| HOST_NAME || style="text-align:center;" | String || Name of the host serving the primary path
 
|-
 
|-
−
| HOST_TYPE || String || Hardware type of the host serving the primary path
+
| HOST_TYPE || style="text-align:center;" | String || Hardware type of the host serving the primary path
 
|-
 
|-
−
| MPDEV_AUTO_PATH_SW_CNT || Integer || Number of times a multipath device has automatically switched paths because of an I/O error or as the result of automatically "failing back" to a local path from a remote path once the local path became available
+
| MPDEV_AUTO_PATH_SW_CNT || style="text-align:center;" | Integer || Number of times a multipath device has automatically switched paths because of an I/O error or as the result of automatically "failing back" to a local path from a remote path once the local path became available
 
|-
 
|-
−
| MPDEV_CURRENT_PATH || String || Current path name for multipath devices. If the device is not part of a multipath set, this lexical returns 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. Returns a null string if the class driver for the device does not support path names
+
| MPDEV_CURRENT_PATH || style="text-align:center;" | String || Current path name for multipath devices. If the device is not part of a multipath set, this lexical returns 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. Returns a null string if the class driver for the device does not support path names
 
|-
 
|-
−
| MPDEV_MAN_PATH_SW_CNT || Integer || Number of times a multipath device has manually switched paths because of a SET DEVICE /PATH /SWITCH command or use of the $SET_DEVICE system service
+
| MPDEV_MAN_PATH_SW_CNT || style="text-align:center;" | Integer || Number of times a multipath device has manually switched paths because of a SET DEVICE /PATH /SWITCH command or use of the $SET_DEVICE system service
 
|-
 
|-
−
| PATH_AVAILABLE || String || TRUE or FALSE to indicate whether the specified path is available. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
+
| PATH_AVAILABLE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the specified path is available. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
 
|-
 
|-
−
| PATH_NOT_RESPONDING || String || TRUE or FALSE to indicate whether the specified path is marked as not responding. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
+
| PATH_NOT_RESPONDING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the specified path is marked as not responding. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
 
|-
 
|-
−
| PATH_POLL_ENABLED || String || TRUE or FALSE to indicate whether the specified path is enabled for multipath polling. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
+
| PATH_POLL_ENABLED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the specified path is enabled for multipath polling. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
 
|-
 
|-
−
| PATH_SWITCH_FROM_TIME || String || Time from which this path was switched, either manually or automatically. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
+
| PATH_SWITCH_FROM_TIME || style="text-align:center;" | String || Time from which this path was switched, either manually or automatically. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
 
|-
 
|-
−
| PATH_SWITCH_TO_TIME || String || Time to which this path was switched, either manually or automatically. This item code is typically used with the pathname parameter. If thepathname parameter is omitted, information about the current path of the multipath device is returned
+
| PATH_SWITCH_TO_TIME || style="text-align:center;" | String || Time to which this path was switched, either manually or automatically. This item code is typically used with the pathname parameter. If thepathname parameter is omitted, information about the current path of the multipath device is returned
 
|-
 
|-
−
| PATH_USER_DISABLED || String || TRUE or FALSE to indicate whether the specified path has been disabled using the SET DEVICE /PATH /NOENABLE command. This item code is typically used with the pathname parameter. If thepathname parameter is omitted, information about the current path of the multipath device is returned
+
| PATH_USER_DISABLED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the specified path has been disabled using the SET DEVICE /PATH /NOENABLE command. This item code is typically used with the pathname parameter. If thepathname parameter is omitted, information about the current path of the multipath device is returned
 
|-
 
|-
−
| TOTAL_PATH_COUNT || Integer || Number of paths for a multipath-capable device
+
| TOTAL_PATH_COUNT || style="text-align:center;" | Integer || Number of paths for a multipath-capable device
 
|}
 
|}
  
Line 239: Line 239:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Item !! Value returned !! Description
+
! Item !! Value Returned !! Description
 
|-
 
|-
−
| NET || String || TRUE or FALSE to indicate whether the device is a network device
+
| NET || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a network device
 
|-
 
|-
−
| LAN_ALL_MULTICAST_MODE || String || TRUE or FALSE to indicate whether the device is enabled to receive all multicast packets rather than only packets addressed to enabled multicast addresses
+
| LAN_ALL_MULTICAST_MODE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is enabled to receive all multicast packets rather than only packets addressed to enabled multicast addresses
 
|-
 
|-
−
| LAN_AUTONEG_ENABLED || String || TRUE or FALSE to indicate whether the device is set to autonegotiate the speed and duplex settings
+
| LAN_AUTONEG_ENABLED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is set to autonegotiate the speed and duplex settings
 
|-
 
|-
−
| LAN_DEFAULT_MAC_ADDRESS || String || The default MAC (media access control) address of the device
+
| LAN_DEFAULT_MAC_ADDRESS || style="text-align:center;" | String || The default MAC (media access control) address of the device
 
|-
 
|-
−
| LAN_FULL_DUPLEX || String || TRUE or FALSE to indicate whether the device is operating in full-duplex mode
+
| LAN_FULL_DUPLEX || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is operating in full-duplex mode
 
|-
 
|-
−
| LAN_JUMBO_FRAMES_ENABLED || String || TRUE or FALSE to indicate whether jumbo frames are enabled on the device
+
| LAN_JUMBO_FRAMES_ENABLED || style="text-align:center;" | String || TRUE or FALSE to indicate whether jumbo frames are enabled on the device
 
|-
 
|-
−
| LAN_LINK_STATE_VALID || String || TRUE or FALSE to indicate whether or not the device driver for the LAN device correctly maintains the link status. The device drivers for the following devices do not maintain the link status: DEMNA, any TURBOchannel adapter, any PCMPIA Ring adapter, Galaxy shared memory, TGEC, DE205, DE422, DE425, DE434, DE435, DE500 (the -XA and -AA variants; only the -BA variant is supported.)
+
| LAN_LINK_STATE_VALID || style="text-align:center;" | String || TRUE or FALSE to indicate whether or not the device driver for the LAN device correctly maintains the link status. The device drivers for the following devices do not maintain the link status: DEMNA, any TURBOchannel adapter, any PCMPIA Ring adapter, Galaxy shared memory, TGEC, DE205, DE422, DE425, DE434, DE435, DE500 (the -XA and -AA variants; only the -BA variant is supported.)
 
|-
 
|-
−
| LAN_LINK_UP || String || TRUE or FALSE to indicate whether the link is up. This item code is valid only for the template device (that is, unit number 0); this item returns 0 if used with a non-template LAN device. This item is supported only on newer adapters; to determine whether or not a particular device supports LAN_LINK_UP, you must first use F$GETDVI with the item LAN_LINK_STATE_VALID. See that item description for more information. If LAN_LINK_UP is used on an adapter that does not maintain the link status, the returned status will be SS$_UNSUPPORTED.
+
| LAN_LINK_UP || style="text-align:center;" | String || TRUE or FALSE to indicate whether the link is up. This item code is valid only for the template device (that is, unit number 0); this item returns 0 if used with a non-template LAN device. This item is supported only on newer adapters; to determine whether or not a particular device supports LAN_LINK_UP, you must first use F$GETDVI with the item LAN_LINK_STATE_VALID. See that item description for more information. If LAN_LINK_UP is used on an adapter that does not maintain the link status, the returned status will be SS$_UNSUPPORTED.
 
|-
 
|-
−
| LAN_MAC_ADDRESS || String || The current MAC (media access control) address of the device. For more information about the distinction between the default and current MAC addresses, see the HP OpenVMS System Services Reference Manual|
+
| LAN_MAC_ADDRESS || style="text-align:center;" | String || The current MAC (media access control) address of the device. For more information about the distinction between the default and current MAC addresses, see the HP OpenVMS System Services Reference Manual|
 
|-
 
|-
−
| LAN_PROMISCUOUS_MODE || String || TRUE or FALSE to indicate whether the device is enabled to receive all packets, rather than only packets addressed to the MAC addresses and to enabled multicast addresses
+
| LAN_PROMISCUOUS_MODE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is enabled to receive all packets, rather than only packets addressed to the MAC addresses and to enabled multicast addresses
 
|-
 
|-
−
| LAN_PROTOCOL_NAME || String || The name of the LAN protocol running on the device
+
| LAN_PROTOCOL_NAME || style="text-align:center;" | String || The name of the LAN protocol running on the device
 
|-
 
|-
−
| LAN_PROTOCOL_TYPE || String || The type of the LAN protocol running on the device
+
| LAN_PROTOCOL_TYPE || style="text-align:center;" | String || The type of the LAN protocol running on the device
 
|-
 
|-
−
| LAN_SPEED || Integer || The speed of the LAN device, in units of megabits per second. Valid values are 4, 10, 16, 100, 1000, and 10000
+
| LAN_SPEED || style="text-align:center;" | Integer || The speed of the LAN device, in units of megabits per second. Valid values are 4, 10, 16, 100, 1000, and 10000
 
|-
 
|-
−
| SET_HOST_TERMINAL || String || TRUE or FALSE to indicate whether the device is a remote terminal for a SET HOST session from a remote node
+
| SET_HOST_TERMINAL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a remote terminal for a SET HOST session from a remote node
 
|}
 
|}
  
Line 273: Line 273:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Item !! Value returned !! Description
+
! Item !! Value Returned !! Description
 
|-
 
|-
−
| QLEN || Integer|| The queue length for the device. This value is the number of I/O requests already in the driver --- not the depth of the I/O pending queue
+
| QLEN || style="text-align:center;" | Integer || The queue length for the device. This value is the number of I/O requests already in the driver --- not the depth of the I/O pending queue
 
|-
 
|-
−
| SPL || String || TRUE or FALSE to indicate whether the device is being spooled
+
| SPL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is being spooled
 
|-
 
|-
−
| SPLDEVNAM || String || Name of the device being spooled
+
| SPLDEVNAM || style="text-align:center;" | String || Name of the device being spooled
 
|}
 
|}
  
−
===Terminals==
+
===Terminals===
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Item !! Value returned !! Description
+
! Item !! Value Returned !! Description
 
|-
 
|-
−
| TRM || String || TRUE or FALSE to indicate whether the device is a terminal
+
| TRM || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a terminal
 
|-
 
|-
−
| TT_ACCPORNAM || String || The terminal server name and port name
+
| TT_ACCPORNAM || style="text-align:center;" | String || The terminal server name and port name
 
|-
 
|-
−
| TT_ALTYPEAHD || String || TRUE or FALSE to indicate whether the terminal has an alternate type-ahead buffer
+
| TT_ALTYPEAHD || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has an alternate type-ahead buffer
 
|-
 
|-
−
| TT_ANSICRT || String || TRUE or FALSE to indicate whether the terminal is an ANSI CRT terminal
+
| TT_ANSICRT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is an ANSI CRT terminal
 
|-
 
|-
−
| TT_APP_KEYPAD || String || TRUE or FALSE to indicate whether the keypad is in applications mode
+
| TT_APP_KEYPAD || style="text-align:center;" | String || TRUE or FALSE to indicate whether the keypad is in applications mode
 
|-
 
|-
−
| TT_AUTOBAUD || String || TRUE or FALSE to indicate whether the terminal has automatic baud rate detection
+
| TT_AUTOBAUD || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has automatic baud rate detection
 
|-
 
|-
−
| TT_AVO || String || TRUE or FALSE to indicate whether the terminal has a VT100-family terminal display
+
| TT_AVO || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has a VT100-family terminal display
 
|-
 
|-
−
| TT_BLOCK || String || TRUE or FALSE to indicate whether the terminal has block mode capability
+
| TT_BLOCK || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has block mode capability
 
|-
 
|-
−
| TT_BRDCSTMBX || String || TRUE or FALSE to indicate whether the terminal uses mailbox broadcast messages
+
| TT_BRDCSTMBX || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal uses mailbox broadcast messages
 
|-
 
|-
−
| TT_CHARSET || Integer || A bitmap indicating the coded character set supported by the terminal
+
| TT_CHARSET || style="text-align:center;" | Integer || A bitmap indicating the coded character set supported by the terminal
 
|-
 
|-
−
| TT_CRFILL || String || TRUE or FALSE to indicate whether the terminal requires fill after a carriage return
+
| TT_CRFILL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal requires fill after a carriage return
 
|-
 
|-
−
| TT_CS_HANGUL || String || TRUE or FALSE to indicate whether the terminal supports the DEC Korean coded character set
+
| TT_CS_HANGUL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal supports the DEC Korean coded character set
 
|-
 
|-
−
| TT_CS_HANYU || String || TRUE or FALSE to indicate whether the terminal supports the DEC Hanyu coded character set
+
| TT_CS_HANYU || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal supports the DEC Hanyu coded character set
 
|-
 
|-
−
| TT_CS_HANZI || String || TRUE or FALSE to indicate whether the terminal supports the DEC Hanzi coded character set
+
| TT_CS_HANZI || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal supports the DEC Hanzi coded character set
 
|-
 
|-
−
| TT_CS_KANA || String || TRUE or FALSE to indicate whether the terminal supports the DEC Kana coded character set
+
| TT_CS_KANA || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal supports the DEC Kana coded character set
 
|-
 
|-
−
| TT_CS_KANJI || String || TRUE or FALSE to indicate whether the terminal supports the DEC Kanji coded character set
+
| TT_CS_KANJI || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal supports the DEC Kanji coded character set
 
|-
 
|-
−
| TT_CS_THAI || String || TRUE or FALSE to indicate whether the terminal supports the DEC Thai coded character set
+
| TT_CS_THAI || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal supports the DEC Thai coded character set
 
|-
 
|-
−
| TT_DECCRT || String || TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT terminal
+
| TT_DECCRT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT terminal
 
|-
 
|-
−
| TT_DECCRT2 || String || TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT2 terminal
+
| TT_DECCRT2 || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT2 terminal
 
|-
 
|-
−
| TT_DECCRT3 || String || TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT3 terminal
+
| TT_DECCRT3 || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT3 terminal
 
|-
 
|-
−
| TT_DECCRT4 || String || TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT4 terminal
+
| TT_DECCRT4 || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT4 terminal
 
|-
 
|-
−
| TT_DIALUP || String || TRUE or FALSE to indicate whether the terminal is connected to dialup
+
| TT_DIALUP || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is connected to dialup
 
|-
 
|-
−
| TT_DISCONNECT || String || TRUE or FALSE to indicate whether the terminal can be disconnected
+
| TT_DISCONNECT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal can be disconnected
 
|-
 
|-
−
| TT_DMA || String || TRUE or FALSE to indicate whether the terminal has direct memory access (DMA) mode
+
| TT_DMA || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has direct memory access (DMA) mode
 
|-
 
|-
−
| TT_DRCS || String || TRUE or FALSE to indicate whether the terminal supports loadable character fonts
+
| TT_DRCS || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal supports loadable character fonts
 
|-
 
|-
−
| TT_EDIT || String|| TRUE or FALSE to indicate whether the edit characteristic is set
+
| TT_EDIT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the edit characteristic is set
 
|-
 
|-
−
| TT_EDITING || String || TRUE or FALSE to indicate whether advanced editing is enabled
+
| TT_EDITING || style="text-align:center;" | String || TRUE or FALSE to indicate whether advanced editing is enabled
 
|-
 
|-
−
| TT_EIGHTBIT || String || TRUE or FALSE to indicate whether the terminal uses the 8-bit ASCII character set
+
| TT_EIGHTBIT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal uses the 8-bit ASCII character set
 
|-
 
|-
−
| TT_ESCAPE || String || TRUE or FALSE to indicate whether the terminal generates escape sequences  
+
| TT_ESCAPE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal generates escape sequences  
 
|-
 
|-
−
| TT_FALLBACK || String || TRUE or FALSE to indicate whether the terminal uses the multinational fallback option
+
| TT_FALLBACK || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal uses the multinational fallback option
 
|-
 
|-
−
| TT_HALFDUP || String || TRUE or FALSE to indicate whether the terminal is in half-duplex mode
+
| TT_HALFDUP || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is in half-duplex mode
 
|-
 
|-
−
| TT_HANGUP || String || TRUE or FALSE to indicate whether the hangup characteristic is set
+
| TT_HANGUP || style="text-align:center;" | String || TRUE or FALSE to indicate whether the hangup characteristic is set
 
|-
 
|-
−
| TT_HOSTSYNC || String || TRUE or FALSE to indicate whether the terminal has host/terminal communication
+
| TT_HOSTSYNC || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has host/terminal communication
 
|-
 
|-
−
| TT_INSERT || String || TRUE or FALSE to indicate whether insert mode is the default line editing mode
+
| TT_INSERT || style="text-align:center;" | String || TRUE or FALSE to indicate whether insert mode is the default line editing mode
 
|-
 
|-
−
| TT_LFFILL || String || TRUE or FALSE to indicate whether the terminal requires fill after a line feed
+
| TT_LFFILL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal requires fill after a line feed
 
|-
 
|-
−
| TT_LOCALECHO || String || TRUE or FALSE to indicate whether the local echo characteristic is set
+
| TT_LOCALECHO || style="text-align:center;" | String || TRUE or FALSE to indicate whether the local echo characteristic is set
 
|-
 
|-
−
| TT_LOWER || String || TRUE or FALSE to indicate whether the terminal has the lowercase characters set
+
| TT_LOWER || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has the lowercase characters set
 
|-
 
|-
−
| TT_MBXDSABL || String || TRUE or FALSE to indicate whether mailboxes associated with the terminal will receive unsolicited input notification or input notification
+
| TT_MBXDSABL || style="text-align:center;" | String || TRUE or FALSE to indicate whether mailboxes associated with the terminal will receive unsolicited input notification or input notification
 
|-
 
|-
−
| TT_MECHFORM || String || TRUE or FALSE to indicate whether the terminal has mechanical form feed
+
| TT_MECHFORM || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has mechanical form feed
 
|-
 
|-
−
| TT_MECHTAB || String || TRUE or FALSE to indicate whether the terminal has mechanical tabs and is capable of tab expansion
+
| TT_MECHTAB || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has mechanical tabs and is capable of tab expansion
 
|-
 
|-
−
| TT_MODEM || String || TRUE or FALSE to indicate whether the terminal is connected to a modem
+
| TT_MODEM || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is connected to a modem
 
|-
 
|-
−
| TT_MODHANGUP || String || TRUE or FALSE to indicate whether the modify hangup characteristic is set
+
| TT_MODHANGUP || style="text-align:center;" | String || TRUE or FALSE to indicate whether the modify hangup characteristic is set
 
|-
 
|-
−
| TT_NOBRDCST || String || TRUE or FALSE to indicate whether the terminal will receive broadcast messages
+
| TT_NOBRDCST || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal will receive broadcast messages
 
|-
 
|-
−
| TT_NOECHO || String || TRUE or FALSE to indicate whether the input characters are echoed
+
| TT_NOECHO || style="text-align:center;" | String || TRUE or FALSE to indicate whether the input characters are echoed
 
|-
 
|-
−
| TT_NOTYPEAHD || String || TRUE or FALSE to indicate whether data must be solicited by a read operation
+
| TT_NOTYPEAHD || style="text-align:center;" | String || TRUE or FALSE to indicate whether data must be solicited by a read operation
 
|-
 
|-
−
| TT_OPER || String || TRUE or FALSE to indicate whether the terminal is an operator terminal
+
| TT_OPER || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is an operator terminal
 
|-
 
|-
−
| TT_PAGE || String || Terminal page length
+
| TT_PAGE || style="text-align:center;" | String || Terminal page length
 
|-
 
|-
−
| TT_PASTHRU || String || TRUE or FALSE to indicate whether PASSALL mode with flow control is available
+
| TT_PASTHRU || style="text-align:center;" | String || TRUE or FALSE to indicate whether PASSALL mode with flow control is available
 
|-
 
|-
−
| TT_PHYDEVNAM || String || Physical device name associated with a channel number or virtual terminal
+
| TT_PHYDEVNAM || style="text-align:center;" | String || Physical device name associated with a channel number or virtual terminal
 
|-
 
|-
−
| TT_PRINTER || String|| TRUE or FALSE to indicate whether there is a printer port available
+
| TT_PRINTER || style="text-align:center;" | String || TRUE or FALSE to indicate whether there is a printer port available
 
|-
 
|-
−
| TT_READSYNC || String || TRUE or FALSE to indicate whether the terminal has read synchronization
+
| TT_READSYNC || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has read synchronization
 
|-
 
|-
−
| TT_REGIS || String || TRUE or FALSE to indicate whether the terminal has ReGIS graphics
+
| TT_REGIS || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has ReGIS graphics
 
|-
 
|-
−
| TT_REMOTE || String || TRUE or FALSE to indicate whether the terminal has established modem control
+
| TT_REMOTE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal has established modem control
 
|-
 
|-
−
| TT_SCOPE || String || TRUE or FALSE to indicate whether the terminal is a video screen display
+
| TT_SCOPE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal is a video screen display
 
|-
 
|-
−
| TT_SECURE || String || TRUE or FALSE to indicate whether the terminal can recognize the secure server
+
| TT_SECURE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the terminal can recognize the secure server
 
|-
 
|-
−
| TT_SETSPEED || String || TRUE or FALSE to indicate whether you cannot set the speed on the terminal line
+
| TT_SETSPEED || style="text-align:center;" | String || TRUE or FALSE to indicate whether you cannot set the speed on the terminal line
 
|-
 
|-
−
| TT_SIXEL || String || TRUE or FALSE to indicate whether the sixel is supported
+
| TT_SIXEL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the sixel is supported
 
|-
 
|-
−
| TT_SYSPWD || String || TRUE or FALSE to indicate whether the system password is enabled for a particular terminal
+
| TT_SYSPWD || style="text-align:center;" | String || TRUE or FALSE to indicate whether the system password is enabled for a particular terminal
 
|-
 
|-
−
| TT_TTSYNC || String || TRUE or FALSE to indicate whether there is terminal/host synchronization
+
| TT_TTSYNC || style="text-align:center;" | String || TRUE or FALSE to indicate whether there is terminal/host synchronization
 
|-
 
|-
−
| TT_WRAP || String || TRUE or FALSE to indicate whether a new line should be inserted if the cursor moves beyond the right margin
+
| TT_WRAP || style="text-align:center;" | String || TRUE or FALSE to indicate whether a new line should be inserted if the cursor moves beyond the right margin
 
|}
 
|}
  
Line 413: Line 413:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Item !! Value returned !! Description
+
! Item !! Value Returned !! Description
 
|-
 
|-
−
| ALL || String || TRUE or FALSE to indicate whether the device is allocated
+
| ALL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is [[Device allocation|allocated]]
 
|-
 
|-
−
| FOR || String || TRUE or FALSE to indicate whether the device is mounted using the /FOREIGN qualifier
+
| FOR || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is mounted using the /FOREIGN qualifier
 
|-
 
|-
−
| DMT || String || TRUE or FALSE to indicate whether the device is marked for dismount
+
| DMT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is marked for dismount
 
|-
 
|-
−
| MNT || String || TRUE or FALSE to indicate whether the device is mounted
+
| MNT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is mounted
 
|-
 
|-
−
| MOUNT_TIME || String || Time at which the volume was mounted. For volumes mounted in a cluster, only the time of the initial mount is recorded; the time of any subsequent mount is not recorded
+
| MOUNT_TIME || style="text-align:center;" | String || Time at which the volume was mounted. For volumes mounted in a cluster, only the time of the initial mount is recorded; the time of any subsequent mount is not recorded
 
|-
 
|-
−
| MOUNTCNT || Integer || 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
+
| MOUNTCNT || style="text-align:center;" | Integer || 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
 
|-
 
|-
−
| MOUNTVER_ELIGIBLE  || String || TRUE or FALSE to indicate whether 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
+
| MOUNTCNT_CLUSTER || style="text-align:center;" | Integer || Number of times the volume has been mounted in the cluster. 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
 
|-
 
|-
−
| MVSUPMSG || String || TRUE or FALSE to indicate whether 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
+
| MOUNTVER_ELIGIBLE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is eligible to undergo [[Mount verification|mount verification]]. A volume mounted with either the /FOREIGN or /NOMOUNT_VERIFICATION qualifier is not subject to mount verification
 +
|-
 +
| MVSUPMSG || style="text-align:center;" | String || TRUE or FALSE to indicate whether 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
 
|}
 
|}
  
Line 435: Line 437:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Item !! Value returned !! Description
+
! Item !! Value Returned !! Description
 
|-
 
|-
−
| ALLOCLASS || Longword integer|| Allocation class of the host
+
| ALLOCLASS || style="text-align:center;" | Longword integer|| [[Allocation class]] of the host
 
|-
 
|-
−
| ALLDEVNAM || String || Allocation class device name
+
| ALLDEVNAM || style="text-align:center;" | String || Allocation class device name
 
|-
 
|-
−
| DEVCLASS || Integer || [[Device class]]
+
| DEVCLASS || style="text-align:center;" | Integer || [[Device class]]
 
|-
 
|-
−
| DEVLOCKNAM || String || A unique lock name for the device
+
| DEVLOCKNAM || style="text-align:center;" | String || A unique lock name for the device
 
|-
 
|-
−
| DEVNAM || String || Device name
+
| DEVNAM || style="text-align:center;" | String || Device name
 
|-
 
|-
−
| DEVTYPE || Integer || [[Device type]]
+
| DEVTYPE || style="text-align:center;" | Integer || [[Device type]]
 
|-
 
|-
−
| FULLDEVNAM || String || Fully qualified device name
+
| FULLDEVNAM || style="text-align:center;" | String || Fully qualified device name
 
|-
 
|-
 
|}
 
|}
Line 456: Line 458:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Item !! Value returned !! Description
+
! Item !! Value Returned !! Description
 
|-
 
|-
−
| ACPPID || String|| Ancillary control process (ACP) identification
+
| ACPPID || style="text-align:center;" | String || Ancillary control process (ACP) identification
 
|-
 
|-
−
| ACPTYPE || String|| ACP type code, as one of the following strings: F11V1, F11V2, F11V3, F11V4, F11V5, F64, HBS, JNL, MTA, NET, REM, UCX, or ILLEGAL. The ACPTYPE item returns ILLEGAL if the device is not mounted or is mounted using the /FOREIGN qualifier or the ACPTYPE is not currently defined.
+
| ACPTYPE || style="text-align:center;" | String || ACP type code, as one of the following strings: F11V1, F11V2, F11V3, F11V4, F11V5, F64, HBS, JNL, MTA, NET, REM, UCX, or ILLEGAL. The ACPTYPE item returns ILLEGAL if the device is not mounted or is mounted using the /FOREIGN qualifier or the ACPTYPE is not currently defined.
 
|-
 
|-
−
| AVL || String || TRUE or FALSE to indicate whether the device is available for use.
+
| AVL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is available for use.
 
|-
 
|-
−
| CCL || String|| TRUE or FALSE to indicate whether the device is a carriage control device.
+
| CCL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a carriage control device.
 
|-
 
|-
−
| DEVBUFSIZ || Integer|| Device buffer size
+
| DEVBUFSIZ || style="text-align:center;" | Integer || Device buffer size. For terminals, this reflects terminal width.
 
|-
 
|-
−
| DEVCHAR || Integer|| Device characteristics
+
| DEVCHAR || style="text-align:center;" | Integer || Device characteristics
 
|-
 
|-
−
| DEVCHAR2 || Integer|| Additional device characteristics
+
| DEVCHAR2 || style="text-align:center;" | Integer || Additional device characteristics
 
|-
 
|-
−
| DEVDEPEND || Integer|| Device-dependent information
+
| DEVDEPEND || style="text-align:center;" | Integer || Device-dependent information
 
|-
 
|-
−
| DEVDEPEND2 || Ineteger|| Additional device-dependent information
+
| DEVDEPEND2 || style="text-align:center;" | Integer || Additional device-dependent information
 
|-
 
|-
−
| DEVICE_TYPE_NAME || String|| Device type name. Note that if the device is a SCSI tape or disk, the device type name is retrieved directly from the device
+
| DEVICE_TYPE_NAME || style="text-align:center;" | String || Device type name. Note that if the device is a SCSI tape or disk, the device type name is retrieved directly from the device
 
|-
 
|-
−
| DEVSTS || String|| Device-dependent status information
+
| DEVSTS || style="text-align:center;" | String || Device-dependent status information
 
|-
 
|-
−
| DFS_ACCESS || String|| TRUE or FALSE to indicate whether the device is a virtual disk connected to a remote Distributed File System (DFS) server.
+
| DFS_ACCESS || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a virtual disk connected to a remote Distributed File System (DFS) server.
 
|-
 
|-
−
| DUA || String|| TRUE or FALSE to indicate whether the device is a generic device.
+
| DUA || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a generic device.
 
|-
 
|-
−
| ELG || String|| TRUE or FALSE to indicate whether the device has error logging enabled.
+
| ELG || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device has error logging enabled.
 
|-
 
|-
−
| ERRCNT || Integer|| Error count of the device. If the error count has been reset with the SET DEVICE /RESET=ERRCNT command, you can use the SHOW DEVICE/FULL command to display the date and time that the error count was reset. If the pathname parameter is specified, only the error count for that path is returned. If the pathname parameter is omitted, the summation of the error counts for all paths in a multipath device is returned.
+
| ERRCNT || style="text-align:center;" | Integer || [[Device error count|Error count]] of the device. If the error count has been reset with the SET DEVICE /RESET=ERRCNT command, you can use the SHOW DEVICE/FULL command to display the date and time that the error count was reset. If the pathname parameter is specified, only the error count for that path is returned. If the pathname parameter is omitted, the summation of the error counts for all paths in a multipath device is returned.
 
|-
 
|-
−
| ERROR_RESET_TIME || String|| Time at which the error count was reset.
+
| ERROR_RESET_TIME || style="text-align:center;" | String || Time at which the error count was reset.
 
|-
 
|-
−
| EXISTS || String|| TRUE or FALSE to indicate whether the device exists on the system.
+
| EXISTS || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device exists on the system.
 
|-
 
|-
−
| FOD || String|| TRUE or FALSE to indicate whether the device is a files-oriented device.
+
| FOD || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a files-oriented device.
 
|-
 
|-
−
| GEN || String || TRUE or FALSE to indicate whether the device is a generic device.
+
| GEN || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a generic device.
 
|-
 
|-
−
| IDV || String || TRUE or FALSE to indicate whether the device is capable of providing input.
+
| IDV || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is capable of providing input.
 
|-
 
|-
−
| LOCKID || Integer|| Clusterwide lock identification.
+
| LOCKID || style="text-align:center;" | Integer || Clusterwide lock identification.
 
|-
 
|-
−
| MAILBOX_BUFFER_QUOTA || Integer longword|| The current mailbox quota as an unsigned integer longword.
+
| MAILBOX_BUFFER_QUOTA || style="text-align:center;" | Integer longword|| The current mailbox quota as an unsigned integer longword.
 
|-
 
|-
−
| MAILBOX_INITIAL_QUOTA || Integer longword|| The initial mailbox quota as an unsigned integer longword.
+
| MAILBOX_INITIAL_QUOTA || style="text-align:center;" | Integer longword|| The initial mailbox quota as an unsigned integer longword.
 
|-
 
|-
−
| MBX || String || TRUE or FALSE to indicate whether the device is a mailbox.
+
| MBX || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a [[Mailbox|mailbox]].
 
|-
 
|-
−
| MEDIA_ID || Integer|| Nondecoded media ID.
+
| MEDIA_ID || style="text-align:center;" | Integer || Nondecoded media ID.
 
|-
 
|-
−
| MEDIA_NAME || String || Either the name of the disk or the tape type.
+
| MEDIA_NAME || style="text-align:center;" | String || Either the name of the disk or the tape type.
 
|-
 
|-
−
| MEDIA_TYPE || String || Device name prefix.
+
| MEDIA_TYPE || style="text-align:center;" | String || Device name prefix.
 
|-
 
|-
−
| ODV || String || TRUE or FALSE to indicate whether the device is capable of providing output.
+
| ODV || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is capable of providing output.
 
|-
 
|-
−
| OPCNT || Integer|| Operation count of the device. Note that the operation count may have been reset with the SET DEVICE/RESET=OPCNT command. If the pathname parameter is specified, only the operation count for that path is returned. If the pathname parameter is omitted, the summation of the operation counts for all paths in a multipath device is returned.
+
| OPCNT || style="text-align:center;" | Integer || [[Operation count]] of the device. Note that the operation count may have been reset with the SET DEVICE/RESET=OPCNT command. If the pathname parameter is specified, only the operation count for that path is returned. If the pathname parameter is omitted, the summation of the operation counts for all paths in a multipath device is returned.
 
|-
 
|-
−
| OPR || String || TRUE or FALSE to indicate whether the device is an operator.
+
| OPR || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is an operator.
 
|-
 
|-
−
| OWNUIC || String || User identification code (UIC) of the device owner.
+
| OWNUIC || style="text-align:center;" | String || [[UIC|User identification code]] (UIC) of the device owner.
 
|-
 
|-
−
| PID || String || Process identification number of the device owner.
+
| PID || style="text-align:center;" | String || [[PID|Process identification number]] of the device owner.
 
|-
 
|-
−
| PREFERRED_CPU || Integer|| Return argument is a 32-bit CPU bit mask with a bit set 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 bit mask input argument to the $PROCESS_AFFINITY system service. The argument can be used to assign an application process to the optimal preferred CPU.
+
| PREFERRED_CPU || style="text-align:center;" | Integer || Return argument is a 32-bit CPU bit mask with a bit set 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 bit mask input argument to the $PROCESS_AFFINITY system service. The argument can be used to assign an application process to the optimal preferred CPU.
 
|-
 
|-
−
| PREFERRED_CPU_BITMAP   || String|| A bitmap string of zeros and, at most, a single 1. The 1 in the bitmask represents the number of the CPU to which the device is affinitized. The length of the string determines by how many CPUs are on the system. If there is no 1 in the bitmap string, then either Fast Path is disabled systemwide, or the device is not Fast Path-capable.
+
| PREFERRED_CPU_BITMAP || style="text-align:center;" | String || A bitmap string of zeros and, at most, a single 1. The 1 in the bitmask represents the number of the CPU to which the device is affinitized. The length of the string determines by how many CPUs are on the system. If there is no 1 in the bitmap string, then either Fast Path is disabled systemwide, or the device is not Fast Path-capable.
 
|-
 
|-
−
| PROT_SUBSYSTEM_ENABLED || String || TRUE or FALSE to indicate whether the volume is mounted with protected subsystems enabled.
+
| PROT_SUBSYSTEM_ENABLED || style="text-align:center;" | String || TRUE or FALSE to indicate whether the volume is mounted with protected subsystems enabled.
 
|-
 
|-
−
| RCK || String || TRUE or FALSE to indicate whether the device has read checking enabled.
+
| RCK || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device has read checking enabled.
 
|-
 
|-
−
| RCT || String || TRUE or FALSE to indicate whether the disk contains RCT.
+
| RCT || style="text-align:center;" | String || TRUE or FALSE to indicate whether the disk contains RCT.
 
|-
 
|-
−
| REC || String || TRUE or FALSE to indicate whether the device is record oriented.
+
| REC || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is record-oriented.
 
|-
 
|-
−
| RECSIZ || Integer|| Blocked record size.
+
| RECSIZ || style="text-align:center;" | Integer || Blocked record size.
 
|-
 
|-
−
| REFCNT || Integer|| Reference count of processes using the device.
+
| REFCNT || style="text-align:center;" | Integer || Reference count of processes using the device.
 
|-
 
|-
−
| REMOTE_DEVICE || String || TRUE or FALSE to indicate whether the device is a remote device.
+
| REMOTE_DEVICE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a remote device.
 
|-
 
|-
−
| RND || String || TRUE or FALSE to indicate whether the device allows random access.
+
| RND || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device allows random access.
 
|-
 
|-
−
| RTM || String || TRUE or FALSE to indicate whether the device is a real-time device.
+
| RTM || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a real-time device.
 
|-
 
|-
−
| SERVED_DEVICE || String || TRUE or FALSE to indicate whether the device is a served device.
+
| SERVED_DEVICE || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is a served device.
 
|-
 
|-
−
| SHR || String || TRUE or FALSE to indicate whether the device is shareable.
+
| SHR || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is shareable.
 
|-
 
|-
−
| STS || Integer|| Status information.
+
| STS || style="text-align:center;" | Integer || Status information.
 
|-
 
|-
−
| SWL || String || TRUE or FALSE to indicate whether the device is software write-locked.
+
| SWL || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device is software write-locked.
 
|-
 
|-
−
| UNIT || Integer|| The unit number.
+
| UNIT || style="text-align:center;" | Integer || The unit number.
 
|-
 
|-
−
| WCK || String || TRUE or FALSE to indicate whether the device has write checking enabled.
+
| WCK || style="text-align:center;" | String || TRUE or FALSE to indicate whether the device has write checking enabled.
 
|-
 
|-
−
| XFC_DEPOSING || String || TRUE or FALSE to indicate whether the XFC volume depose operation is in progress or not.
+
| XFC_DEPOSING || style="text-align:center;" | String || TRUE or FALSE to indicate whether the XFC volume depose operation is in progress or not.
 
|-
 
|-
 
|}
 
|}
  
−
=See also=
+
[[Category: Lexical Functions]]
−
[[Alphabetic list of F$GETDVI() items]]
 

Latest revision as of 11:27, 28 October 2022

F$GETDVI() is a lexical function that returns information about a specified device.

Format

F$GETDVI(device-name,item[,pathname])

device-name

Specifies a physical device name or a logical name equated to a physical device name. Specify the device name as a character string expression.

After the device-name argument is evaluated, the F$GETDVI function examines the first character of the name. If the first character is an underscore (_), the name is considered a physical device name; otherwise, a single level of logical name translation is performed and the equivalence name, if any, is used.

item

Specifies the type of device information to be returned. The item must be specified as a character string expression (use quotes). You can specify any one of the items listed below. For detailed descriptions of each item code, see the VSI OpenVMS DCL Dictionary.

pathname

If the pathname argument is specified, it is validated against the existing paths for the specified device. If the path does not exist, the NOSUCHPATH error is returned, even if the specified item code does not make use of the pathname argument.

List of F$GETDVI() items by topic

Logicals

Item Value Returned Description
CONCEALED String TRUE or FALSE to indicate whether the logical device name translates to a concealed device.

Volumes

Item Value Returned Description
ACCESSTIMES_RECORDED String TRUE or FALSE to indicate whether the volume supports the recording of access times
CLUSTER Integer Volume cluster size
CYLINDERS Integer Number of cylinders on the volume (disks only)
DIR String TRUE or FALSE to indicate whether the device is directory structured
EXPSIZE Integer Current expansion limit on the volume
ERASE_ON_DELETE String TRUE or FALSE to indicate whether disk blocks are zeroed upon file deletion on the volume.
FREEBLOCKS Integer Number of free blocks on the volume (disks only)
HARDLINKS_SUPPORTED String TRUE or FALSE to indicate whether Hardlinks, rather than aliases, are supported on the volume
LOGVOLNAM String Logical volume name
MAXBLOCK Integer Number of logical blocks on the volume
MAXFILES Integer Maximum number of files on the volume
NEXTDEVNAM String Device name of the next volume in a volume set
ROOTDEVNAM String Device name of the root volume in a volume set (disks only)
NOCACHE_ON_VOLUME String TRUE or FALSE to indicate whether the volume is mounted with all caching disabled
NOHIGHWATER String TRUE or FALSE to indicate whether high-water marking is disabled on the volume
NOSHARE_MOUNTED String TRUE or FALSE to indicate whether the volume is mounted with /NOSHARE
NOXFCCACHE_ON_VOLUME String TRUE or FALSE to indicate whether the XFC caching is disabled on the volume
ODS2_SUBSET0 String TRUE or FALSE to indicate whether the volume mounted supports only a subset of the ODS-2 file structure
ODS5 String TRUE or FALSE to indicate whether the volume is mounted ODS-5
SDI String TRUE or FALSE to indicate whether the device is single-directory structured
SECTORS Integer Number of sectors per track (disks only)
SERIALNUM Integer Volume serial number (disks only)
TRACKS Integer Number of tracks per cylinder (disks only)
TRANSCNT Integer Volume transaction count
VOLCHAR String 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
VOLCOUNT Integer The count of volumes in a volume set (disks only)
VOLNAM String The volume name
VOLNUMBER Integer Number of the current volume in a volume set (disks only)
VOLSETMEM String TRUE or FALSE to indicate whether the device is a volume set (disks only)
VOLSIZE Integer The volume's current logical volume size
VOLUME_EXTEND_QUANTITY Integer Number of blocks to be used as the default extension size for all files on the volume
VOLUME_MOUNT_GROUP String TRUE or FALSE to indicate whether the volume is mounted /GROUP
VOLUME_MOUNT_SYS String TRUE or FALSE to indicate whether the volume is mounted /SYSTEM
VOLUME_PENDING_WRITE_ERR String The number of pending write errors on the volume
VOLUME_RETAIN_MAX String The maximum retention time for the volume, as specified with the DCL command SET VOLUME/RETENTION
VOLUME_RETAIN_MIN String The minimum retention time for the volume, as specified with the DCL command SET VOLUME/RETENTION
VOLUME_SPOOLED_DEV_CNT Integer The number of devices spooled to the volume
VOLUME_WINDOW Integer The default window size for the volume
VPROT String The volume protection mask
WRITETHRU_CACHE_ENABLED String TRUE or FALSE to indicate whether the volume is mounted with write through caching enabled

Tapes

Item Value Returned Description
MT3_DENSITY String Current density of the device
MT3_SUPPORTED String TRUE or FALSE to indicate whether the device supports densities defined in MT3DEF (for Alpha tapes only)
SQD String TRUE or FALSE to indicate whether the device is sequential block-oriented

Fibre Channel

Item Value Returned Description
FC_HBA_FIRMWARE_REV String Firmware revision information of a Fibre Channel host bus adapter. A null string is returned for all other devices
FC_NODE_NAME String The Fibre Channel host bus adapter node name
FC_PORT_NAME String The Fibre Channel host bus adapter node name
WWID String Worldwide Identifier for a Fibre Channel device

SCSI

Item Value Returned Description
SCSI_DEVICE_FIRMWARE_REV String Firmware revision number of a SCSI disk or SCSI tape. A null string is returned for any other device

Shadow sets

Item Value Returned Description
SHDW_CATCHUP_COPYING String TRUE or FALSE to indicate whether the device is a member that is the target of a full copy operation
SHDW_COPIER_NODE String The name of the node that is actively performing the copy or merge operation
SHDW_DEVICE_COUNT Integer The total number of devices in the virtual unit, including devices being added as copy targets
SHDW_GENERATION String The current internal revision number for the virtual unit. This value is subject to change
SHDW_MASTER String TRUE or FALSE to indicate whether the device is a virtual unit
SHDW_MASTER_MBR String The name of the master member unit that will be used for merge and copy repair operations and for shadow set recovery operations
SHDW_MASTER_NAME String Device name of the virtual unit that represents the shadow set of which the specified device is a member. F$GETDVI returns a null string ("") if the specified device is not a member, or is itself a virtual unit
SHDW_MBR_COPY_DONE String The percentage of the copy operation completed on this member unit
SHDW_MBR_COUNT Integer The number of full source members in the virtual unit. Devices being added as copy targets are not full source members
SHDW_MBR_MERGE_DONE String The percentage of the merge operation completed on this member unit
SHDW_MBR_READ_COST String The current value set for the member unit. This value can be modified to use a user-specified value
SHDW_MEMBER String TRUE or FALSE to indicate whether the device is a shadow set member
SHDW_MERGE_COPYING String TRUE or FALSE to indicate whether the device is a merge member of the shadow set
SHDW_MINIMERGE_ENABLE String A value of TRUE indicates that the virtual unit will undergo a mini-merge, not a full merge, if a system in the cluster crashes
SHDW_NEXT_MBR_NAME String Device name of the next member in the shadow set. If you specify a virtual unit, F$GETDVI returns the device name of a member of the shadow set. If you specify the name of a shadow set member unit with the device name and item arguments, F$GETDVI 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 to F$GETDVI; on subsequent calls, specify the member name returned by the previous F$GETDVI call until it has finished, when it returns a null member name. The device name includes the allocation class if the allocation class is not zero; otherwise it includes the device name of the disk controller
SHDW_READ_SOURCE String The name of the member unit that will be used for reads at this time. The unit with the lowest sum total of its queue length and read cost is used. This is a dynamic value
SHDW_SITE Integer The site value for the specified device. This value is set by the SET DEVICE or SET SHADOW command
SHDW_TIMEOUT Integer The user-specified timeout value set for the device. If the user has not set a value by using the SETSHOSHADOW utility, the value of the SYSGEN parameter SHADOW_MBR_TMO is used for member units and the value of MVTIMEOUT is used for virtual units

Multipath

Item Value Returned Description
MULTIPATH String TRUE or FALSE to indicate whether the device is a member of a multipath set
ALT_HOST_AVAIL String TRUE or FALSE to indicate whether the host serving the alternate path is available
ALT_HOST_NAME String Name of the host serving the alternate path
ALT_HOST_TYPE String Hardware type of the host serving the alternate path
AVAILABLE_PATH_COUNT Integer Number of available, working paths for a multipath-capable device
HOST_AVAIL String TRUE or FALSE to indicate whether the host serving the primary path is available
HOST_COUNT Integer Number of hosts that make the device available to other nodes in the OpenVMS Cluster
HOST_NAME String Name of the host serving the primary path
HOST_TYPE String Hardware type of the host serving the primary path
MPDEV_AUTO_PATH_SW_CNT Integer Number of times a multipath device has automatically switched paths because of an I/O error or as the result of automatically "failing back" to a local path from a remote path once the local path became available
MPDEV_CURRENT_PATH String Current path name for multipath devices. If the device is not part of a multipath set, this lexical returns 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. Returns a null string if the class driver for the device does not support path names
MPDEV_MAN_PATH_SW_CNT Integer Number of times a multipath device has manually switched paths because of a SET DEVICE /PATH /SWITCH command or use of the $SET_DEVICE system service
PATH_AVAILABLE String TRUE or FALSE to indicate whether the specified path is available. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
PATH_NOT_RESPONDING String TRUE or FALSE to indicate whether the specified path is marked as not responding. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
PATH_POLL_ENABLED String TRUE or FALSE to indicate whether the specified path is enabled for multipath polling. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
PATH_SWITCH_FROM_TIME String Time from which this path was switched, either manually or automatically. This item code is typically used with the pathname parameter. If the pathname parameter is omitted, information about the current path of the multipath device is returned
PATH_SWITCH_TO_TIME String Time to which this path was switched, either manually or automatically. This item code is typically used with the pathname parameter. If thepathname parameter is omitted, information about the current path of the multipath device is returned
PATH_USER_DISABLED String TRUE or FALSE to indicate whether the specified path has been disabled using the SET DEVICE /PATH /NOENABLE command. This item code is typically used with the pathname parameter. If thepathname parameter is omitted, information about the current path of the multipath device is returned
TOTAL_PATH_COUNT Integer Number of paths for a multipath-capable device

Network devices

Item Value Returned Description
NET String TRUE or FALSE to indicate whether the device is a network device
LAN_ALL_MULTICAST_MODE String TRUE or FALSE to indicate whether the device is enabled to receive all multicast packets rather than only packets addressed to enabled multicast addresses
LAN_AUTONEG_ENABLED String TRUE or FALSE to indicate whether the device is set to autonegotiate the speed and duplex settings
LAN_DEFAULT_MAC_ADDRESS String The default MAC (media access control) address of the device
LAN_FULL_DUPLEX String TRUE or FALSE to indicate whether the device is operating in full-duplex mode
LAN_JUMBO_FRAMES_ENABLED String TRUE or FALSE to indicate whether jumbo frames are enabled on the device
LAN_LINK_STATE_VALID String TRUE or FALSE to indicate whether or not the device driver for the LAN device correctly maintains the link status. The device drivers for the following devices do not maintain the link status: DEMNA, any TURBOchannel adapter, any PCMPIA Ring adapter, Galaxy shared memory, TGEC, DE205, DE422, DE425, DE434, DE435, DE500 (the -XA and -AA variants; only the -BA variant is supported.)
LAN_LINK_UP String TRUE or FALSE to indicate whether the link is up. This item code is valid only for the template device (that is, unit number 0); this item returns 0 if used with a non-template LAN device. This item is supported only on newer adapters; to determine whether or not a particular device supports LAN_LINK_UP, you must first use F$GETDVI with the item LAN_LINK_STATE_VALID. See that item description for more information. If LAN_LINK_UP is used on an adapter that does not maintain the link status, the returned status will be SS$_UNSUPPORTED.
LAN_MAC_ADDRESS String
LAN_PROMISCUOUS_MODE String TRUE or FALSE to indicate whether the device is enabled to receive all packets, rather than only packets addressed to the MAC addresses and to enabled multicast addresses
LAN_PROTOCOL_NAME String The name of the LAN protocol running on the device
LAN_PROTOCOL_TYPE String The type of the LAN protocol running on the device
LAN_SPEED Integer The speed of the LAN device, in units of megabits per second. Valid values are 4, 10, 16, 100, 1000, and 10000
SET_HOST_TERMINAL String TRUE or FALSE to indicate whether the device is a remote terminal for a SET HOST session from a remote node

Printers

Item Value Returned Description
QLEN Integer The queue length for the device. This value is the number of I/O requests already in the driver --- not the depth of the I/O pending queue
SPL String TRUE or FALSE to indicate whether the device is being spooled
SPLDEVNAM String Name of the device being spooled

Terminals

Item Value Returned Description
TRM String TRUE or FALSE to indicate whether the device is a terminal
TT_ACCPORNAM String The terminal server name and port name
TT_ALTYPEAHD String TRUE or FALSE to indicate whether the terminal has an alternate type-ahead buffer
TT_ANSICRT String TRUE or FALSE to indicate whether the terminal is an ANSI CRT terminal
TT_APP_KEYPAD String TRUE or FALSE to indicate whether the keypad is in applications mode
TT_AUTOBAUD String TRUE or FALSE to indicate whether the terminal has automatic baud rate detection
TT_AVO String TRUE or FALSE to indicate whether the terminal has a VT100-family terminal display
TT_BLOCK String TRUE or FALSE to indicate whether the terminal has block mode capability
TT_BRDCSTMBX String TRUE or FALSE to indicate whether the terminal uses mailbox broadcast messages
TT_CHARSET Integer A bitmap indicating the coded character set supported by the terminal
TT_CRFILL String TRUE or FALSE to indicate whether the terminal requires fill after a carriage return
TT_CS_HANGUL String TRUE or FALSE to indicate whether the terminal supports the DEC Korean coded character set
TT_CS_HANYU String TRUE or FALSE to indicate whether the terminal supports the DEC Hanyu coded character set
TT_CS_HANZI String TRUE or FALSE to indicate whether the terminal supports the DEC Hanzi coded character set
TT_CS_KANA String TRUE or FALSE to indicate whether the terminal supports the DEC Kana coded character set
TT_CS_KANJI String TRUE or FALSE to indicate whether the terminal supports the DEC Kanji coded character set
TT_CS_THAI String TRUE or FALSE to indicate whether the terminal supports the DEC Thai coded character set
TT_DECCRT String TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT terminal
TT_DECCRT2 String TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT2 terminal
TT_DECCRT3 String TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT3 terminal
TT_DECCRT4 String TRUE or FALSE to indicate whether the terminal is a DIGITAL CRT4 terminal
TT_DIALUP String TRUE or FALSE to indicate whether the terminal is connected to dialup
TT_DISCONNECT String TRUE or FALSE to indicate whether the terminal can be disconnected
TT_DMA String TRUE or FALSE to indicate whether the terminal has direct memory access (DMA) mode
TT_DRCS String TRUE or FALSE to indicate whether the terminal supports loadable character fonts
TT_EDIT String TRUE or FALSE to indicate whether the edit characteristic is set
TT_EDITING String TRUE or FALSE to indicate whether advanced editing is enabled
TT_EIGHTBIT String TRUE or FALSE to indicate whether the terminal uses the 8-bit ASCII character set
TT_ESCAPE String TRUE or FALSE to indicate whether the terminal generates escape sequences
TT_FALLBACK String TRUE or FALSE to indicate whether the terminal uses the multinational fallback option
TT_HALFDUP String TRUE or FALSE to indicate whether the terminal is in half-duplex mode
TT_HANGUP String TRUE or FALSE to indicate whether the hangup characteristic is set
TT_HOSTSYNC String TRUE or FALSE to indicate whether the terminal has host/terminal communication
TT_INSERT String TRUE or FALSE to indicate whether insert mode is the default line editing mode
TT_LFFILL String TRUE or FALSE to indicate whether the terminal requires fill after a line feed
TT_LOCALECHO String TRUE or FALSE to indicate whether the local echo characteristic is set
TT_LOWER String TRUE or FALSE to indicate whether the terminal has the lowercase characters set
TT_MBXDSABL String TRUE or FALSE to indicate whether mailboxes associated with the terminal will receive unsolicited input notification or input notification
TT_MECHFORM String TRUE or FALSE to indicate whether the terminal has mechanical form feed
TT_MECHTAB String TRUE or FALSE to indicate whether the terminal has mechanical tabs and is capable of tab expansion
TT_MODEM String TRUE or FALSE to indicate whether the terminal is connected to a modem
TT_MODHANGUP String TRUE or FALSE to indicate whether the modify hangup characteristic is set
TT_NOBRDCST String TRUE or FALSE to indicate whether the terminal will receive broadcast messages
TT_NOECHO String TRUE or FALSE to indicate whether the input characters are echoed
TT_NOTYPEAHD String TRUE or FALSE to indicate whether data must be solicited by a read operation
TT_OPER String TRUE or FALSE to indicate whether the terminal is an operator terminal
TT_PAGE String Terminal page length
TT_PASTHRU String TRUE or FALSE to indicate whether PASSALL mode with flow control is available
TT_PHYDEVNAM String Physical device name associated with a channel number or virtual terminal
TT_PRINTER String TRUE or FALSE to indicate whether there is a printer port available
TT_READSYNC String TRUE or FALSE to indicate whether the terminal has read synchronization
TT_REGIS String TRUE or FALSE to indicate whether the terminal has ReGIS graphics
TT_REMOTE String TRUE or FALSE to indicate whether the terminal has established modem control
TT_SCOPE String TRUE or FALSE to indicate whether the terminal is a video screen display
TT_SECURE String TRUE or FALSE to indicate whether the terminal can recognize the secure server
TT_SETSPEED String TRUE or FALSE to indicate whether you cannot set the speed on the terminal line
TT_SIXEL String TRUE or FALSE to indicate whether the sixel is supported
TT_SYSPWD String TRUE or FALSE to indicate whether the system password is enabled for a particular terminal
TT_TTSYNC String TRUE or FALSE to indicate whether there is terminal/host synchronization
TT_WRAP String TRUE or FALSE to indicate whether a new line should be inserted if the cursor moves beyond the right margin

Miscellaneous

Allocation and mounting

Item Value Returned Description
ALL String TRUE or FALSE to indicate whether the device is allocated
FOR String TRUE or FALSE to indicate whether the device is mounted using the /FOREIGN qualifier
DMT String TRUE or FALSE to indicate whether the device is marked for dismount
MNT String TRUE or FALSE to indicate whether the device is mounted
MOUNT_TIME String Time at which the volume was mounted. For volumes mounted in a cluster, only the time of the initial mount is recorded; the time of any subsequent mount is not recorded
MOUNTCNT Integer 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
MOUNTCNT_CLUSTER Integer Number of times the volume has been mounted in the cluster. 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
MOUNTVER_ELIGIBLE String TRUE or FALSE to indicate whether 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
MVSUPMSG String TRUE or FALSE to indicate whether 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

Device information

Item Value Returned Description
ALLOCLASS Longword integer Allocation class of the host
ALLDEVNAM String Allocation class device name
DEVCLASS Integer Device class
DEVLOCKNAM String A unique lock name for the device
DEVNAM String Device name
DEVTYPE Integer Device type
FULLDEVNAM String Fully qualified device name

Other

Item Value Returned Description
ACPPID String Ancillary control process (ACP) identification
ACPTYPE String ACP type code, as one of the following strings: F11V1, F11V2, F11V3, F11V4, F11V5, F64, HBS, JNL, MTA, NET, REM, UCX, or ILLEGAL. The ACPTYPE item returns ILLEGAL if the device is not mounted or is mounted using the /FOREIGN qualifier or the ACPTYPE is not currently defined.
AVL String TRUE or FALSE to indicate whether the device is available for use.
CCL String TRUE or FALSE to indicate whether the device is a carriage control device.
DEVBUFSIZ Integer Device buffer size. For terminals, this reflects terminal width.
DEVCHAR Integer Device characteristics
DEVCHAR2 Integer Additional device characteristics
DEVDEPEND Integer Device-dependent information
DEVDEPEND2 Integer Additional device-dependent information
DEVICE_TYPE_NAME String Device type name. Note that if the device is a SCSI tape or disk, the device type name is retrieved directly from the device
DEVSTS String Device-dependent status information
DFS_ACCESS String TRUE or FALSE to indicate whether the device is a virtual disk connected to a remote Distributed File System (DFS) server.
DUA String TRUE or FALSE to indicate whether the device is a generic device.
ELG String TRUE or FALSE to indicate whether the device has error logging enabled.
ERRCNT Integer Error count of the device. If the error count has been reset with the SET DEVICE /RESET=ERRCNT command, you can use the SHOW DEVICE/FULL command to display the date and time that the error count was reset. If the pathname parameter is specified, only the error count for that path is returned. If the pathname parameter is omitted, the summation of the error counts for all paths in a multipath device is returned.
ERROR_RESET_TIME String Time at which the error count was reset.
EXISTS String TRUE or FALSE to indicate whether the device exists on the system.
FOD String TRUE or FALSE to indicate whether the device is a files-oriented device.
GEN String TRUE or FALSE to indicate whether the device is a generic device.
IDV String TRUE or FALSE to indicate whether the device is capable of providing input.
LOCKID Integer Clusterwide lock identification.
MAILBOX_BUFFER_QUOTA Integer longword The current mailbox quota as an unsigned integer longword.
MAILBOX_INITIAL_QUOTA Integer longword The initial mailbox quota as an unsigned integer longword.
MBX String TRUE or FALSE to indicate whether the device is a mailbox.
MEDIA_ID Integer Nondecoded media ID.
MEDIA_NAME String Either the name of the disk or the tape type.
MEDIA_TYPE String Device name prefix.
ODV String TRUE or FALSE to indicate whether the device is capable of providing output.
OPCNT Integer Operation count of the device. Note that the operation count may have been reset with the SET DEVICE/RESET=OPCNT command. If the pathname parameter is specified, only the operation count for that path is returned. If the pathname parameter is omitted, the summation of the operation counts for all paths in a multipath device is returned.
OPR String TRUE or FALSE to indicate whether the device is an operator.
OWNUIC String User identification code (UIC) of the device owner.
PID String Process identification number of the device owner.
PREFERRED_CPU Integer Return argument is a 32-bit CPU bit mask with a bit set 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 bit mask input argument to the $PROCESS_AFFINITY system service. The argument can be used to assign an application process to the optimal preferred CPU.
PREFERRED_CPU_BITMAP String A bitmap string of zeros and, at most, a single 1. The 1 in the bitmask represents the number of the CPU to which the device is affinitized. The length of the string determines by how many CPUs are on the system. If there is no 1 in the bitmap string, then either Fast Path is disabled systemwide, or the device is not Fast Path-capable.
PROT_SUBSYSTEM_ENABLED String TRUE or FALSE to indicate whether the volume is mounted with protected subsystems enabled.
RCK String TRUE or FALSE to indicate whether the device has read checking enabled.
RCT String TRUE or FALSE to indicate whether the disk contains RCT.
REC String TRUE or FALSE to indicate whether the device is record-oriented.
RECSIZ Integer Blocked record size.
REFCNT Integer Reference count of processes using the device.
REMOTE_DEVICE String TRUE or FALSE to indicate whether the device is a remote device.
RND String TRUE or FALSE to indicate whether the device allows random access.
RTM String TRUE or FALSE to indicate whether the device is a real-time device.
SERVED_DEVICE String TRUE or FALSE to indicate whether the device is a served device.
SHR String TRUE or FALSE to indicate whether the device is shareable.
STS Integer Status information.
SWL String TRUE or FALSE to indicate whether the device is software write-locked.
UNIT Integer The unit number.
WCK String TRUE or FALSE to indicate whether the device has write checking enabled.
XFC_DEPOSING String TRUE or FALSE to indicate whether the XFC volume depose operation is in progress or not.
Retrieved from "https://wiki.vmssoftware.com/index.php?title=F$GETDVI()&oldid=2544"