vxlist

Last published : Jun 19, 2026
Related information

Name

vxlist — displays records of the Storage Foundation configuration.

SYNOPSIS

vxlist [-*option*] [*keyword*] [*arguments*] [*storage_object_names ...*]

DESCRIPTION

vxlist lists Storage Foundation objects.
To display the vxlist command output, the vxdclid daemon must be running. If vxdclid is not running, run /opt/VRTSsfmh/adm/dclisetup.sh as a root user.

KEYWORDS

alert
Lists the Veritas Volume Manager alerts.
cache
Lists the Volume Manager cache objects.
disk
Lists the disks.
diskgroup|dg
Lists the Volume Manager disk groups.
dmp
Lists the supported Array Support Libraries (ASL).
enclosure|enclr|array
Lists the enclosures.
filesystem|fs
Lists the mounted file systems.
getfield
Lists the specified fields from Veritas Volume Manager (VxVM) records. Used with the -F option.
hba|hostport|controller|ctrl
Lists the controllers.
lun
Lists the Storage Insight Add-on information of LUNs. The information is only available if the host has been added to a Management Server domain, and the associated array has been enabled for Storage Insight.
The first use of the lun keyword fetches the array information from Management Server. Any vxlist lun command that is run within the next one hour uses the vxdclid cache. The vxdclid cache may be stale if array parameters have been modified. The vxlist lun command that is run after one hour of the last vxlist lun command fetches the latest array information from Management Server again.
To force the vxlist lun command to fetch the updated array information, use the rescan keyword.
nodeinfo
Lists the Cluster Volume Manager node information.
path
Lists the paths.
plex|pl
Lists the plexes.
rescan
Fetches updated Storage Foundation information.
See the lun keyword.
snapshot|snap
Lists the Volume Manager snapshots.
subdisk|sd
Lists the subdisks.
tag|tags
Lists the volume tags.
targetport|tca
Lists the target ports.
task
Lists the Volume Manager tasks that are running.
umfilesystem|umfs
Lists the unmounted file systems that are referenced in the file system table file.
volume|vol
Lists the Volume Manager volumes.
vset
Lists the Volume Manager volume sets.

OPTIONS

-a|--all
Displays all fields or sections including those that have no data.
-d|--deliminator string
Uses the specified string instead of spaces to delimit fields in tabular display.
-e|--exact
Displays all size-related numbers in sectors.
See the -u option.
-F|--format "objtype:field1 [objtype:field1]"
Displays the fields specified for one or more object types. For each object type, specify the object type, a colon, and a comma-separated list of field names. A field name can be any field listed in the output of 'vxprint -m' for that object type. The following object types are supported:
  • disk
  • diskgroup|dg
  • enclosure|enclr|array
  • filesystem|fs
  • hba|hostport|controller|ctrl
  • path
  • targetport|tca
  • volume|vol
  • vset
-k|--kilobyte
Displays all size-related numbers in kilobytes.
-g|--diskgroup dg
Lists storage objects in the specified disk group.
-H|--help
Displays usage information.
-l|--long
Displays in long format.
-B|--bare field1 objtype
Displays bare format. Displays only the specified long format fields
-O|--output
Displays information in the selected format. The default is the 'table' format.
-p|--property object_name1\_ \_object_name2...
Displays the property pages of the specified LUNs. The sections without data are not displayed unless the --all option is used.
-q|--suppress
Suppresses headers in tabular output format.
-s|--sections sectionname,... object_name
Displays only the specified sections in the property page. Sections with no data are not displayed unless the --all option is used.
-t|--table
Displays LUN information in the specified table format. The default format is 'default'.
-u|--unit
Displays all size-related numbers in the specified unit. The default is 'scaled'.

EXAMPLES

This section provides usage examples for vxlist.
EXAMPLE 1:
To display vxlist usage for viewing information on disks.
vxlist -H disk
EXAMPLE 2:
To display the fields Device, Status, Log Info, and VDID for disks, in bare format, delimited by the '++' string.
vxlist -B "Device,Status,Log Info,VDID" -d ++ disk
EXAMPLE 3:
To display only the disks section in the property page for the volume named vol_1.
vxlist -s disks vol vol_1
EXAMPLE 4:
To display the property pages with the disks section for the volumes named vol_1 and vol_2.
vxlist -p -s disks vol vol_1 vol_2
EXAMPLE 5:
To display the fields device_tag, guid, and mediatype for the disk disk_1.
vxlist -g dg_1 -F disk:device_tag,guid,mediatype getfield disk_1
EXAMPLE 6
To display the specified disk and volume fields for the dg_1 disk group:
vxlist -g dg_1 -F "disk:device_tag,guid,mediatype volume:state" getfield

FILES

/etc/vx/dcli/sfm/conf/dcli_conf.ini
The vxlist and vxdclid configuration file
/etc/vx/dcli/log/server_A
The vxdclid log file

NOTES

The default location of vxlist is /opt/VRTSsfmh/bin/vxlist. There is also a vxlist link named /etc/vx/bin/vxlist.
Windows-based Management Server does not support the vxlist command.