nbstl

nbstl — add, delete, modify, or list NetBackup storage lifecycle policies

SYNOPSIS

<admin_dir_path>nbstl storage_lifecycle_name [-add | -modify | -modify_current | -modify_version] [-dc class] [-dp duplication_priority] [-version version_number]

[-uf used_for1 [,used_for2,..used_forn]]

[-source source1[,source2,..sourcen]]

[-residence storage_unit1 | __NA__[,storage_unit2 | __NA__,..storage_unitn | __NA__]]

[-pool volume_pool1 | __NA__[,volume_pool2 | __NA__,..volume_pooln | __NA__]]

[-server_group host1 | __NA__[,host2 | __NA__,..hostn | __NA__]]

[-managed m1[,m2,..mn]]

[-rl retention_level1 [,retention_level2,...retention_leveln]]

[-as alt_read_server1 | __NA__ [,alt_read_server2 | __NA__,...alt_read_servern | __NA__]]

[-mpx preserve_mpx1 | __NA__[,preserve_mpx2 | __NA__,...preserve_mpxn | __NA__]] [-v] [-M master_server]

<admin_dir_path>nbstl storage_lifecycle_name -delete [-v] [-M master_server]

<admin_dir_path>nbstl [storage_lifecycle_name] -L | -l | -b [-v] [-M master_server] [-all_versions] [-version version_number]

On Windows systems, <admin_dir_path> is <install_path>\NetBackup\bin\admincmd\

DESCRIPTION

The nbstl command can do the following:

  • -add adds a new storage lifecycle.

  • -delete deletes an existing storage lifecycle.

  • -modify modifies an existing storage lifecycle.

  • -L or -l lists one or all storage lifecycles. -b lists the storage lifecycle policy names and their version numbers.

    The nbstl command creates, modifies, or deletes all of the destinations at the same time and does not support adding or modifying single destinations. To change properties of one destination, all of the existing destinations must be accounted for as well as the destination to be updated.

    Many of the options that need to be entered for a destination may not be applicable (NA). In that case, enter the value as __NA__ (double underscores before and after NA). The following options accept __NA__ as a value:

    • -residence

    • -pool

    • -server_group

    • -as (alternate read server)

    • -mpx

OPTIONS

-all_versions

Displays all versions of the specified storage lifecycle policy or all storage lifecycle policies if storage_lifecycle_name is not specified.

-b

Displays the name and version number of the specified storage lifecycle policy or all storage lifecycle policies if storage_lifecycle_name is not specified.

-dc class

Specifies the numeric data classification that is associated with this service.

-delete

Deletes the specified storage lifecycle policy.

-dp duplication_priority

Specifies the duplication job priority that is associated with this Storage Service.

storage_lifecycle_name

Identifies the name of the storage lifecycle policy to be created, modified, deleted, or displayed.

-l

Displays the condensed output of the specified storage lifecycle policy, or all storage lifecycle policies if storage_lifecycle_name is not specified. The output contains only data for the storage lifecycle. It does not identify the name.

-L

Displays the long output of the specified storage lifecycle, or all storage lifecycles if storage_lifecycle_name is not specified. It identifies the output by name.

-M master_server

Specifies the NBU master server. The default is the local server.

-modify

Modifies the specified storage lifecycle policy. This option creates a new version of the storage lifecycle policy. You can modify information such as pool volume or retention level.

-modify_current

Modifies the current version of the storage lifecycle policy instead of creating a new policy. This option cannot be used with the - dc, -uf, -source, or - managed options.

-modify_version

Modifies the selected version (nn) of the storage lifecycle policy instead of creating a new policy. This option cannot be used with the - dc, -uf, -source, or - managed options.

-v

Selects the verbose mode for logging.

-version nn

Displays only the specified version number (nn) of the storage lifecycle policy or all storage lifecycle policies if storage_lifecycle_name is not specified.

The following destination options must all specify the same number of parameters, one for each destination of the Storage Service. The resulting number of destinations equals the number of parameters. The parameters are separated by commas with no blank spaces between them.

-managed m,...

The capacity-managed flag for each destination. The possible values are the following:

  • 0 - Disable capacity management.

  • 1 - Enable capacity management.

  • 2 - Expire After duplication. Used if the destination has been configured as a source for other duplication(s). This value suggests that the copy from that destination should be expired and removed from the storage once the duplications are done. This selection cannot be used if the destination is not a source to any other duplications.

-mpx preserve_mpx1 | __NA__[,preserve_mpx2 | __NA__,..preserve_mpxn | __NA__]

Sets the preserve multiplexing flag for duplication copies. This option is not allowed for backup or snapshot copies. Settings in the policy host and storage unit properties determine the backup copies multiplexed state. The flag is only relevant for tape copies. The option is -mpx followed by a set of commas that are separated by the following values:

  • F or f - Do not preserve multiplexing for the copy

  • T or t - Preserve multiplexing for the copy, if possible.

  • __NA__ - Not applicable

-pool volume_pool1 | __NA__[,volume_pool2 | __NA__,..volume_pooln | __NA__]

Specifies the volume pool for each destination. Volume pools do not apply to disk copies.

-residence storage_unit1 | __NA__[,storage_unit2 | __NA__,..storage_unitn | __NA__]

The storage unit that is to be used for each destination. Storage units do not apply to snapshot destinations.

-rl retention_level1 [,retention_level,...retention_level]

The retention level (0-24) applied to each destination.

-servergroup host1 | __NA__[,host2 | __NA__,..hostn | __NA__]

Specifies the server group.

-as alt_read_server1 | __NA__ [,alt_read_server2 | __NA__,..alt_read_servern | __NA__]

The alternate read server for each destination. Alternate read servers apply only to duplication destinations.

-source source1[,source2,...sourcen]

Configures a hierarchy of duplications for the -add and -modify operations of storage lifecycle.

Accepted values for -source are the following:

  • Backup and snapshot destinations - value must be 0. Backup and snapshot copies do not require a "source".

  • Duplication destinations - the serial number of the destination from the list of destinations to be used as the source copy. (A snapshot copy cannot be used as the source for a duplication.) Duplication destinations that do not use any specific source (that is, they use the primary copy as the source), must be set to 0.

-uf used_for1 [used_for2,...used_forn]

Specifies when each destination is used. Use one of the following values:

  • 0 - backup

  • 1 - duplication

  • 2 - snapshot

EXAMPLES

EXAMPLE 1

The following example lists information on lifecycle1:

# nbstl lifecycle1 -L 
							 Name: lifecycle1
			Data Classification: Gold
		 Duplication job priority: 0
							State: active
Destination 1			 Use for: backup
					 Storage Unit: adv_dsu1
					Volume Pool: (none specified)
					 Server Group: (none specified)
				 Retention Type: Fixed
				 Retention Period: 1 (2 hours)
			Alternate Read Server: (none specified)
			Preserve Multiplexing: false
							State: inactive
						 Source: (client)

The storage unit named adv_dsu1 is inactive. Values for "State" in the -L display are either active or inactive.

EXAMPLE 2

The following example creates a lifecycle named HDLifecyle1. This lifecycle has a data classification of Gold. It contains the following four destinations:

  • A backup destination (-uf value is 0) with storage unit AdvDisk1 which does not require any source (-source value is 0).

  • A backup destination using storage unit DataDomain1.

  • A duplication destination (-uf value is 1) with storage unit DataDomain2 that uses destination at serial number 1 (i.e. the backup destination with storage unit DataDomain1) as a source (-source value is 1).

  • A duplication destination with storage unit cooperstown-tape1 that uses the destination at serial number 2 (i.e. the duplication destination with storage unit DataDomain2) as the source (-source value is 2).

# nbstl HDLifecycle1 -add -dc Gold -uf 0,0,1,1,1 -residence AdvDisk1,
DadaDomain1,DataDomain2,cooperstown-tape1 -source 0,0,1,2

EXAMPLE 3

This example creates a lifecycle that does snapshot with backup to disk and then duplication to tape. The disk storage unit is DskSTU and the tape storage unit is TpSTU.

# nbstl LCPolicy -dc Gold -uf 0,1,2 -residence DskStU,TpSTU,__NA__ 
-pool NetBackup,DLP_Pool1,__NA__ -managed 0,0,0 -rel 6,12,1

Data retention is defined as follows:

  • Snapshot images are retained for one week.

  • Backup images on disk are retained for six (6) months.

  • Tape images are retained for five (5) years.

  • The user has defined retention level 12 to be five (5) years.

EXAMPLE 4

This example changes the retention level for existing version 4 of the lifecycle:

# nbstl LCPolicy -modify_version -version 4 -rl 4,6,7,7

The storage lifecycle policy must have four destinations previously defined.

EXAMPLE 5

This example lists the condensed contents of version 2 of LCPolicy:

# nbstl LCPolicy -l -version 2

EXAMPLE 6

This example changes the fields in the current version of the storage lifecycle policy SLP8:

# nbstl SLP8 -modify_current -pool Pool1,Pool2,Pool3 -as __NA__,
AltReadServer2,__NA__ -mpx F,F,T

SEE ALSO

nbdc, nbstlutil