bppolicynew

bppolicynew — create, copy, or rename a NetBackup policy

SYNOPSIS

<admin_dir_path>bppolicynew policy_name [-verbose] [-M master_server,...]

<admin_dir_path>bppolicynew policy_name -sameas existing_policy_name [-verbose] [-M master_server,...]

<admin_dir_path>bppolicynew existing_policy_name -renameto policy_name [-verbose] [-M master_server,...]

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

DESCRIPTION

bppolicynew performs one of the following operations on a NetBackup policy:

  • Create a new policy with default attribute values.

  • Create a new policy with the same attributes as an existing policy.

  • Rename an existing policy.

When bppolicynew runs without -sameas or -renameto, it creates a new NetBackup policy with default attribute values. If -M is present, the defaults that are used for the policy definition on each master server are the defaults for that master server.

bppolicynew copies a policy by adding a new policy to the NetBackup database. The clients, files, schedules, and attributes for the new policy are the same as those for the existing policy. bppolicynew does not create a policy copy with the same name as an existing policy.

If bppolicynew renames a policy, the existing association of images with the policy is lost. This means that the images that were created before the policy was renamed are not included in a list of images for the renamed policy. The command does not rename a policy with the same name as an existing policy.

bpplinfo replaces the policy-attribute defaults with new values. bpplclients, bpplinclude, and bpplsched define the clients, backup files, and schedules for the policy. A policy needs to have at least one client, one file specification, and one automatic schedule before it can run automatic backups.

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

Authorized user can initiate this command.

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

See the NetBackup Administrator's Guide for additional information on policies.

OPTIONS

policy_name

Specifies the name of a NetBackup policy that bppolicynew creates or the name to which bppolicynew changes an existing policy. The option has no default value.

This policy name must differ from any existing policy name. It is composed of numeric, alphabetic, plus, minus, underscore, and period characters. Do not use a minus as the first character or leave spaces between characters.

existing_policy_name

The name of a NetBackup policy that already exists when bppolicynew runs. The option does not have a default value.

-renameto

Change the name of the existing policy to the new policy name.

-sameas

Create a new policy by copying its characteristics from the existing policy.

-help

Prints a command-line usage message.

-M master_server,...

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

-verbose

Select verbose mode for logging. This option is meaningful only when it runs with the debug log function (that is, when the following directory is defined):

Windows systems: install_path\NetBackup\logs\admin
policy_name

Specifies the name of a NetBackup policy that bppolicynew creates or the name to which bppolicynew changes an existing policy. The option has no default value.

This policy name must differ from any existing policy name. It is composed of numeric, alphabetic, plus, minus, underscore, and period characters. Do not use a minus as the first character or leave spaces between characters.

existing_policy_name

The name of a NetBackup policy that already exists when bppolicynew runs. The option does not have a default value.

-renameto

Change the name of the existing policy to the new policy name.

-sameas

Create a new policy by copying its characteristics from the existing policy.

-help

Prints a command-line usage message.

-M master_server,...

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

-verbose

Select verbose mode for logging. This option is meaningful only when it runs with the debug log function (that is, when the following directory is defined):

Windows systems: install_path\NetBackup\logs\admin

EXAMPLES

Note that references to Follow NFS Mounts in these examples apply only to NetBackup Enterprise Server.

EXAMPLE 1

Create a policy with default attribute values on the master server plim:

# bppolicynew ishkabibble -M plim
# bppllist ishkabibble -U -M plim
------------------------------------------------------------
  Policy Name:		 ishkabibble
  Policy Type:		 Standard
  Active:			yes
  Client Compress:	 no
  Follow NFS Mounts:   no
  Cross Mount Points:  no
  Collect TIR info:	no
  Block Incremental:   no
  Mult. Data Streams:  no
  Client Encrypt:	no
  Policy Priority:	0
  Max Jobs/Policy:	99
  Disaster Recovery:   0
  Residence:		 (specific storage unit not required)
  Volume Pool:		 NetBackup
  Keyword:			 (none specified)

  Clients:	(none defined)

  Include:	(none defined)

  Schedule:	 (none defined)

EXAMPLE 2

Create a new policy, mypolicy_copy from the existing policy mypolicy. bppllist shows that mypolicy_copy has the same attributes as mypolicy. For brevity, most of the schedule information is omitted here:

# bppolicynew mypolicy_copy -sameas mypolicy
# bppllist mypolicy_copy -U
------------------------------------------------------------
Policy Name:		mypolicy_copy
  Policy Type:		Standard
  Active:			yes
  Client Compress:	 no
  Follow NFS Mounts:   no
  Cross Mount Points:  no
  Collect TIR info:	no
  Block Incremental:   no
  Mult. Data Streams:  no
  Client Encrypt:	no
  Policy Priority:	0
  Max Jobs/Policy:	 99
  Disaster Recovery:	0
  Residence:		 myunit
  Volume Pool:		 NetBackup
  Keyword:			 (none specified)

  HW/OS/Client:  Linux		 RedHat		zippity
 
  Include:  /tmp/my

  Schedule:		full
	Type:			Full Backup
	Frequency:	 every 7 days
	Maximum MPX:	 1
	Retention Level: 0 (1 week)
	Residence:	 (specific storage unit not required)
	Volume Pool:	 (same as policy volume pool)
	Daily Windows:
		Sunday	 00:00:00  -->  Sunday	 08:00:00
		Monday	 00:00:00  -->  Monday	 08:00:00
		Tuesday	00:00:00  -->  Tuesday	08:00:00
		Wednesday  00:00:00  -->  Wednesday  08:00:00
		Thursday   00:00:00  -->  Thursday   08:00:00
		Friday	 00:00:00  -->  Friday	 08:00:00
		Saturday   00:00:00  -->  Saturday   08:00:00

  Schedule:		incr
	Type:			Differential Incremental Backup
# bppolicynew mypolicy_copy -sameas mypolicy
# bppllist mypolicy -U
------------------------------------------------------------
Policy Name:		mypolicy
  Policy Type:		 Standard
  Active:			yes
  Client Compress:	 no
  Follow NFS Mounts:   no
  Cross Mount Points:  no
  Collect TIR info:	no
  Block Incremental:   no
  Mult. Data Streams:  no
  Client Encrypt:	no
  Policy Priority:	0
  Max Jobs/Policy:	 99
  Disaster Recovery:	0
  Residence:		 myunit
  Volume Pool:		 NetBackup
  Keyword:			 (none specified)

  HW/OS/Client:  Linux		 RedHat		zippity
			
  Include:  /tmp/my

  Schedule:		full
	Type:			Full Backup
	Frequency:	 every 7 days
	Maximum MPX:	 1
	Retention Level: 0 (1 week)
	Residence:	 (specific storage unit not required)
	Volume Pool:	 (same as policy volume pool)
	Daily Windows:
		Sunday	 00:00:00  -->  Sunday	 08:00:00
		Monday	 00:00:00  -->  Monday	 08:00:00
		Tuesday	00:00:00  -->  Tuesday	08:00:00
		Wednesday  00:00:00  -->  Wednesday  08:00:00
		Thursday   00:00:00  -->  Thursday   08:00:00
		Friday	 00:00:00  -->  Friday	 08:00:00
		Saturday   00:00:00  -->  Saturday   08:00:00

  Schedule:		incr
	Type:			Differential Incremental Backup

# bppllist mypolicy_copy -U
------------------------------------------------------------
Policy Name:		mypolicy_copy
  Policy Type:		Standard
  Active:			yes
  Client Compress:	 no
  Follow NFS Mounts:   no
  Cross Mount Points:  no
  Collect TIR info:	no
  Block Incremental:   no
  Mult. Data Streams:  no
  Client Encrypt:	no
  Policy Priority:	0
  Max Jobs/Policy:	99
  Disaster Recovery:   0
  Residence:		 myunit
  Volume Pool:		 NetBackup
  Keyword:			 (none specified)

  HW/OS/Client:  Linux		 RedHat		zippity

  Include:  /tmp/my

  Schedule:		full
	Type:			Full Backup
	Frequency:	 every 7 days
	Maximum MPX:	 1
	Retention Level: 0 (1 week)
	Residence:	 (specific storage unit not required)
	Volume Pool:	 (same as policy volume pool)
	Daily Windows:
		Sunday	 00:00:00  -->  Sunday	 08:00:00
		Monday	 00:00:00  -->  Monday	 08:00:00
		Tuesday	00:00:00  -->  Tuesday	08:00:00
		Wednesday  00:00:00  -->  Wednesday  08:00:00
		Thursday   00:00:00  -->  Thursday   08:00:00
		Friday	 00:00:00  -->  Friday	 08:00:00
		Saturday   00:00:00  -->  Saturday   08:00:00

  Schedule:		incr
	Type:			Differential Incremental Backup

EXAMPLE 3

Rename a policy from policy_old to policy_new. Before and after the renaming, bppllist shows the policies in the NetBackup configuration database:

   bppllist
	 mypolicy
	 policy_old
	 test
	bppolicynew policy_old -renameto policy_new
	bppllist
	 mypolicy
	 policy_new
	 test

RETURN VALUES

An exit status of zero (0) means that the command ran successfully.

Any exit status other than zero (0) means that an error occurred.

If the administrative log function is enabled, bppllist logs the exit status in the administrative daily log under the log directory:

Windows systems: install_path\NetBackup\logs\admin

It has the following form:

bppolicynew: EXIT status = exit status

If an error occurred, a diagnostic precedes this message.

FILES

Windows systems:

install_path\NetBackup\logs\admin\*
install_path\NetBackup\db\policy\policy_name

SEE ALSO

bpplclients, bpplinfo, bpplsched, bppldelete, bppllist