vxtemplate(1M)															    vxtemplate(1M)

NAME

       vxtemplate - install and administer volume templates and template sets

SYNOPSIS

       vxtemplate [-g diskgroup] [-P storage_pool] 
	   activate template=t1[,t2...]

       vxtemplate [-g diskgroup] [-P poolname] 
	   deactivate template=t1[,t2...]

       vxtemplate help [keywords | options]

       vxtemplate [-C | -g diskgroup] [-ir] 
	   [-d file] [-P storage_pool]
	   install [template=t1[,t2...]] 
	   [capability=c1[,c2...]] 
	   [template_set=ts1[,ts2...]]

       vxtemplate [-C | -g diskgroup] [-P storage_pool] 
	   list [template=t1[,t2...]] 
	   [capability=c1[,c2...]] 
	   [template_set=ts1[,ts2...]] 
	   [storage_pool_set=ps1[,ps2...]]
	   [pool_definition=pd1[,pd2...]]

       vxtemplate [-C | -g diskgroup] [-P storage_pool] [-r] [-w] 
	   listcapability [c1 [c2 ...]]

       vxtemplate listpooldefinition [pd1 [pd2 ...]]

       vxtemplate listpoolset [ps1 [ps2 ...]]

       vxtemplate [-C | -g diskgroup] [-P storage_pool] 
	   listtag template=template_name

       vxtemplate [-C | -g diskgroup] [-P storage_pool] [-r] [-w] 
	   listtemplate [t1 [t2 ...]]  [tag=tagname[=tagvalue]] ...

       vxtemplate listtemplateset [template=t1[,ts2...]]  [ts1 [ts2 ...]]

       vxtemplate [-C | -g diskgroup] [-P storage_pool] 
	   print [template=t1[,t2...]] 
	   [capability=c1[,c2...]] 
	   [template_set=ts1[,ts2...]] 
	   [storage_pool_set=ps1[,ps2...]] 
	   [pool_definition=pd1[,pd2...]]

       vxtemplate [-C | -g diskgroup] [-P storage_pool] 
	    printcapability [c1 [c2 ...]]

       vxtemplate printpooldefinition [pd1 [pd2 ...]]

       vxtemplate printpoolset [ps1 [ps2 ...]]

       vxtemplate [-C | -g diskgroup] [-P storage_pool] 
	   printtemplate [t1 [t2 ...]]

       vxtemplate printtemplateset [ts1 [ts2 ...]]

       vxtemplate [-g diskgroup] renamecapability c1 c2

       vxtemplate [-g diskgroup] renametemplate t1 t2

       vxtemplate [-C | -g diskgroup] [-P storage_pool] [-r] 
	   uninstall [template=t1[,t2...]] 
	   [capability=c1[,c2...]] 
	   [template_set=ts1[,ts2...]]

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,  one  or  more  templates,	capabilities and/or template sets are installed in the specified disk group and/or storage
		 pool.

		 Templates are installed recursively to resolve any dependencies.

		 Note: By default, installing a template also activates the template unless the -i option is specified.

       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.

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

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

		 If the -r (recursive) option is specified, lists all capabilities that depend on the specified capabilities.

		 If  the  -w  (whole)  option is specified, lists all capabilities on which the specified capabilities depend (that is, whcih make
		 them complete).

       listpooldefinition
		 List the storage pool definitions in the configuration database.

       listpoolset
		 List the storage pool sets in the configuration database.

       listtag	 Lists the tags that are referenced in the specified template.

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

		 Otherwise, lists templates in the specified disk group and storage pool, and which have the specified tag name and  optional  tag
		 value.

		 If  one or more template names and the -r (recursive) option are specified, lists all templates that depend on the specified tem-
		 plates.

		 If one or more template names and the -w (whole) option are specified, lists all templates which the specified  templates  depend
		 (that is, which make them complete).

       listtemplateset
		 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.

		 If  a	list  of templates is specified to the template attribute, only the template sets that contain the specified templates are
		 listed.

       printcapability
		 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.

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

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

       printtemplate
		 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.

       printtemplateset
		 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, templates, capabilities and/or template sets are uninstalled from the specified disk group and/or storage pool.

		 Templates are uninstalled recursively where this is possible without breaking any dependencies.

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:

	      vxtemplate -g mydg listtemplate

       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:

	      vxtemplate -g mydg -P mypool list template=t1,t2 capability=c1,c2

       List all elements that are defined in the configuration database:

	      vxtemplate -C list

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

	      vxtemplate print template=t1 capability=c1

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

	      vxtemplate -C print template=Template1,Template2 capability=c1

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

	      vxtemplate -g mydg renametemplate mytemplate template1

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

	      vxtemplate -C -d template1.txt install

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

	      vxtemplate -C -d template1.txt install
		template=HardwareReliable,SoftwareReliable 
		capability=Reliable

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

	      vxtemplate -g mydg install template=t1,t2 
		capability=c1,c2

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

	      vxtemplate -C -r uninstall template=temp1,temp2 
		capability=cap1

       List all the template sets known to the system:

	      vxtemplate listtemplateset

       Print details of the template sets ts1 and ts2.

	      vxtemplate printtemplateset ts1 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:

	      vxvoladm -g diskgroup printintent volume_name ...

SEE ALSO

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

       Veritas Storage Foundation Intelligent Storage Provisioning Administrator's Guide

VxVM 5.0.31.1							    24 Mar 2008 						    vxtemplate(1M)