nsrconsolidate(8)
nsrconsolidate(8)
NAME
nsrconsolidate - NetWorker program for synthetic full and rehydrated
tape out.
SYNOPSIS
nsrconsolidate [ -v ] [ -n ] [ -q ] [ -V ] -c client -N save set [ -J
source storage node ] [ -d destination storage node ] [
-b pool ] [ -g group ] [ -w browse time ] [ -y retention
time ] [ -t start time ] [ -e end time ] [ -i on | off ]
[ -f dirfile ]
nsrconsolidate [ -v ] [ -n ] [ -q ] [ -V ] [ -J source storage node ] [
-d destination storage node ] [ -b pool ] [ -g group ] [
-w browse time ] [ -y retention time ] [ -t start time ]
[ -e end time ] [ -i on | off ] [ -f dirfile ] { -C -I
input_file | client:save set ... }
nsrconsolidate [ -v ] [ -n ] [ -q ] [ -V ] [ -J source storage node ] [
-d destination storage node ] [ -b pool ] [ -g group ] [
-w browse time ] [ -y retention time ] [ -t start time ]
[ -e end time ] [ -i on | off ] [ -f dirfile ] [ -R ] {
-S -I input_file | ssid[/cloneid] ... }
DESCRIPTION
The nsrconsolidate program creates a synthetic full backup from a pre-
viously created full backup and subsequent incremental backups. This
new backup is equivalent to a full backup taken at the time of the lat-
est incremental backup that was used in constructing the synthetic full
save set. Since it is built from existing backups, a synthetic full
backup does not burden the original client with the overhead of
another traditional full backup.
Normally, nsrconsolidate is invoked within savegrp(8) as part of a
synth_full or incr_synth_full level backup. See savegrp(8) for more
information. nsrconsolidate can be invoked manually to run a synthetic
full backup when required, or to rehydrate individual Avamar deduplica-
tion save sets.
For consistency, nsrconsolidate checks the source save set instances to
ensure that the specified client:save set-name can be used to create a
synthetic full. The following requirements apply to each non-full save
set to be used for the synthetic full save set:
1) The save set must be browsable and complete. Any checkpoint-
restarted save sets must contain all parts to form a completed save.
2) The save set must contain the save set extended attribute
*anchor save set time. Note that this attribute only appears in
the save set record for NetWorker 8.0 and later clients. Full
save sets are not anchored to another save set, so a pre-8.0
full save set might be usable with 8.0 or later non-full save
sets for nsrconsolidate.
3) The save set must have the client attribute Backup renamed
directory enabled.
4) The save sets must form a complete chain of save sets that are
linked through their anchor save set time attribute to a full
backup.
When these criteria are met, a restore list (rlist) is built from the
index entries for each client:save set-name. The NetWorker server is
contacted to obtain information such as which storage node shall write
the synthetic full save set. The nsrrecopy(8) backend program is then
spawned using the NetWorker jobs monitoring APIs (nsrjobd(8)) for each
client:save set-name on the target storage node. The XDR encoded rlist
is sent to the backend to perform the synthetic full or rehydration
operation using the recover piped to save model. Status updates from
the backend are returned via nsrjobd.
nsrconsolidate requires the source save sets to be specified using one
of the following options:
-c and -N
-C
-S
To identify a synthetic full save set, two additional extended save set
attributes are created in the save set record:
*source save set times
*Synthetic full
For any Avamar deduplication save sets that are participating in a syn-
thetic full operation, the data will be rehydrated automatically during
the recover part of the synthetic full operation for saving to the tar-
get volume.
Individual Avamar deduplication save set can be rehydrated with option
-R -S <ssid>. The new rehydrated save set will retain the same backup
level, and *anchor save set time and *backup start time extended
attributes as the original deduplication save set. To identify a rehy-
drated save set, two additional extended attributes are created in the
save set record:
*Rehydrated
*source save set times.
All of the deduplication save sets that are participating in a syn-
thetic full operation must be backed up to the same Avamar deduplica-
tion node. In order to create a synthetic full from save sets that
were backed up to more than one Avamar deduplication node, the save
sets from the second and third (etc) Avamar node must be rehydrated by
using the -R -S options first, then followed by synthetic full opera-
tion (with the -c & -N, or -C, or -S option).
OPTIONS
-b pool name
Specifies the destination media pool to store the new synthetic
full or rehydrated save set. For more information, see
nsr_pool(5).
-c client
Specifies the name of the client whose save set is to be
included for the synthetic full operation. This option must be
specified with -N. Only one client can be specified.
-C client:save set-name
Specifies a list of clients and save sets (in <client:save set-
name> format) for the synthetic full operation. The list can be
supplied on the command line or through the -I input_file.
-d destination storage node
Specifies the destination storage node where the backend pro-
gram, nsrrecopy(8) is intended to run. By default, the Net-
Worker server determines the destination storage node based on
the storage node affinity list of the client. See nsr_stor-
age_node(5) and nsr_client(5) for more information.
-e end time
Specifies the end time (in nsr_getdate(3) format) to select save
sets for the synthetic full operation. This option can only be
used with the -S, -c & -N, and -C options. If not specified,
end time is set as the current time. Note that -e 0 is same as
-e today.
-f dirfile
Instructs nsrconsolidate to read the directives (see nsr_direc-
tive(5)) from "dirfile" and apply them to the files in the syn-
thetic full save sets or files rehydrated from the Avamar dedu-
plication save sets. For synthetic full operation, <dirfile>
may contain both UNIX and Windows save set paths, which will be
used as a global directive during one invocation of nsrconsoli-
date. Directives are applied to the recovered stream during the
save operation of recover piped to save.
The only supported directives are aes (for encryption) and com-
pressasm. See uasm(8) for more information.
When rehydrating, directives should only be used when writing to
a non-Data Domain device or volume. This can be accomplished by
specifying the -b option with a pool containing non-Data Domain
volumes. See nsr_pool(5) for more information.
To apply the aes directive to the root path, follow this
example of a directive file:
<</>>
+aes: *
To apply directives to specific subtrees, follow this example
of a directive file:
<<"H:\TechDocs\important">>
+compressasm: *
<</engineering/docs>>
+aes: *
-g group name
This option is used by savegrp to specify the group name of the
synthetic full. This is similar to the save command, and is
used by the NetWorker server to select the specific media pool.
-i on | off
This option specifies whether on-line file index entries will be
generated for the new synthetic full or Avamar rehydrated save
set. Specify "on" to generate on-line file index, "off" to sup-
press index generation. There is a corresponding option "store
index entries" in the NSR pool resource, see nsr_pool(5) for
more information.
If the -i option is not specified when rehydrating Avamar save
sets with the -R and -S options, the default is to suppress
index generation. When performing a synthetic full operation
(that is, without the -R option), the default is to generate
index entries when the -i option is omitted.
recover -S or scanner can be used to recover from any save set
without indexes. See recover(8) and scanner(8) for more
details.
-I input_file
Specifies the input filename that is used by nsrconsolidate pro-
gram to read the "client:save set-name" pairs or save set iden-
tifiers (ssid) for the synthetic full or rehydration operation.
Each entry must be separated by a newline. This option is sup-
ported with -C or -S, but cannot be specified with -c & -N.
-J source storage node
Specifies which host to use as the storage node for the recovery
part of the synthetic full operation (see nsr_storage_node(5)).
The host specified must be included in "recover storage nodes"
or "storage nodes" attribute of server's client resource. See
nsr_client(5) for more information. By default, the NetWorker
server determines the recover storage node.
-n Do not execute. This option causes nsrconsolidate to verify that
the save set criteria are met, send a request to the server, and
build the rlist without spawning the backend program which would
perform the actual synthetic full or rehydration operation.
-N save set-name
Specifies the name of the save set that is used for the syn-
thetic full operation. This option must be specified with the -c
option. Only one client and save set-name can be specified.
Use the -C option to specify multiple clients and/or save sets.
-q Runs quietly.
-R Rehydrates one or more Avamar deduplication save sets. This
option requires the -S option to specify the save set ssid's to
be rehydrated.
See the -i option for the default behavior of index generation.
-S ssid
Specifies a list of full and incremental save sets for synthetic
full in ssid[/cloneid] format. The list can be supplied on the
command line or by the -I input_file option. When specified
with the -R option, the Avamar deduplication save sets will be
rehydrated. Any Avamar deduplication save set can be rehydrated
individually, regardless of its backup level.
You can find the ssid of a save set by using the mminfo -v com-
mand (see mminfo(8)). If there are multiple copies (clones) of
a save set, you can choose which specific copy to read by using
the ssid/cloneid format. In this case, the ssid and cloneid are
separated by a single slash (/). You can find the cloneid for a
particular copy by using the mminfo -S report, or a custom
report.
-t start time
Specify the start time (in nsr_getdate(3) format) to exclude
save sets that are older than this date from the synthetic full
operation. This option can only be used with the -S, -c & -N,
or -C options. If not specified, start time is set as end time
- 24 hours. Note that -t 0 is same as -t today. When specify-
ing a time range, at least -t or -e option must be specified.
-v Enable verbose operation. In this mode, additional messages are
displayed about the operation. This option will be passed to
the backend program to enable its verbosity.
-w browse time
Sets the date (in nsr_getdate(3) format) after which the new
synthetic full save set will no longer be browsable. By
default, the server determines the browse date for the save set
based on the browse policies in effect. This option allows
overriding the existing policies.
-y retention time
Sets the date (in nsr_getdate(3) format) when the new synthetic
full save set will become recyclable. The special value forever
is used to indicate that a volume that never expires (i.e. an
archive volume) must be used. By default, the server determines
this date for the save set based on the retention policies in
effect. This option allows overriding the existing policies.
See also nsrmm(8) and its -S & -e options.
-V Causes nsrconsolidate to verify the save set after a successful
synthetic full operation. This option is ignored when rehydrat-
ing Avamar save set with the -R and -S options.
EXAMPLES
To create a synthetic full for save set /dev/daily on client mars:
nsrconsolidate -c mars -N /dev/daily
To create synthetic fulls for save set /jupiter_files on client
jupiter, and save set /saturn_files on client saturn:
nsrconsolidate -C jupiter:/jupiter_files saturn:/saturn_files
To rehydrate all Avamar deduplication save sets for client mars and
create the new save sets in pool 'rehydrate_pool':
nsrconsolidate -b rehydrate_pool -R -S `mminfo -c mars -q dedupe
-r ssid`
SEE ALSO
nsr_getdate(3), nsr_client(5), nsr_device(5), nsr_pool(5),
nsr_directive(5), nsr_storage_node(5), mminfo(8), nsr(8), nsrd(8),
nsrmmd(8), nsrjobd(8), nsrrecopy(8), recover(8), scanner(8).
DIAGNOSTICS
The exit status is zero if a synthetic full operation is successful for
all of the requested save sets, non-zero otherwise.
Several messages are printed which signal that nsrd(8) is unavailable
for a synthetic full operation. The following messages might also dis-
play:
Cannot contact media database
The media database and other NetWorker services on the named
server are not answering queries. The server might need to be
started, or if it was just started, it might need to finish its
startup checks before answering queries.
cannot open nsrconsolidate session with server
This message is printed when the server does not accept syn-
thetic full sessions.
You are not authorized to run this command
Only NetWorker administrators are allowed to run nsrconsolidate.
NetWorker administrators are listed in the NSR server resource,
see nsr_service(5) for more information.
ssid[/cloneid] 'number' is not valid
The given save set identifier is not valid. Two forms are
understood: simple save set identifiers and those with a cloneid
specified. Simple save sets are unsigned numbers. The save set
with the cloneid form is specified as two unsigned numbers sepa-
rated by a single slash (/).
waiting 30 seconds then retrying
A temporary error occurred and nsrconsolidate will automatically
retry the request until the condition is cleared. For example,
an error will occur if all devices are busy saving or recovering
and nsrconsolidate must wait for these devices to become avail-
able.
Save set <ssid> (<client>:<save set>) invalid for this operation
The listed save set does not meet the criteria for nsrconsoli-
date. Information describing the specific criteria failure will
be appended to the message.
NetWorker 8.0.1 Dec 02, 12 nsrconsolidate(8)