Content-type: text/html
Man page of volprint
volprint
Section: Maintenance Commands (8)
Index
Return to Main Contents
NAME
volprint - Display records from the Logical Storage Manager (LSM) configuration
SYNOPSIS
/usr/sbin/volprint [-AvpsdGhnlafmtqQ] [-g diskgroup] [-e pattern] [-D database] [-F [type:]format-spec] [name...]
/usr/sbin/volprint [-SAq] [-g diskgroup]
OPTIONS
The following options are recognized:
Display configuration summary information. The output consists
of a header line followed by a line containing the total number of subdisks,
plexes and volumes; the number of unassociated subdisks; and the number of
unassociated plexes.
Print records from all active (imported) disk groups. Each
disk group represented in the output is separated from other disk groups by
blank lines. Also, a short header line introduces each disk group.
Select records from the specified disk group. The
diskgroup
option argument can be either a disk group name or
disk group ID.
Select only volumes for display. 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, then a diagnostic is written
to the standard error.
Select only plexes.
Select only subdisks.
Select only disk media records.
Select only disk group records.
Note
The
-v,
-p,
-s,
-d, and
-G
options may be combined to specify that
more than one record type is allowed. Specifying all options restores the
default behavior. Also, note that without the addition of the
-A
option, the
-G
option will print at most one disk group record.
Use a volume configuration search expression to select records
to be displayed.
List complete hierarchies below selected records. For volumes,
this list includes all associated plexes and subdisks. For plexes, this list
includes all associated subdisks. Hierarchies are separated in the output
by a blank line. The order of output is a volume name, followed by one associated
plex, followed by all of the subdisks for that plex, followed by another associated
plex, followed by all of the subdisks 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.
Display only the names of selected records.
Display all information from each selected record. This information
is in a free format that is not intended for use by scripts. The format is
more convenient than the
-m
format for looking at records
directly, because the density of information is more appropriate to human
viewing.
Display all information about each selected record, one record
per line. The format is the same as for the
-m
option, except
that the
-a
option format appears on a single line with one
space character between each field, and the list of associated records is
not displayed. This format is useful for processing output through filters
such as
sed
and
grep
that operate exclusively
on one-line records, although the fields are not readily distinguishable.
It isn't a practical format from the viewpoint of human readability.
Display all information about each selected record in a format
that is useful as input to both the
volmake
utility and
to
awk(1)
scripts. The format used is the
volmake
description format (see
volmake(4)). In addition to record information,
the list of plex or subdisk 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
preceded by one double-quote character.
Display information about each record as one-line output records
containing the following fields:
Record type
Record name
Usage-type, volume association, or plex association (or
-
for unassociated plexes and subdisks)
Enabled state (or
-
for subdisks,
disks, or disk groups)
Length, in units of system sectors
Plex association offset (or
-
for
volumes, plexes, disks, or disk groups). This field will appear as
LOG
for log subdisks.
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 condition), then that condition is listed
instead of any usage-type-dependent state.
The
tutil[0]
field. This field is set
by usage-types as a lockout mechanism.
The
putil[0]
field. This field can be
set to prevent associations of plex or subdisk records.
-
A one-line header is written before any record information.
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:
Record type,
dm
Record name
The underlying disk access record
The disk access record type (sliced,
simple, or
nopriv)
The length of the disk's private region
The length of the disk's public region
The 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:
Record type,
sd
Record name
Associated plex, or
-
if the subdisk
is dissociated
Plex association offset in sectors,
LOG
for log subdisks, or the
putil[0]
field if the subdisk
is dissociated (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, then print
-
for dissociated
subdisks).
Device offset in sectors
Subdisk length in sectors
The name of the disk media record used by the subdisk
The name of the disk access record (based on the disk address)
used by the subdisk, or
-
if there is currently no
known associated access record
-
For plexes, the output consists of the following fields, from left to
right:
Record type,
pl
Record name
Associated volume, or
-
if the plex
is dissociated
Plex kernel state
Plex utility state. If an exception condition is recognized
on the plex (an I/O failure, 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.
Plex length in sectors
Plex layout type
Plex stripe width, or
-
if the plex
is not striped
The plex I/O mode, either
RW
(read-write),
WO
(write-only), or
RO
(read-only).
-
For volumes, the output consists of the following fields, from left
to right:
Record type,
v
Record name
Associated usage type
Volume kernel state
Volume utility state
Volume length in sectors
The volume read policy.
The preferred plex, if the read-policy uses a preferred plex.
-
A header line is printed before any record information, 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.
Suppress headers that would otherwise be printed for the default
and the
-t
and
-f
output formats.
Suppress the disk group header that separates each disk group.
A single blank line still separates each disk group.
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 format 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:
-
%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 otherwise be taken as part of the field name. The third format
allows the specification of a justification and a field width.
-
The fourth format allows alternate specifications to be used, either
with or without justification and width specifications. 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
-
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
-.
-
One % can be displayed by including two % 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.
Get a configuration from the specified location. The
database
option argument can be one of:
vold
-
(Default). Get a configuration from the volume configuration daemon.
-
-
Read a configuration from the standard input. The standard input is
expected to be in standard
volmake
input format.
DESCRIPTION
The
volprint
utility displays complete or partial information from records
in Logical Storage 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.
The default output format is single-line records containing a record
type, name, usage-type (or
-
for plexes and subdisks),
enabled state (or
-
for subdisks), length, and a
comment. A one-line header is written before any record information.
The
volprint
utility can display disk group, disk
media, volume, plex, and subdisk records. It cannot display disk access records.
Use the
voldisk list
operation to display disk access records,
or physical disk information.
By default, all records in the
rootdg
disk group
are displayed. Subdisks are sorted primarily by the subdisk device, secondarily
by the device offset. Plex and volume records are sorted by name.
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
volmake
utility. For a list of
these field names, see
volmake(4). Some additional pseudo fields
are also supported. These are:
The name of the record being displayed. Because the record
name is specified positionally within
volmake
description
formats, the
volmake
utility and the
-m
and
-a
options to
volprint
do not explicitly
provide this field name.
This is either
dg,
dm,
vol,
plex, or
sd, depending
upon whether the record being displayed is a disk group, disk, volume, plex,
or subdisk, respectively.
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.
This is the name of the disk group containing the record.
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.
The usage type for volume records and the association name
for associated plexes and subdisks. For dissociated plexes and subdisks,
this is an empty string.
A comma-separated list of subdisks or plexes that are associated
with a plex or volume record.
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 sectors. For volume records, this field is equivalent to
aslist.
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 following
in the given precedence order:
NODEVICE
if an expected
underlying disk could not be found;
REMOVED
if an underlying
disk is in the
removed
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.
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 associated volume of the
associated plex (if any).
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).
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
volprint
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
volintro(8)
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, use the command:
-
/usr/sbin/volprint -Ath
-
If you tire of looking at the 5-line header and the extra disk group
headers generated by this command, then you can remove all the headers by
adding a
-q.
To display all subdisks and all disk groups, in sorted order
by disk, use:
-
/usr/sbin/volprint -AGts
-
If all plexes are named based on volumes, this can be a convenient means
of viewing large configurations. The association 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:
-
/usr/sbin/volprint -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, use:
-
/usr/sbin/volprint -s -F "%{name:-14} %{pl_offset|putil0}"
-
SEE ALSO
awk(1),
grep(1),
volintro(8),
volinfo(8),
volmake(8),
volmake(4),
sed(1)
Index
- NAME
-
- SYNOPSIS
-
- OPTIONS
-
- DESCRIPTION
-
- RECORD FIELDS
-
- EXIT CODES
-
- EXAMPLES
-
- SEE ALSO
-
This document was created by
man2html,
using the manual pages.
Time: 02:40:32 GMT, October 02, 2010