bp.conf file
The bp.conf is the master configuration file for the backup client software. With it the allowed servers and other options are included. On NetBackup UNIX clients, the main bp.conf file is located in the following pathname: /usr/openv/netbackup/bp.conf. As installed, NetBackup uses internal software defaults for all options in the bp.conf file, except SERVER. During installation, NetBackup sets the SERVER option to the name of the master server where the software is installed. Note The SERVER option must be in the /usr/openv/netbackup/bp.conf file on all NetBackup UNIX clients. It is also the only required entry in this file.
If a single UNIX system is running as both a client and a server, both the server and client options are in the /usr/openv/netbackup/bp.conf file.
Each nonroot user on a UNIX client can have a personal bp.conf file in their home directory as follows: $HOME/bp.conf The options in personal bp.conf files apply only to user operations. During a user operation, NetBackup checks the $HOME/bp.conf file before /usr/openv/netbackup/bp.conf. Root users do not have personal bp.conf files.
NetBackup uses the /usr/openv/netbackup/bp.conf file for root users. The following topics describe the options that you can specify in the /usr/openv/netbackup/bp.conf and $HOME/bp.conf files on a NetBackup UNIX client. Note PC clients provide similar options that you can change either through the client-user interface or in a configuration file, depending on the client.
ALLOW_NON_RESERVED_PORTS
Specifies that the NetBackup client daemon (bpcd) can accept remote connections from non-privileged ports (port numbers 1024 or greater). If this entry is not present, then bpcd requires remote connections to come from privileged ports (port numbers less than 1024). This option can be useful when NetBackup clients and servers are on opposite sides of a firewall. You can add this option to the /usr/openv/netbackup/bp.conf file on a UNIX client. In addition to adding ALLOW_NON_RESERVED_PORTS to the client, execute the following commands as root on the master server. cd /usr/openv/netbackup/bin/admincmd ./bpclient -client client_name -add -connect_nr_port 1 Where client_name is the name of the client where you added the ALLOW_NON_RESERVED_PORTS option. These commands instruct the master server to use nonprivileged ports.
BPARCHIVE_POLICY
Specifies the name of the policy to use for user archives. Default: BPARCHIVE_POLICY is not in any bp.conf file and NetBackup uses the first policy that it finds that has the client and a user archive schedule. For example: BPARCHIVE_POLICY = arch_1 You can add this option to the /usr/openv/netbackup/bp.conf and $HOME/bp.conf files on a UNIX client. The value in the user’s $HOME/bp.conf file takes precedence if it exists.
BPARCHIVE_SCHED
Specifies the name of the schedule for user archives. Default: BPARCHIVE_SCHED is not in any bp.conf file and NetBackup uses the first archive schedule in the first policy that it finds that has this client. For example BPARCHIVE_SCHED = user_arch1 You can add this option to the /usr/openv/netbackup/bp.conf and $HOME/bp.conf files on a UNIX client. The value in the user’s $HOME/bp.conf file takes precedence if it exists.
BPBACKUP_POLICY
Specifies the name of the policy name to use for user backups. Default: BPBACKUP_POLICY, is not in any bp.conf file and NetBackup uses the first policy it finds that has both the client and a user backup schedule. For example, BPBACKUP_POLICY = userback_1 You can add this option to the /usr/openv/netbackup/bp.conf and (or) $HOME/bp.conf files on a UNIX client. The value in user’s $HOME/bp.conf file takes precedence if it exists. NetBackup Configuration Options
BPBACKUP_SCHED
Specifies the name of the schedule to use for user backups. Default: BPBACKUP_SCHED is not in any bp.conf file and NetBackup uses the first policy it finds that has both the client and a user backup schedule. For example: BPBACKUP_SCHED = user_back1 You can add this option to the /usr/openv/netbackup/bp.conf and $HOME/bp.conf files on a UNIX client. The value in the user’s $HOME/bp.conf file takes precedence if it exists.
BUSY_FILE_ACTION
Note This parameter does not apply to Apollo clients. Directs the action that NetBackup performs on busy files when busy-file processing is enabled. You can add this option to the /usr/openv/netbackup/bp.conf and $HOME/bp.conf files on a UNIX client. The value in the user’s $HOME/bp.conf file takes precedence if it exists. There can be multiple entries of the following form: BUSY_FILE_ACTION = filename_template action_template Where
BUSY_FILE_DIRECTORY filename_template is the absolute pathname and file name of the busy file. The shell language metacharacters *, ?, [], [ - ] can be used for pattern matching of filenames or parts of filenames. BUSY_FILE_DIRECTORY action_template is one of the following: MAIL | mail Directs NetBackup to E-mail a busy file notification message to the user specified by the BUSY_FILE_NOTIFY_USER option. REPEAT | repeat [repeat_count] Directs NetBackup to retry the backup on the specified busy file. A repeat count can be specified to control the number of backup attempts. The default repeat count is 1. IGNORE | ignore Directs NetBackup to exclude the busy file from busy file processing.
BUSY_FILE_DIRECTORY
Note This parameter does not apply to Apollo clients. The BUSY_FILE_DIRECTORY option specifies the path to the busy-files working directory when busy-file processing is enabled. Default: BUSY_FILE_DIRECTORY is not in any bp.conf file and NetBackup creates the busy_files directory in /usr/openv/netbackup. You can add this option to the /usr/openv/netbackup/bp.conf and $HOME/bp.conf files on a UNIX client. The value in the user’s $HOME/bp.conf file takes precedence, if it exists.
BUSY_FILE_NOTIFY_USER
Note This parameter does not apply to Apollo clients. The BUSY_FILE_NOTIFY_USER option specifies the recipient of the busy file notification message when BUSY_FILE_ACTION is set to MAIL or mail. Default: BUSY_FILE_NOTIFY_USER is not in any bp.conf file and the E-mail recipient is root. You can add this option to the /usr/openv/netbackup/bp.conf and $HOME/bp.conf files on a UNIX client. The value in the user’s $HOME/bp.conf file takes precedence, if it exists.
BUSY_FILE_PROCESSING
Note This parameter does not apply to Apollo clients. The BUSY_FILE_PROCESSING option lets the user control the actions that NetBackup performs when it determines that a file is changing while it is being backed up. Default: BUSY_FILE_PROCESSING option is not in bp.conf and busy-file processing does not occur. (See “Busy-File Processing (UNIX Clients Only)” on page 449 for instructions on setting this option.) You can add this option to the /usr/openv/netbackup/bp.conf file on a UNIX client.
CLIENT_NAME
Specifies the name of the client as it is known to NetBackup. There can be one CLIENT_NAME entry and it must match the name used in the policy that is backing up the client. The only exception is for an alternate client restore, where the name must match that of the client whose files are being restored. (See “Allowing Redirected Restores” on NetBackup Configuration Options 486 NetBackup DataCenter System Administrator’s Guide - UNIX page 309.) The client installation procedures automatically set CLIENT_NAME to the value specified on the ftp_to_client or install_client command in the installation scripts. You can add this option to the /usr/openv/netbackup/bp.conf file on a UNIX client. It can also be added to a $HOME/bp.conf file on a UNIX client but this is normally done only for alternate-client restores. If the value is not in any bp.conf file, NetBackup uses the value returned by the gethostname() library function.
CLIENT_PORT_WINDOW
Specifies the range of nonreserved ports on this computer that are used for connecting to NetBackup on other computers. (See “CLIENT_PORT_WINDOW” on page 467.)
CLIENT_READ_TIMEOUT
Specifies the number of seconds for the client-read timeout on a server or a database agent. (See “CLIENT_READ_TIMEOUT” on page 467.)
CLIENT_RESERVED_PORT_WINDOW
Specifies the range of reserved ports on this computer that are used for connecting to NetBackup on other computers. (See “CLIENT_RESERVED_PORT_WINDOW” on page 468.)
COMPRESS_SUFFIX
Note This option has a reasonable default and has to be changed only if problems are encountered. This option does not apply to Apollo clients. Specifies a list of file extensions. During a backup, NetBackup does not compress files with these extensions because the file can already be in a compressed format. Default, COMPRESS_SUFFIX is not in the bp.conf file. (See “Compression” on page 112 for more information on compressing files.) You cannot use wildcards when specifying these extensions. For example, you can specify the following: .A1 You cannot specify either of the following: .A* or .A[1-9] You can add this option to the /usr/openv/netbackup/bp.conf file on a UNIX client.
CRYPT_OPTION
Note CRYPT_OPTION applies only to clients that have the NetBackup Encryption option installed. See the NetBackup Encryption System Administrator’s Guide.
CRYPT_OPTION specifies the encryption options on NetBackup clients. NetBackup creates this entry automatically in the /usr/openv/netbackup/bp.conf file on a UNIX client when you run the bpinst_crypt command on the NetBackup master server. Do not alter the entry or create this file manually unless it has been accidentally deleted. The allowable values follow: DENIED|denied Specifies that the client does not permit encrypted backups. If the server requests an encrypted backup, it is considered an error. This option is the default for a client that has not been configured for encryption. ALLOWED|allowed Specifies that the client allows either encrypted or unencrypted backups. REQUIRED|required Specifies that the client requires encrypted backups. If this value is specified and the server requests an unencrypted backup, it is considered an error.
CRYPT_STRENGTH
Note CRYPT_STRENGTH applies only to clients that have the NetBackup Encryption option installed. See the NetBackup Encryption System Administrator’s Guide. Specifies the encryption strength on NetBackup clients. NetBackup creates this entry automatically in the /usr/openv/netbackup/bp.conf file on a UNIX client when you run the bpinst_crypt command on the NetBackup master server. Do not alter the entry or create it manually unless it has been accidentally deleted. The possible values follow: DES_40|des_40 Specifies 40-bit DES encryption. This is the default value for a client that has not been configured for encryption. DES_56|des_56 NetBackup Configuration Options 488 NetBackup DataCenter System Administrator’s Guide - UNIX Specifies 56-bit DES encryption.
CRYPT_LIBPATH
Note CRYPT_LIBPATH applies only to clients that have the NetBackup Encryption option installed. See the NetBackup Encryption System Administrator’s Guide. Specifies the directory that contains the encryption libraries for NetBackup clients. NetBackup creates this entry automatically in the /usr/openv/netbackup/bp.conf file on a UNIX client when you run the bpinst_crypt command on the NetBackup master server. Do not alter the entry or create it manually unless it has been accidentally deleted. BUSY_FILE_DIRECTORY The following is the default value on UNIX systems: /usr/openv/lib/ BUSY_FILE_DIRECTORY The following is the default value on Windows systems: install_path\bin\ Where install_path is the directory where NetBackup is installed and by default is C:\Program Files\VERITAS. BUSY_FILE_DIRECTORY The following is the default value on Macintosh systems: :System Folder:Extensions:
CRYPT_KEYFILE
Note CRYPT_KEYFILE applies only to clients that have the NetBackup Encryption option installed. See the NetBackup Encryption System Administrator’s Guide. Specifies the file that contains the encryption keys on NetBackup clients. NetBackup creates this entry automatically in the /usr/openv/netbackup/bp.conf file on a UNIX client when you run the bpinst_crypt command on the NetBackup master server. Do not alter the entry or create it manually unless it has been accidentally deleted. The default values follow: BUSY_FILE_DIRECTORY On UNIX systems: /usr/openv/netbackup/keyfile BUSY_FILE_DIRECTORY On Windows systems: install_path\bin\keyfile.dat Where install_path is the directory where NetBackup is installed and by default is C:\Program Files\VERITAS. Chapter 10, Additional Configuration 489 NetBackup Configuration Options BUSY_FILE_DIRECTORY On Macintosh systems: :System Folder:Preferences:NetBackup:keyfile
DISALLOW_SERVER_FILE_WRITES
Prevents the NetBackup server from creating files on the NetBackup client. For example, this prevents server-directed restores or server-directed updates of the bp.conf file on the client. You can add this option to the /usr/openv/netbackup/bp.conf file on a UNIX client. By default, server writes are allowed.
DO_NOT_RESET_FILE_ACCESS_TIME
Note DO_NOT_RESET_FILE_ACCESS_TIME does not apply to Apollo clients. This setting affects software and administration scripts that examine a file’s access time. DO NOT use this option or USE_CTIME_FOR_INCREMENTALS if you are running Storage Migrator on the system. Setting these options causes the atime for files to be updated every time they are backed up. This makes it appear as if the files are frequently used and stops Storage Migrator from selecting them for migration. Specifies that if a file is backed up, its access time (atime) will show the time of the backup. Default: NetBackup preserves the access time by resetting it to the value it had before the backup. You can add this option to the /usr/openv/netbackup/bp.conf file on a UNIX client.
GENERATE_ENGLISH_LOGS
Enables the generation of an English error log, and English trace logs for the bparchive, bpbackup, bpduplicate, bpimport, and bprestore commands. This option is useful to support personnel assisting in distributed environments where differing locales result in logs with various languages. You can add this option to the /usr/openv/netbackup/bp.conf file on NetBackup servers and clients.
INFORMIX_HOME
Specifies the path to the Informix home directory and is required when the client is using NetBackup for Informix. NetBackup Configuration Options 490 NetBackup DataCenter System Administrator’s Guide - UNIX You must add this option to the /usr/openv/netbackup/bp.conf file on UNIX clients that are running NetBackup for Informix.
INITIAL_BROWSE_SEARCH_LIMIT
Reduces the default number of days back that NetBackup searches for files to restore. You can add this option to the /usr/openv/netbackup/bp.conf file on NetBackup master servers and clients. (See “INITIAL_BROWSE_SEARCH_LIMIT” on page 472.)
KEEP_DATABASE_COMM_FILE
Causes NetBackup to keep database agent logs for seven days. Default: NetBackup keeps database agent logs for only one day. You can add this option to the /usr/openv/netbackup/bp.conf file on a UNIX database agent (for example, a client that is running NetBackup for Informix). KEEP_LOGS_DAYS Specifies the number of days to keep job and progress logs generated by the NetBackup Java program, Backup, Archive, and Restore. NetBackup writes these files in the usr/openv/netbackup/logs/user_ops/username/jobs and /usr/openv/netbackup/logs/user_ops/username/logs directories. There is a directory for each user that uses the Backup, Archive, and Restore program. Default: Three days. You can add this option to the /usr/openv/netbackup/bp.conf file on a UNIX client. LIST_FILES_TIMEOUT Specifies the number of minutes to wait for a response from the NetBackup server when listing files by using the client-user interface or bplist. If this time is exceeded, the user receives a socket read failed error even if the server is still processing the user’s request. Default: LIST_FILES_TIMEOUT is not in any bp.conf file and NetBackup uses a value of 30 minutes. You can add this option to the /usr/openv/netbackup/bp.conf and $HOME/bp.conf files on a UNIX client. The value in the user’s $HOME/bp.conf file takes precedence if it exists.
LOCKED_FILE_ACTION
Note This parameter does not apply to Apollo clients. Specifies the behavior of NetBackup when it tries to back up a file that has mandatory file locking enabled in its file mode (see chmod(1)). If LOCKED_FILE_ACTION is specified and has a value of SKIP (the only legal value), NetBackup skips files that currently have mandatory locking set by another process and logs a message to this effect. You can add this option to the /usr/openv/netbackup/bp.conf files on a UNIX client. Default: NetBackup waits for files to become unlocked.
MEDIA_SERVER
Specifies that the listed machine is a media server only. Machines listed as media servers can back up and restore clients, but have limited administrative privileges.
MEGABYTES_OF_MEMORY
Note This option does not apply to Apollo clients. This option has a reasonable default and has to be changed only if problems are encountered. Specifies how much memory is available on the client to use when compressing files during backup. If you select compression, the client software uses this value to determine how much space to request for the compression tables. The more memory that is available to the compress code, the greater the compression. The percentage of machine resources used is also greater. If other processes also need memory, it is generally best to use a maximum value of 1/2 the actual physical memory on a machine to avoid excessive swapping. You can add this option to the /usr/openv/netbackup/bp.conf file on a UNIX client. Default: NetBackup assumes a value of one megabyte.
NFS_ACCESS_TIMEOUT
Specifies the number of seconds that the backup process waits when processing an NFS mount table before considering an NFS file system unavailable. You can add this option to the /usr/openv/netbackup/bp.conf file on a UNIX client. Default: Timeout period is five seconds. Note Only NetBackup DataCenter can back up NFS-mounted files. NetBackup Configuration Options 492 NetBackup DataCenter System Administrator’s Guide - UNIX
RANDOM_PORTS
Specifies whether NetBackup chooses port numbers randomly or sequentially when it requires one for communication with NetBackup on other computers. (See “RANDOM_PORTS” on page 168.)
RESTORE_RETRIES
Note This option has a reasonable default and will have to be changed only if problems are encountered. Specifies the number of times to retry a restore after a failure. Default: There are no retries. You can add this option to the /usr/openv/netbackup/bp.conf file on a UNIX client.
REQUIRED_INTERFACE
Specifies the network interface that NetBackup uses when connecting to another NetBackup client or server. (See “REQUIRED_INTERFACE” on page 168.)
SERVER_PORT_WINDOW
Specifies the range of nonreserved ports on which this computer accepts connections from NetBackup on other computers.
SERVER
Defines the list of NetBackup master servers and media servers that can access the NetBackup client. During client installation, the SERVER is set to the name of the primary master server for this client. Other SERVER entries can be added for any other master servers for this client, and for media servers for this client. (Media servers for this NetBackup client can also be added using the MEDIA_SERVER option.) If you configure media servers, you must have a SERVER or MEDIA_SERVER entry for each media server in the NetBackup client’s bp.conf file. The following is an example bp.conf file on a client: SERVER = Master_server (default master server) SERVER = NBU_server (other master server) SERVER = Media_server_#1 MEDIA_SERVER = Media_server_#2 . . . The first SERVER entry denotes the master server to which the client would connect by default for any requests (for example, backing up, listing or restoring files). The SERVER option must be present in the /usr/openv/netbackup/bp.conf file on all UNIX clients. It is also the only required entry in the bp.conf file for clients. This option is not used in a $HOME/bp.conf file. On NetBackup UNIX servers, the SERVER entry applies to the both the client and the server. SYBASE_HOME Specifies the path to the Sybase home directory and is required when using NetBackup for Sybase to back up Sybase databases. Default: SYBASE_HOME is not in the bp.conf file. You must add this option to the /usr/openv/netbackup/bp.conf file on a NetBackup for Sybase client.
USE_CTIME_FOR_INCREMENTALS
Note If you specify USE_CTIME_FOR_INCREMENTALS, you must also specify
DO_NOT_RESET_FILE_ACCESS_TIME
DO NOT use these options if you are running Storage Migrator on the system. Setting these options causes the atime for files to be updated every time they are backed up. This makes it appear as if the files are frequently used and stops Storage Migrator from selecting them for migration. Causes NetBackup client software to use both modification time (mtime) and inode change time (ctime) during incremental backups to determine if a file has changed. You can add this option to the /usr/openv/netbackup/bp.conf file on a UNIX client. Default: NetBackup uses only mtime.
USEMAIL
Specifies the E-mail address where NetBackup sends status on the outcome of operations for a UNIX client. Default: USEMAIL is not present in any bp.conf file and no E-mail is sent. Note You can use multiple addresses or an E-mail alias as long as there are no blanks or white space between them. You can add this option to the /usr/openv/netbackup/bp.conf and $HOME/bp.conf files on a UNIX client. NetBackup Configuration Options BUSY_FILE_DIRECTORY If the /usr/openv/netbackup/bp.conf file specifies an address, NetBackup sends automatic backup and manual backup status to that address. BUSY_FILE_DIRECTORY If the $HOME/bp.conf file specifies an address, NetBackup also sends status on the success or failure of user operations to that address.
VERBOSE
Causes NetBackup to include more information in its logs. Default: Disabled. You can add this option to the /usr/openv/netbackup/bp.conf file on a UNIX client.
UNIX Client Examples
Example /usr/openv/netbackup/bp.conf File
SERVER = hare
CLIENT_NAME = freddie
USEMAIL = abc@bdev.com
COMPRESS_SUFFIX = .Addrs
COMPRESS_SUFFIX = .Counts
VERBOSE
RESTORE_RETRIES = 1
BPBACKUP_POLICY = U1userdir
BPBACKUP_SCHED = userbackups
BPARCHIVE_POLICY = U1userdir
BPARCHIVE_SCHED = userarchives
LOCKED_FILE_ACTION = SKIP
Example $HOME/bp.conf File
Nonroot users on UNIX clients can have a personal bp.conf file in their home directory.
A personal bp.conf file can have any of the following options
Note A root user cannot have a personal bp.conf file. For root users, NetBackup uses
the /usr/openv/netbackup/bp.conf file.
USEMAIL = mars@bdev.com
BPBACKUP_POLICY = user1
BPBACKUP_SCHED = userback
BPARCHIVE_POLICY = user1
BPARCHIVE_SCHED = userarch
LIST_FILES_TIMEOUT = 10
CLIENT_NAME
Page Owner: Christopher Manders
Suggestions
