Name
vmpool — manage volume pools
SYNOPSIS
[-h EMM_server | volume_database_host] -list_all [-b|-bx] | -list_scratch | -list_catalog_backup | -create -pn pool_name -description description [-mpf mpf_max] | -update -pn pool_name [-description description] [-reason "string"] [-mpf mpf_max] | -delete pool_name | -set_scratch pool_name | -unset_scratch pool_name | -set_catalog_backup pool_name | -unset_catalog_backup pool_name
On UNIX systems, the directory path to this command is /usr/openv/volmgr/bin/
On Windows systems, the directory path to this command is install_path\Volmgr\bin\
DESCRIPTION
Use this command to add, change, delete, or list volume pools.
The -h option is not required, but you must choose one and only one of the other seven options (for example, -list_scratch).
Any authorized user can run this command.
For more information about NetBackup authorization, refer to the NetBackup Security and Encryption Guide.
OPTIONS
- -h EMM_server | volume_database_host
This option applies only to the NetBackup Enterprise Server.
Specifies the name of the Enterprise Media Manager database host that contains information about volumes. If no host is specified, the configured EMM server is used by default.
- -list_all [-b | -bx]
Lists the information about all volume pools. Use the -b or -bx option to specify a brief format for volume pool information.
- -list_scratch
Lists all configured scratch pools and the pool index number.
- -list_catalog_backup
Lists the volume pool to be used for catalog backup.
- -create -pn pool_name -description description -mpf mpf_max
Adds a new volume pool. Optionally limits the number of partially full media to be used in this pool by using -mpf. The default value is zero (0), which indicates that the number of partially full media is unlimited.
The -description option describes the volume pool. Double quote marks are required if the description contains any spaces.
- -update -pn pool_name [-description description] [-mpf mpf_max]
Changes an existing volume pool. Optionally limits the number of partially full media to be used in this pool by using -mpf. The default value is zero (0), which indicates that the number of partially full media is unlimited.
The -description option describes the volume pool. Double quote marks are required if the description contains any spaces.
- -delete pool_name
Deletes a volume pool.
- -reason "string"
Indicates the reason why you perform this command action. The reason text string that you enter is captured and appears in the audit report. Enclose this string with double quotes ("...") and do not exceed 512 characters. The string cannot begin with a dash character (-) nor contain a single quotation mark (').
- -set_scratch pool_name
If pool_name is a previously defined volume pool, pool_name becomes the scratch pool, and its description is not changed. The NetBackup, Datastore, Catalog Backup, and None volume pools cannot be changed to scratch pools.
If pool_name is a new volume pool, a new pool is created with "Scratch Pool" as the description.
Only one scratch pool at a time can be defined.
- -unset_scratch pool_name
Undefines pool_name as the scratch pool and defines it as a regular volume pool. The pool can be deleted by using vmpool -delete pool_name.
- -set_catalog_backup pool_name
Specifies the volume pool to back up the NetBackup catalog. You can also create a dedicated catalog backup pool to be used for catalog policies. A dedicated catalog volume pool reduces the number of needed tapes during catalog restores since catalog backup media are not mixed with other backup media.
- -unset_catalog_backup pool_name
Defines a volume pool that you do not want to use to back up the NetBackup catalog.
NOTES
Only limited validation of the option parameters is done.
A pool cannot be both a scratch pool and Catalog Backup pool.
The -add and -change options have been deprecated. They can still be used, but do not set the mpf value.
EXAMPLES
Example 1 - Add a new pool named MyPool on the host that is named llama. It has the default host, user ID, and group ID permissions:
vmpool -create -pn MyPool -description "description with spaces" -mpf 17
Example 2 - List all pools that are configured on the host where the command is executed:
vmpool -list_all -b