vxmake(1M) VxVM 3.5 vxmake(1M)
1 Jun 2002
NAME [Toc] [Back]
vxmake - create VERITAS Volume Manager configuration records
SYNOPSIS [Toc] [Back]
vxmake [-pV ] [-g diskgroup] [-o useopt] [-U usetype] [-T a|o] [-d
descfile]
vxmake [-pV ] [-g diskgroup] [-o useopt] dco name [attribute=value...]
vxmake [-pV ] [-g diskgroup] [-o useopt] plex name [attribute=value...]
vxmake [-pV ] [-g diskgroup] rlink name [attribute=value...]
vxmake [-pV ] [-g diskgroup] rvg name [attribute=value...]
vxmake [-pV ] [-g diskgroup] [-o useopt] sd name [attribute=value...]
vxmake [-pV ] [-g diskgroup] [-o useopt] [-U usetype] vol name
[attribute=value...]
DESCRIPTION [Toc] [Back]
The vxmake utility creates subdisk, plex, and volume records for
VERITAS Volume Manager (VxVM). Records can be created entirely from
parameters specified on the command line, or they can be created using
a description file.
vxmake can also create a data change object (DCO) that is used to
implement Persistent FastResync on a volume.
When the VERITAS Volume Replicator (VVR) option is available, vxmake
can also create RVG and RLINK records. RVG and RLINK records only
support gen usage.
Note: The vxprint utility can be used with vxmake to perform the
functions of a rudimentary configuration backup and restore. This
should be the primary use of vxmake. Use of vxmake other than through
a description file containing content mostly gathered from either the
vxprint utility is discouraged in VxVM releases starting with 3.0.
The vxassist utility and the graphical user interface are the
recommended means of creating new or modified volume hierarchies.
If no operands are specified, then a description file is used to
specify what records to create. By default, this description file is
read from the standard input. If operands are specified, then the
first operand is a keyword that determines the object to build, the
second operand is the name of the object to be created, and additional
operands specify attributes for the object to be built. An attribute
given on the command line is specified in the same manner used with
the description file (with multiple attributes given, one attribute
per operand), except that the double-quote convention is not needed.
See the EXAMPLES section for sample uses.
- 1 - Formatted: January 24, 2005
vxmake(1M) VxVM 3.5 vxmake(1M)
1 Jun 2002
For convenience, a special attribute form can be used for subdisks
specified directly from the command line. This special attribute form
is:
devicepath,offset[,len]
or
medianame,offset[,len]
The first form specifies a subdisk location by device path, offset
within that device, and length. The second form specifies the subdisk
location by a disk media record name, offset within the disk's public
region, and length. Optionally, the length can be specified with a
len=length attribute instead. If a device path is specified, then it
must match the device path for the public region of a known disk in
the indicated disk group.
More than one record, including more than one volume or plex
hierarchy, can be specified in a single description file. vxmake
attempts to create all records within a single transaction, so that
either all records are created or no records are created. This is the
default behavior.
The -T option allows users to select transaction control that differs
from the default behavior when restoring records within a volume
hierarchy from a description file. This is particularly helpful with
layered volume hierarchies that include subvolumes.
See vxmake(4) for a specification of vxmake descriptions.
Descriptions of records within a volume hierarchy are filtered through
a usage-type-specific utility, as appropriate for the usage type,
before the records are actually created. Subdisks and plexes that are
not specified within a volume hierarchy are filtered by the gen usage
type. The usage-type utilities may change the descriptions so that
certain fields are ignored or set up with initial values. Plex or
subdisk records to be associated with a volume or plex may also be
changed if the association is indicated in the description, even if
the plex or subdisk record is not explicitly specified.
A usage type must be specified for every volume record, either through
setting the usetype field in the volume record description, or through
the -U option to vxmake.
OPTIONS [Toc] [Back]
-d descfile
Specify the name of a description file to use for building
subdisks, plexes, volumes, RVGs and RLINKs. If the descfile
- 2 - Formatted: January 24, 2005
vxmake(1M) VxVM 3.5 vxmake(1M)
1 Jun 2002
option argument is -d, then the description file is read
from the standard input. If no operands are specified, and
no descfile is specified, then a description file is read
from the standard input. This option is ignored for records
that are specified directly on the command line.
-g diskgroup
Specify the disk group for the operation. The disk group
can be specified either by name or by disk group ID. See
vxdg(1M) for more information on disk groups.
-o useopt Give usage-type-specific options to the usage type utility.
-p Print a list of all changes that would be made to the
standard output, but do not make those changes. The output
is in the vxmake description file format. All computable
and potentially useful attributes are printed for new
records. For records that would be modified, only those
attributes that would change are printed, along with an
extra attribute declaration, CHANGED=yes. In this way the
-p option performs a preview run of the utilities.
This option is intended for use with higher-level tools that
preview record creations, particularly with respect to
usage-type-dependent attribute modifications.
-T This option controls the unit of work that vxmake uses to
make records within a single transaction when restoring
records from a description file. If the option argument is
a or the -T option is absent altogether, then vxmake
attempts to create all records within a single transaction,
so that either all records are created or no records are
created. This behavior is considered the default behavior
and it is backward- compatible with previous releases of
VxVM.
If the option argument is o, then one complete top-level
object (Volume hierarchy, dissociated plex hierarchy, or
dissociated subdisk hierarchy) is created at a time, and if
multiple top-level objects are to be created from the same
description file, then vxmake attempts to create each one a
top-level object at a time in its own transaction. Note that
should some objects be creatable and some not, the
configuration results in those objects that vxmake was
actually able to create. This option can be used for any
record hierarchy. Because record hierarchies with layered
volumes may contain many subordinate records (such as
subvolumes), the -T o option is particularly useful for
safely creating these kinds of objects.
- 3 - Formatted: January 24, 2005
vxmake(1M) VxVM 3.5 vxmake(1M)
1 Jun 2002
-U usetype
Use usetype as the default usage type for volumes. This
option has no effect if only subdisks and plexes are
created, or if the usage type for a volume is specified
directly with the description file variable usetype.
-V Display a list of utilities that would be called from
vxmake, along with the arguments that would be passed. The
-V option performs a preview run of the utilities; the
utilities are not actually called, and no changes are made
to the volume configuration database.
Attribute Specification Rules [Toc] [Back]
The only attributes that must be specified are the path and len
attributes for subdisk records, and a usage type for volume records.
In addition, if the layout attribute for a plex record is set to
STRIPE, then a positive value must be specified for the stwidth
attribute. Also, if no subdisks are specified for a plex of the STRIPE
layout, the ncolumn attribute must be specified.
Attempts to specify certain attributes are ignored by vxmake. Some
attributes are ignored by the switchout (usage-type independent)
vxmake itself. The usage-type dependent vxmake may cause additional
attributes to be ignored.
The sections that follow provide information on the attributes that
can be specified for subdisk, plex, and volume creation.
Subdisks [Toc] [Back]
Fields that can be specified for subdisks are: tutil0, tutil1, tutil2,
putil0, putil1, putil2, daname, dmname (or disk), path, comment,
devoffset, dmoffset, len and dmrid.
The disk specification for subdisks uses one of following fields, in
order of precedence: dmrid, dmname, daname, or path. The dmrid field
is used, if non-zero. One of the other fields is used if defined to a
non-empty string. If the path field is the only field used, it must
define the block device path.
Specification of a disk in some form (including possibly the special
forms devicepath,offset,length or medianame,offset,length) is
required. Specification of the len field is also required. All other
fields default to zero (for numbers) or empty strings (for strings).
Plexes [Toc] [Back]
Fields that can be specified for plexes are: tutil0, tutil1, tutil2,
putil0, putil1, putil2, comment, layout, ncolumn, stwidth, sd, and
logsd.
There are no required fields for plex records. All fields default to
zero (for numbers) or empty strings (for strings). The layout field
- 4 - Formatted: January 24, 2005
vxmake(1M) VxVM 3.5 vxmake(1M)
1 Jun 2002
defaults to concat.
If the layout field is set to stripe or raid5, then the stwidth
attribute must be specified. If the layout field is set to concat, the
ncolumn field cannot be specified.
An sd specification names the subdisks to associate with the plex.
The specification optionally names the offsets of the subdisks within
the plex. If no offsets are specified, then the subdisks are directly
concatenated in the order indicated. If the sd attribute is specified
for a striped plex and ncolumn is not specified, ncolumn will default
to the column of the subdisk with the highest column specification. As
a special case, if ncolumn is not specified and the sd does not
specify columns or offsets for the subdisks, then each subdisk will be
placed in its own column at an offset of zero in the order they are
specified and the plex's ncolumn attribute is set to the number of
subdisks specified.
A logsd specification names a subdisk to associate as a special log
subdisk for recording volume activity as part of the DRL or DCM
logging features.
Volumes [Toc] [Back]
Fields that can be specified for volumes are: comment, usetype,
startopts, readpol, prefname, minor, user, group, mode, len,
writeback, writecopy, exclusive, primary_datavol, logtype, plex, and
dco_name.
Specification of a usage type is required, either using the -U option
on the command line, or using the usetype attribute. Specification of
a usetype attribute overrides a value specified with -U. All other
fields have default values: readpol defaults to round; user and group
both default to 0 (root); mode defaults to u=rw (mode 600); writeback
and writecopy default to on; exclusive defaults to off; len defaults
to the length of the shortest associated plex (or zero, if no plex
associations are requested); all other numeric fields default to zero,
and all other string fields default to empty strings.
A plex specification names the plexes to associate with the volume.
The order of plexes in this list is not important.
The value of the prefname field is relevant only if the readpol
attribute is set to prefer.
A dco_name specification names the data change object (DCO) to
associate with the volume.
DCOs [Toc] [Back]
Fields that can be specified for data change objects (DCOs) are:
tutil0, tutil1, tutil2, putil0, putil1, putil2, comment, log, and
dco_sp_num,
- 5 - Formatted: January 24, 2005
vxmake(1M) VxVM 3.5 vxmake(1M)
1 Jun 2002
A log specification defines the volume that is to be associated as a
DCO volume. A DCO volume tracks changes for the DCO. The following
example uses this field to associate myvol_dcl with the DCO
myvol_dco_obj:
vxmake dco myvol_dco_obj log=myvol_dcl
dco_sp_num stores the number of snap records that are associated with
the DCO.
RVG Records [Toc] [Back]
Fields that can be specified for RVGs are: tutil0, tutil1, tutil2,
putil0, putil1, putil2, comment, datavol, srl, rlink, primary, user,
group, mode.
There are no required fields for rvg records. All fields default to
zero (for numbers) or empty strings (for strings). The datavol
attribute is a list of the name or names (separated by a comma) of the
data volumes to be associated with the rvg. The srl attribute is the
name of the VERITAS Volume Replicator log volume to be associated with
the rvg. The rlink attribute is a list of name or names (separated by
a comma) of the RLINK to be associated with the rvg. The order of
RLINKs in the list is not important. Secondary RVGs can have at most
one RLINK. The primary attribute should be set to true for the primary
rvg and false for all secondary RVGs.
RLINK Records [Toc] [Back]
Fields that can be specified for RLINKs are: tutil0, tutil1, tutil2,
putil0, putil1, putil2, comment, synchronous, local_host, remote_host,
remote_dg, remote_rlink, timeout, packet_size, protocol,
latency_high_mark, latency_low_mark, latencyprot, srlprot
There are no required fields for RLINK records. All fields default to
zero (for numbers), empty strings (for strings), or off (for
synchronous, latencyprot and srlprot) with the exception of timeout,
packet_size, latency_high_mark, and latency_low_mark, which default to
some reasonable non-zero values. The timeout (milliseconds to wait for
connection timeouts) and packet_size (bytes per packet) attributes
should be tailored to the system on which VVR is running. The
remote_host attribute is the name of the remote primary or secondary
node. The remote_dg attribute is the name of the remote diskgroup. The
remote_rlink attribute is the name of the remote RLINK. The protocol
argument displays the transport protocol used by VVR, and is set to
the value of the system tunable parameter vol_vvr_transport (1 for
UDP, or 2 for TCP).
FSGEN and GEN Usage Types [Toc] [Back]
The fsgen and gen usage-type-specific utilities that support vxmake
are used by the switchout vxmake utility as filters that set defaults
for plex and volume states.
- 6 - Formatted: January 24, 2005
vxmake(1M) VxVM 3.5 vxmake(1M)
1 Jun 2002
Subdisk fields are set, checked, or modified as follows:
len Subdisk lengths are required to be set to a non-zero value.
tutil0 This field is cleared.
Plex fields are set, checked, or modified as follows:
tutil0 This field is cleared.
state If the plex is to be associated with a volume, the state
field is set to EMPTY; otherwise it is cleared.
Volume fields are set, checked, or modified as follows:
tutil0 This field is cleared.
state This field is set to EMPTY.
Attempts to associate an existing subdisk or plex with a new plex or
volume will be refused, unless the putil0 field for the existing
record is empty.
The putil0 fields are not set, and their contents are preserved.
RAID-5 Description [Toc] [Back]
The raid5 usage-type-specific utilities that support vxmake are used
by the switchout vxmake utility as filters that set defaults for plex
and volume states.
Subdisk fields are set, checked or modified as follows:
len Subdisk lengths are required to be set to a non-zero value.
tutil0 This field is cleared.
Plex fields are set, checked, or modified as follows:
tutil0 This field is cleared.
state If the plex is to be associated with a volume, the state
field is set to EMPTY; otherwise it is cleared.
Volume fields are set, checked, or modified as follows:
tutil0 This field is cleared.
state This field is set to EMPTY.
Attempts to associate an existing subdisk or plex with a new plex or
volume will be refused, unless the putil0 field for the existing
- 7 - Formatted: January 24, 2005
vxmake(1M) VxVM 3.5 vxmake(1M)
1 Jun 2002
record is empty.
The putil0 fields are not set, and their contents are preserved.
The raid5 specific vxmake utility will only allow one plex with a
layout of raid5 to be associated with a volume. Plexes not of the
raid5 layout are associated as RAID-5 log plexes.
EXAMPLES [Toc] [Back]
The following is an example of a vxmake description file:
#rectyp #name #options
sd disk3-01 disk=disk3 offset=0 len=10000
sd disk3-02 disk=disk3 offset=25000 len=10480
sd disk4-01 disk=disk4 offset=0 len=8000
sd disk4-02 disk=disk4 offset=15000 len=8000
sd disk4-03 disk=disk4 offset=30000 len=4480
plex db-01 layout=STRIPE ncolumn=2 stwidth=16k
sd=disk3-01:0/0,disk3-02:0/10000,disk4-01:1/0,disk4-02:1/8000,disk4-03:1/16000
sd ramd1-01 disk=ramd1 len=640
comment="Hot spot for dbvol"
plex db-02 sd=ramd1-01:40320
vol db usetype=gen plex=db-01,db-02
readpol=prefer prefname=db-02
comment="Uses mem1 for hot spot in last 5m"
This description specifies a gen type volume that contains two plexes:
a volatile memory disk plex (db-02), which is preferred, and a
physical disk plex (db-01). The memory disk plex is sparse and covers
only the last 640 sectors of the 40960-sector length of the volume.
The physical disk plex is striped across two 20480-sector columns.
Column zero contains two subdisks and column one contains three
subdisks. The plex offset specified for each subdisk concatenates the
subdisks contiguously in their respective columns.
Note: More than one attribute may be declared on a single line if
separated by one or more tabs or spaces. An attribute and its
specified values must be defined on the same line. Attributes that
are specified on lines subsequent to the first line for an object
definition must be preceded by one or more tabs or spaces.
For striped or RAID-5 plex subdisk associations, if one number is
specified for the column and column offset field, the number is
interpreted as a column number and the subdisk is associated at the
end of the column in the order it appears in the subdisk list. The
same subdisk association list for plex db-01 could be re-written as
follows:
- 8 - Formatted: January 24, 2005
vxmake(1M) VxVM 3.5 vxmake(1M)
1 Jun 2002
sd=disk3-01:0,disk3-02:0,disk4-01:1,disk4-02:1,disk4-03:1
The following is an example of a vxmake description file which
specifies an RVG that contains two RLINKs, two data volumes and an srl
volume:
#rectyp #name #options
rlink rl01 remote_host=egbert remote_dg=rootdg
remote_rlink=rl0A
rlink rl02 remote_host=robert remote_dg=rootdg
remote_rlink=rl0B
rvg rvg01 rlink=rl01,rl02 primary=true
datavol=vol02,vol03 srl=srl01
The following is a simple sequence of commands to create a hierarchy
with one subdisk, one plex, and one volume:
vxmake sd disk07-01 disk=disk07 len=10000 \
comment="disk07 subdisk 1"
vxmake plex demo-1 sd=disk07-01 \
comment="Demo volume, plex 1"
vxmake -U gen vol demo plex=demo-1 \
comment="Demo gen volume"
The next example shows how to use vxmake to create a volume with an
associated DCO object and DCO volume:
# First make the DCO volume
vxmake sd disk08-01 disk=disk08 len=264 \
comment="dco vol subdisk"
vxmake plex dco_plex-1 sd=disk07-01 \
comment="dco vol plex 1"
vxmake -U gen vol dcovol plex=dco_plex-1 \
comment="dco vol"
# Next make the DCO itself
vxmake dco Demo_dco log=dcovol \
comment="dco for Demo vol"
# Finally make the volume and associate the DCO with it
vxmake sd disk07-01 disk=disk07 len=10000 \
comment="disk07 subdisk 1"
vxmake plex demo-1 sd=disk07-01 \
comment="Demo volume, plex 1"
vxmake -U gen vol demo plex=demo-1 dco_name=Demo_dco \
comment="Demo gen volume"
- 9 - Formatted: January 24, 2005
vxmake(1M) VxVM 3.5 vxmake(1M)
1 Jun 2002
EXIT CODES [Toc] [Back]
The vxmake utility exits with a non-zero status if the attempted
operation fails. A non-zero 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.
FILES [Toc] [Back]
/usr/lib/vxvm/type/usetype/vxmake
Usage-type-specific utility for
filtering volume hierarchy descriptions.
SEE ALSO [Toc] [Back]
vxassist(1M), vxdisk(1M), vxdg(1M), vxintro(1M), vxmake(4)
- 10 - Formatted: January 24, 2005 [ Back ] |
