# man vxprint
Reformatting page.  Wait... done

Maintenance Commands                                  vxprint(1M)

NAME
     vxprint - display records from the Volume Manager configura-
     tion

SYNOPSIS
     vxprint [-aAdfGhHlLmnpqQrstv ] [-D database ] [-e pattern  ]
     [-F [type: ]format-spec ] [-g diskgroup ] [name...]

     vxprint [-AqS] [-g  diskgroup ]

DESCRIPTION
     The vxprint utility displays complete or partial information
     from  records  in  Volume Manager disk group configurations.
     Records can be selected  by  name  or  with  special  search
     expressions.   Additionally,  record association hierarchies
     can be displayed in an orderly fashion so that the structure
     of records is more apparent.

     Dashes (-) are displayed in the output wherever there is  no
     applicable record value.

     If no options are specified, the default output uses -f, -h,
     -r,  and -A. Specifying other options can override the these
     defaults, making it necessary to explicitly specify the nor-
     mal default options.

     The default output format consists of  single-line  records,
     each  of  which  includes a record type, name, usage type or
     object association, enabled state, length, and other fields.
     A one-line header is written before the record information.

     When no  disk  group  is  specified,  selected  records  are
     retrieved  from rootdg.  Subdisks/Subvolumes are sorted pri-
     marily by their device/volume, subdisks may also  include  a
     device offset.  Plex and volume records are sorted by name.

     Note1: The vxprint utility  can  display  disk  group,  disk
     media, volume, plex, and subdisk/subvolume records.  It can-
     not display disk access records.  Use the vxdisk list opera-
     tion to display disk access records, or physical disk infor-
     mation.

     Note2: The subvolume "record type" appears as  sv  as a con-
     veniece  in  displaying views of the configuration database.
     For manipulation purposes, these records are  accessible  as
     subdisk record types, i.e., records tagged as type  sd .

OPTIONS
     The -v, -p, -s, -d,  and  -G  options  may  be  combined  to
     specify that more than one record type is allowed.  Specify-
     ing all these  options  restores  the  default  behavior  of
     retrieving all record types.

VxVM 3.0            Last change: 11 Dec 1998                    1

Maintenance Commands                                  vxprint(1M)

     -a        Display  all  information  about   each   selected
               record,  one  record  per  line.  The contents are
               similar to  the  -m  option,  with  the  following
               exceptions: the -a option format appears on a sin-
               gle line with one  space  character  between  each
               field,  the  list  of  associated  records  is not
               displayed, and  the  -m  option  retains  the   sd
               record type rather than  sv .  This format is use-
               ful for processing output through filters such  as
               sed  and grep that operate exclusively on one-line
               records, although the fields are not readily  dis-
               tinguishable.   It  isn't  a practical format from
               the viewpoint of human readability.

     -A        Print records  from  all  active  (imported)  disk
               groups.  Each disk group represented in the output
               is separated  from  other  disk  groups  by  blank
               lines.   A  short header line introduces each disk
               group.

     -d        Display only disk media records.

     -D database
               Get a configuration from the  specified  location.
               The database option argument can be one of:

               vxconfigd Get a configuration from the volume con-
                         figuration daemon (default).

               -         Read a configuration from  the  standard
                         input.   The  standard input is expected
                         to be in standard vxmake input format.

     -e pattern
               Use a volume configuration  search  expression  to
               select    records    to    be    displayed.    See
               vol_pattern(4) for a description  of  search  pat-
               terns.

     -f        Display information about each record as  one-line
               output  records  containing  the following fields,
               from left to right.  A one-line header is  written
               before any record information.

                 1. Record type

                 2. Record name

                 3. Usage-type, volume association, or plex asso-
                    ciation  (or  -  for  unassociated plexes and
                    subdisks)

VxVM 3.0            Last change: 11 Dec 1998                    2

Maintenance Commands                                  vxprint(1M)

                 4. Enabled state (or - for subdisks,  disks,  or
                    disk groups)

                 5. Length, in units of system sectors

                 6. Plex association offset (or  -  for  volumes,
                    plexes,  disks,  or disk groups).  This field
                    will appear as LOG for log subdisks.

                 7. Usage-dependent state (or  -  for  subdisks).
                    If  an  exception  condition is recognized (a
                    plex I/O  failure,  removed  or  inaccessible
                    disk,  or  an  unrecovered  stale data condi-
                    tion), then that condition is listed  instead
                    of any usage-type-dependent state.

                 8. The tutil[0] field.  This  field  is  set  by
                    usage-types as a lockout mechanism.

                 9. The putil[0] field.  This field can be set to
                    prevent   associations  of  plex  or  subdisk
                    records.

     -F  [type :]format_spec
               Set a literal format string to use for  displaying
               record information.  If the option argument begins
               with a comma-separated list of zero or more record
               types (sd, plex, or vol) followed by a colon, then
               the format_spec  after  the  colon  is  used  when
               printing the indicated record types.  If no record
               types are specified, then  all  record  types  are
               assumed.

               The order  of  -F  options  is  significant,  with
               specifications later in the option list overriding
               earlier specifications.  Any use of  -F  overrides
               any  other option letter specifying a type of for-
               mat for the  indicated  record  types.   Thus,  -F
               vol:format_spec  can be used with the -t option to
               change the format used for  volumes,  while  still
               using the -t format for plex and subdisk records.

               The format-spec string consists  of  literal  text
               with   embedded  configuration  record  variables.
               Configuration record variables are introduced with
               a  percent sign (%).  The percent sign is followed
               by a variable name  or  by  a  variable  name  and
               optional  field  width  in  braces.  The following
               formats are allowed for a variable specification:

VxVM 3.0            Last change: 11 Dec 1998                    3

Maintenance Commands                                  vxprint(1M)

                    %field_name
                    %{field_name}
                    %{field_name : [[-] width ][ * ] }
                    %{field_spec | field_spec [ |...] }

               The first format specifies the exact  field  name.
               The  second  format allows a field to be specified
               with immediately surrounding text that would  oth-
               erwise  be  taken  as part of the field name.  The
               third format allows the specification of a justif-
               ication  and  a  field  width.   The fourth format
               allows alternate specifications to be used, either
               with or without justification and width specifica-
               tions.  For the fourth, the first specification is
               used  if the specified field name is applicable to
               the record and is non-empty; otherwise,  the  next
               available  specification  is  used.  Any number of
               alternate specifications can be used.

               If no field width is specified, then the number of
               output  column positions used for the field is the
               smallest possible to contain the value;  otherwise
               spaces  are  added  in the output to make it width
               columns in length.  A field is  not  truncated  if
               the  minimum  number of column positions necessary
               for a value is greater than width.

               If a field width is specified with a leading  dash
               (-)  character, then an output field is lengthened
               by adding spaces after the field value, yielding a
               left-justified field.  Otherwise, spaces are added
               before  the  value,  yielding  a   right-justified
               field.

               If a field width is followed  or  replaced  by  an
               asterisk  (*)  character,  then an unrecognized or
               inappropriate field yields either  no  output  for
               the  field  or  a  field  containing  all  blanks.
               Without the asterisk, the printed  field  contains
               the character -.

               A percent sign (%) can be displayed  by  including
               two percent characters (%%) in format-spec.

               See the Record Fields section for a description of
               the field names that can be specified.  An invalid
               format string may  yield  unexpected  output,  but
               does not generate an error.

     -g diskgroup
               Display records from  the  specified  disk  group.
               The diskgroup option argument can be either a disk

VxVM 3.0            Last change: 11 Dec 1998                    4

Maintenance Commands                                  vxprint(1M)

               group name or disk group ID.

     -G        Display only disk group records.

     -h        List  hierarchies  below  selected  records.   For
               volumes,  this list includes all associated plexes
               and subdisks.  For plexes, this list includes  all
               associated  subdisks/subvolumes.  Hierarchies  are
               separated in the output by  a  blank  line.   Each
               object listed occupies its own line.  The order of
               output is a volume name, followed by  one  associ-
               ated    plex,    followed    by    all    of   the
               subdisks/subvolumes for  that  plex,  followed  by
               another  associated  plex,  followed by all of the
               subdisks/subvolumes for the second  plex,  and  so
               on.

               The -v, -p, and -s  options  limit  the  selection
               only  of  the  head  of  a hierarchy.  They do not
               prevent the display of associated records  through
               the -h option.

               Unless objects  are  named  explicitly  with  name
               operands,  a  record  is  never  displayed  in two
               separate hierarchies.  Thus, a  selected  plex  is
               not  displayed  as  a  separate  hierarchy  if the
               volume that is associated with the  plex  is  also
               selected.

     -H        Print help information on usage.

     -l        Display all information from each selected record.
               This  information  is in a free format that is not
               intended for use by scripts.  This format is  more
               convenient  than  the  -m  format  for  looking at
               records directly, because the density of  informa-
               tion is more appropriate for human viewing.

     -m        Display all information about each selected record
               in  a  format  that is useful as input to both the
               vxmake utility and to awk(1) scripts.  The  format
               used   is   the  vxmake  description  format  (see
               vxmake(4)).  In addition  to  record  information,
               the  list  of  plex  or  subdisk/subvolume records
               associated with selected volume or plex records is
               displayed.   Each  field  is  output on a separate
               line, indented by a single tab.  Values for fields
               that contain comment-style strings are always pre-
               ceded by one double-quote character.

VxVM 3.0            Last change: 11 Dec 1998                    5

Maintenance Commands                                  vxprint(1M)

     -n        Display only the names of selected records.

     -p        Display only plexes with associated subdisks. If a
               name  operand  names  a  volume or subdisk, then a
               diagnostic is written to the standard error.

     -q        Suppress headers that would otherwise  be  printed
               for the default and the -t and -f output formats.

     -Q        Suppress the disk group header that separates each
               disk  group.   A single blank line still separates
               each disk group.

     -R        Rendezvous point. This is  a  reserved  option  to
               indicate the communications point used with vxcon-
               figd.

     -r        Display related records  of  a  volume  containing
               subvolumes.  Grouping  is  done  under the highest
               level volume.

     -L        Useful when used with the  -r  parameter.  Display
               related records of a volume containing subvolumes,
               but grouping is done under any volume.

     -s        Display  only  subdisks/subvolumes.  If   a   name
               operand  names a volume or plex, then a diagnostic
               is written to the standard error.

     -S        Display configuration  summary  information.   The
               output  consists  of  a  header line followed by a
               line    containing    the    total    number    of
               subdisks/subvolumes,   plexes   and  volumes;  the
               number of  unassociated  subdisks/subvolumes;  and
               the number of unassociated plexes.

     -t        Print single-line output records that depend  upon
               the  configuration  record  type. For disk groups,
               the output consists of the record  type  (dg)  the
               disk group name, and the disk group ID.

               For disk media records, the output consists of the
               following fields, in order from left to right:

                 1. Record type (dm)

                 2. Record name

                 3. Underlying disk access record

                 4. Disk access record type (sliced,  simple,  or
                    nopriv)

VxVM 3.0            Last change: 11 Dec 1998                    6

Maintenance Commands                                  vxprint(1M)

                 5. Length of the disk's private region

                 6. Length of the disk's public region

                 7. Path to use for accessing the underlying  raw
                    disk device for the disk's public region.

               For subdisks, the output consists of the following
               fields, from left to right.

                 1. Record type (sd)

                 2. Record name

                 3. Associated plex, or dash (-) if  the  subdisk
                    is dissociated

                 4. Name of the disk media  record  used  by  the
                    subdisk

                 5. Device offset in sectors

                 6. Subdisk length in sectors

                 7. Plex association offset, optionally  preceded
                    by subdisk column number for subdisks associ-
                    ated to striped plexes, LOG for log subdisks,
                    or  the putil[0] field if the subdisk is dis-
                    sociated.  The putil[0]  field  can  be  non-
                    empty  to  reserve  the  subdisk's  space for
                    non-volume uses.  If the  putil[0]  field  is
                    empty,  -  is  displayed for dissociated sub-
                    disks.

                 8. A string representing the state of  the  sub-
                    disk  (ENA  if  the subdisk is usable; DIS if
                    the subdisk is disabled; RCOV if the  subdisk
                    is  part  of a RAID-5 plex and has stale con-
                    tent; DET if the subdisk has  been  detached;
                    KDET  if the subdisk has been detached in the
                    kernel due to an error;  RMOV  if  the  media
                    record  on  which  the subdisk is defined has
                    been removed from its disk access record by a
                    utility; or NDEV if the media record on which
                    the subdisk is defined has no  access  record
                    associated).

               For subvolumes, the output consists of the follow-
               ing fields, from left to right.

                 1. Record type (sv)

VxVM 3.0            Last change: 11 Dec 1998                    7

Maintenance Commands                                  vxprint(1M)

                 2. Record name

                 3. Associated plex, or dash (-) if the subvolume
                    is dissociated.

                 4. Name  of  the  underlying  (layered)   volume
                    record used by the subvolume.

                 5. Number of layers used in the subvolume.

                 6. Subvolume length in sectors

                 7. Plex association offset, optionally  preceded
                    by  subvolume  column  number  for subvolumes
                    associated to striped plexes.

                 8. Number of  active  plexes,  followed  by  the
                    number  of plexes in the underlying (layered)
                    volume.

                 9. A string representing the state of the subvo-
                    lume  (ENA if the subvolume is usable; DIS if
                    the subvolume is disabled; KDET if the subvo-
                    lume  has  been detached in the kernel due to
                    an error
     For plexes, the output consists  of  the  following  fields,
     from left to right:

                 1. Record type (pl)

                 2. Record name

                 3. Associated volume, or - if the plex is disso-
                    ciated

                 4. Plex kernel state

                 5. Plex utility state.  If an  exception  condi-
                    tion  is  recognized  on  the  plex  (an  I/O
                    failure, a removed or inaccessible  disk,  or
                    an  unrecovered  stale  data condition), then
                    that condition is listed instead of the value
                    of the plex record's state field.

                 6. Plex length in sectors

                 7. Plex layout type

                 8. Number of columns and plex stripe width, or -
                    if the plex is not striped

                 9. Plex I/O mode,  either  RW  (read-write),  WO

VxVM 3.0            Last change: 11 Dec 1998                    8

Maintenance Commands                                  vxprint(1M)

                    (write-only), or RO (read-only)

               For volumes, the output consists of the  following
               fields, from left to right:

                 1. Record type (v)

                 2. Record name

                 3. Associated usage type

                 4. Volume kernel state

                 5. Volume utility state

                 6. Volume length in sectors

                 7. Volume read policy

                 8. The preferred plex, if the read-policy uses a
                    preferred plex

               A header line is printed before any record  infor-
               mation,  for  each  type  of  record that could be
               selected based on the -v, -p, -s, and -h  options.
               These  header lines are followed by a single blank
               line.

     -v        Display only volumes with  associated  plexes  and
               subdisks/subvolumes.   This  restricts the records
               matched with search patterns.  Also,  the  default
               selection  of  all records in the database is then
               restricted to all  volumes.   If  a  name  operand
               names a plex or subdisk/subvolume, then a diagnos-
               tic is written to the standard error.

Record Fields
     The field names that can be used with the format_spec string
     of  the  -F  option  and  that are produced for the -m or -a
     options are the same as those that can be provided as  input
     to the vxmake utility.  For a list of these field names, see
     vxmake(4).  Some additional  pseudo  fields  are  also  sup-
     ported.  These are:

     admin_state
               The persistent state for a plex or volume  record,
               accounting  for  any  exceptional conditions.  For
               volume records, this  displays  the  state  field.
               For plex records, this displays one of the follow-
               ing in the given precedence order: NODEVICE if  an
               expected  underlying  disk  could  not  be  found;
               REMOVED if an underlying disk is  in  the  removed

VxVM 3.0            Last change: 11 Dec 1998                    9

Maintenance Commands                                  vxprint(1M)

               state; IOFAIL if an unrecovered I/O failure caused
               the  plex  to  be  detached;  RECOVER  if  a  disk
               replacement  left  the  plex  in need of recovery,
               either from another plex or from a backup.

     aslist    A comma-separated list of subdisks or plexes  that
               are associated with a plex or volume record.

     assoc     The name of the volume or plex to which a plex  or
               subdisk  record  is  associated.  If the record is
               not associated, this field is empty.

     column_pl_offset
               For a subdisk associated with a striped plex,  the
               column  number  and  column  offset of the subdisk
               separated by a / or the plex offset (if  the  sub-
               disk is associated in a non-striped plex) or - (if
               the plex is not associated).

     dgname or dg_name
               This is the name of the disk group containing  the
               record.

     name      The name of the record being  displayed.   Because
               the  record  name is specified positionally within
               vxmake description formats, the vxmake utility and
               the -m and -a options to vxprint do not explicitly
               provide this field name.

     ncolumn_st_width
               For a striped plex,  the  number  of  columns  and
               stripe  unit size for a plex, separated by a /, or
               - if the plex is not striped.

     plname or pl_name
               The name of an associated plex record.  For a plex
               record,  this  is  the  plex's name; for a subdisk
               record, this is the  associated  plex's  name  (if
               any).

     rec_type or rtype
               This is either dg (disk  group),  dm  (disk),  vol
               (volume),  plex (plex), or sd (subdisk), depending
               on the record being displayed.

     sd_flag   For a subdisk associated with a RAID-5 plex,  this
               will  display  flags relating to the status of the
               subdisk. An S indicates that the subdisk  is  con-
               sidered  to contain stale data. A d indicates that
               the subdisk has  been  detached  from  the  RAID-5
               plex.

VxVM 3.0            Last change: 11 Dec 1998                   10

Maintenance Commands                                  vxprint(1M)

     sdaslist  A comma-separated list of subdisks associated with
               a  plex.  Each subdisk name is followed by a colon
               and the subdisk's plex association offset, in sec-
               tors.    For   volume   records,   this  field  is
               equivalent to aslist.

     short_type or type
               This is either dg, dm, v,  pl,  or  sd,  depending
               upon the record type.  This pseudo variable can be
               used in a 2-character field, if a full 4 character
               field (required by rec_type) is too large.

     use_assoc The usage type for volume records and the associa-
               tion name for associated plexes and subdisks.  For
               dissociated plexes and subdisks, this is an  empty
               string.

     vname or v_name
               The name of an associated volume  record.   For  a
               volume  record,  this  is the volume's name; for a
               plex record, this is the associated volume's  name
               (if  any); for a subdisk record, this is the asso-
               ciated volume of the associated plex (if any).

     Displaying a boolean value always yields on or  off.   If  a
     field  containing  a  length  or  offset  is  specified in a
     format_spec string, then the result is the length or  offset
     in  sectors.  When the field is displayed with -m or -a, the
     length or offset is displayed in sectors with a suffix of s.

EXIT CODES
     The vxprint utility exits  with  a  nonzero  status  if  the
     attempted  operation  fails.   A  nonzero exit code is not a
     complete indicator of the problems  encountered  but  rather
     denotes the first condition that prevented further execution
     of the utility.

     See vxintro(1M) for a list of standard exit codes.

EXAMPLES
     To display all records in  all  disk  groups,  with  clearly
     displayed  associations  and  with  output lines tailored to
     each record type, enter:

          vxprint -Ath

     To avoid looking at the 5-line header  and  the  extra  disk
     group  headers generated by this command, you can remove all
     the headers by adding a -q.

     To display all subdisks and all disk groups, in sorted order
     by disk, enter:

VxVM 3.0            Last change: 11 Dec 1998                   11

Maintenance Commands                                  vxprint(1M)

          vxprint -AGts

     If all plexes are named based on volumes, this can be a con-
     venient means of viewing large configurations.  The associa-
     tion field for each of the subdisks names the plex, and  the
     plex  name  will  normally imply a volume association by the
     form of the plex name.

     To display the names of all  unassociated  plexes,  use  the
     command

          vxprint -n -p -e !assoc

     To print all subdisks, including the subdisk name and either
     the  subdisk plex association offset or the putil0 field for
     dissociated subdisks, enter:

          vxprint -s -F "%{name:-14} %{pl_offset|putil0}"

     The vxprint command can be used to back up objects from  one
     disk  group  configuration  with  the  use  of  the combined
     options -mvpsh or -mvpshr. The output should be saved into a
     file  that  is maintained outside of the system being backed
     up. The command:

          vxmake -d file

     can be used with the saved file to  restore  the  configura-
     tion.

SEE ALSO
     awk(1),   grep(1),    sed(1),    vxinfo(1M),    vxintro(1M),
     vxmake(1M), vxmake(4)

VxVM 3.0            Last change: 11 Dec 1998                   12

# 
