bpplinclude

bpplinclude — maintain list of files automatically backed up by NetBackup policy

SYNOPSIS

<admin_dir_path>bpplinclude policy_name [-v] [-M master_server,...] -L | -l [-generation generation]

<admin_dir_path>bpplinclude policy_name [-v] [-M master_server,...] [-generation generation] -add pathname ... | -add -f filename | -delete pathname ... | -delete -f filename | -modify old_pathname new_pathname ...

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

DESCRIPTION

bpplinclude maintains the policy file list for a NetBackup policy. The policy file list is the list of files that are backed up when NetBackup runs an automatic backup for the policy. The policy file list does not apply to user backups or archives since users select the files when they start those operations.

bpplinclude performs one of the following operations:

Adds the pathnames to the policy file list
Deletes the pathnames from the policy file list
Modifies the pathnames in the policy file list
Displays the policy file list for a policy

The -add, -delete, and -modify options include a list of pathnames. The list of pathnames must be the final part of the bpplinclude command line. The pathname must be the entire path from the root of the file system to the desired location.

For the absolute pathname syntax for your client type, refer to the pathname rules topics in the NetBackup Administrator's Guide.

The last part of the path can be a file name, a directory name, or a wildcard specification. You can enclose pathnames in quotes. Use enclosing quotes if the pathname contains special characters or a wildcard specification.

Filepath rules do not verify the existence of the input directories or files. NetBackup backs up only the files it finds and does not require that all entries in the list be present on every client.

See the NetBackup Administrator's Guide for additional information on policy file lists.

For database extensions, the input entries are scripts. NetBackup runs these during the backup. See the NetBackup guide that comes with the extension product for additional information.

The added entries to the policy file list can be directives, rather than pathnames for the following: certain policy attributes (such as Allow multiple data streams) and extension products (such as NetBackup for NDMP).

Refer to the NetBackup Administrator's Guide or the NetBackup guide for the extension product.

The options -l and -L produce nearly identical displays of the policy file list.

bpplinclude sends its error messages to stderr. bpplinclude sends a log of its activities to the NetBackup admin log file for the current day.

Authorized users can initiate this command.

For more information about NetBackup authorization, refer to the NetBackup Security and Encryption Guide.

OPTIONS

-add pathname ...

Adds the specified pathname to the policy file list. The pathname can be a directory, a file name, a script, or a directive.

A pathname must be enclosed in quotes (") if it contains special characters, such as blank(" "), or a wildcard specification. Use a blank to separate two pathnames, not a comma. bpplinclude interprets a comma as part of the pathname; it concatenates two or more comma-delimited pathnames into a single pathname with embedded commas. The command does not verify the syntax or the existence of the pathnames.

-add -f filename

Adds all files that are listed in filename to the policy file list.

-delete pathname

Deletes the specified pathnames from the policy file list. Refer to -add for the pathname-list syntax. If you delete a pathname from the policy file list, you still can recover any backups or archives for that pathname. This option must be the final entry on the command line.

-delete -f filename

Deletes all the listed file in filename from the policy file list.

-generation generation

Ensures that the command acts on a specific generation or version of a policy. The generation value increments each time a policy is saved. Use bpplinfo or bppllist to list the current generation value. If no generation is indicated, the command acts on the current version.

-L

Displays the contents of the policy file list in long format.

-l

Displays the contents of the policy file list in compact format.

Note:

The -l and -L displays are similar.

-modify {old_path_name new_path_name}

Modifies an entry in the policy file list. The values are a list of pathname pairs {old_path_name new_path_name}. For each pathname pair, new_name_path replaces old_name_path in the policy file list. If no list entry matches old_path_name, then new_path_name is not entered into the policy file list. Refer to the -add option for the pathname syntax. Delimit the list entries with spaces, both within a pathname pair and between pathname pairs. This option must be the final entry on the command line.

-M master_server,...

A list of master servers. This list is a comma-separated list of hostnames. If this option is present, the command is run on each of the master servers in this list. The master servers must allow access by the system that issues the command. If an error occurs for any master server, the process stops at that point in the list. The default is the master server for the system where the command is entered.

policy_name

Specifies the policy for which the policy file list is to be set.

-v

Selects verbose mode for logging. This option is meaningful only when you run with the debug log function on ( that is, when the following directory is defined):

Windows systems: install_path\NetBackup\logs\admin

EXAMPLES

EXAMPLE 1

While the backup runs on another master server kiwi, display the policy file list for policy oprdoc_policy on the master server plim:

# bpplinclude oprdoc_policy -L -M plim

  Include:	c:\oprdoc (Windows systems)

EXAMPLE 2

Add and delete the pathnames that include one wildcard entry to illustrate bpplinclude's interpretation of wildcards:

Windows systems:
# bpplinclude mkbpolicy -add C:\yap C:\y*
# bpplinclude mkbpolicy -L
	 Include: C:\yap
	 Include: C:\y*/y*
# bpplinclude mkbpolicy -delete C:\y*
# bpplinclude mkbpolicy -L
	 Include: C:\yap

Note:

bpplinclude does not interpret the wildcard entry y* for -delete as meaning that both yap and y* should be deleted. Only y* is deleted from the include list for mkbpolicy. The interpretation of the wildcard occurs when NetBackup selects files to back up, during the actual backup.

EXAMPLE 3

Add two entries to the policy file list for a policy, and then modify them:

Windows systems:
# bpplinclude mkbpolicy -add "C:\ima file" "C:\ura file"
# bpplinclude mkbpolicy -L
	 Include: C:\ima file
	 Include: C:\ura file
# bpplinclude mkbpolicy -modify "C:\ima file" "C:\ima file 2" 
"C:\ura file" "C:\ura file 2"
# bpplinclude mkbpolicy -L
  Include: C:\ima file 2
  Include: C:\ura file 2

EXAMPLE 4

Add a raw partition to the policy file list for the policy rc (UNIX clients). The full path name for the device is used (the command is all on one line):

bpplinclude rc -add /devices/sbus@2,0/dma@2,81000/esp@2,80000/ 
sd@6,0:h,raw

See the Adding UNIX Raw Partitions to the File List section of the NetBackup Administrator's Guide.

EXAMPLE 5

Display the policy file list for the policy mkb_policy:

# bpplinclude mkb_policy -l

Windows systems:
	INCLUDE C:\services
	INCLUDE C:\aliases
	INCLUDE C:\Programs

FILES

Windows systems:

install_path\NetBackup\logs\admin\*
install_path\NetBackup\dv\policy\policy_name\includes