vxtemplate

NAME

vxtemplate - install and administer volume templates and template sets

SYNOPSIS

DESCRIPTION

The vxtemplate utility provides a command line interface for administering the volume templates and template sets that are used with the VERITAS Intelligent Storage Provisioning (ISP) feature of VERITAS Volume Manager (VxVM).

The operations that can be performed by vxtemplate are selected by specifying the appropriate keyword on the command line. See the KEYWORDS section for a description of the available operations.

Most operations can be performed either on a configuration database if the -C option is specified, or on a single storage pool which is associated with a disk group. If a disk group is not specified by using the -g option, the default disk group that is aliased by defaultdg is selected.

KEYWORDS

activate

Activates one or more templates in a disk group or storage pool.

deactivate

Deactivates one or more templates in a disk group or storage pool.

help

Displays information on vxtemplate usage, keywords or options.

install

If the -C option is specified, installs one or more templates and/or capabilities in the configuration database.

Otherwise, install one or more templates, capabilities and/or template sets in the specified disk group and/or storage pool.

list

If the -C option is specified, lists templates, capabilities, template sets, storage pool sets and/or storage pool definitions in the configuration database.

Otherwise, lists templates, capabilities and/or template sets that are installed in the specified disk group and/or storage pool.

listcapabilities

If the -C option is specified, lists capabilities in the configuration database.

Otherwise, lists capabilities in the specified disk group and/or storage pool.

listpooldefinitions

List the storage pool definitions in the configuration database.

listpoolsets

List the storage pool sets in the configuration database.

listtemplates

If the -C option is specified, lists templates in the configuration database.

Otherwise, lists templates in the specified disk group and/or storage pool.

listtemplatesets

List the template sets in the configuration database.

print

If the -C option is specified, prints details of the templates and/or capabilities in the configuration database.

Otherwise, prints details of the templates and/or capabilities in the specified disk group and/or storage pool.

printcapabilities

If the -C option is specified, prints details of the capabilities in the configuration database.

Otherwise, prints details of the capabilities in the specified disk group and/or storage pool.

printpooldefinitions

Print details of the storage pool definitions in the configuration database.

printpoolsets

Print details of the storage pool sets in the configuration database.

printtemplates

If the -C option is specified, prints details of the templates in the configuration database.

Otherwise, prints details of the templates in the specified disk group and/or storage pool.

printtemplatesets

Prints details of the template sets in the configuration database.

renamecapability

Renames a capability.

renametemplate

Renames a template.

uninstall

If the -C option is specified, uninstalls templates and/or capabilities from configuration database.

Otherwise, uninstalls templates, capabilities and/or template sets from the specified disk group and/or storage pool.

OPTIONS

-C

Performs an operation on the configuration database.

-d file

Specifies a file from which to install templates and/or capabilities.

-g diskgroup

Specifies a disk group by name or ID for an operation. If this option is not specified, and an alternate default disk group is not defined by specifying the diskgroup attribute on the command line or in a defaults file (usually /etc/default/allocator), the default disk group is determined using the rules given in the vxdg(1M) manual page.

-i

Prevents activation of a template on installation.

-p storage_pool

Specifies a storage pool for an operation.

-r

Performs the install and uninstall operations recursively.

EXAMPLES

List all templates that are installed in the disk group mydg:

List the templates t1 and t2, and the capabilities c1 and c2 that are installed in the storage pool mypool within the disk group mydg:

List all elements that are defined in the configuration database:

Print details of the template t1 and the capability c1 for the default disk group:

Print details of the templates Template1 and Template2, and the capability C1 from the configuration database:

Rename the template mytemplate installed in disk group mydg as template1:

Install the templates from the file template1.txt into the configuration database:

Install the templates HardwareReliable and SoftwareReliable, and the capability Reliable from the file template1.txt into the configuration database:

Install the templates t1 and t2, and the capabilities c1 and c2 into the disk group mydg:

Recursively uninstall the templates temp1 and temp2, and the capability cap1 from the configuration database:

List all the template sets known to the system:

Print details of the template sets ts1 and ts2.

EXIT STATUS

The vxtemplate 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.

NOTES

If a template is associated with any ISP volumes, you cannot dissociate the template from a storage pool, or uninstall the template from a disk group without first deleting the volumes. To display which templates are associated with ISP volumes, use the following command:

SEE ALSO

vxpool (1M), vxusertemplate (1M), vxvoladm (1M)

VERITAS Storage Foundation Intelligent Storage Provisioning Administrator's Guide