share/man/man4/ndmp.4

   1 '\" te
   2 .\" Copyright (C) 2009, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright 2014 Nexenta Systems, Inc.  All rights reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   5 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
   6 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH NDMP 4 "Feb 24, 2014"
   8 .SH NAME
   9 ndmp \- configuration properties for Solaris Network Data Management Protocol
  10 (NDMP) server
  11 .SH DESCRIPTION
  12 .sp
  13 .LP
  14 The behavior of the Solaris NDMP server is specified by property values that
  15 are stored in the Service Management Facility, \fBsmf\fR(5).
  16 .sp
  17 .LP
  18 An authorized user can use the \fBndmpadm\fR(8) command to set global values
  19 for these properties in SMF.
  20 .sp
  21 .LP
  22 You can set the following properties by using the \fBndmpadm set\fR command:
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fBbackup-quarantine\fR\fR
  27 .ad
  28 .RS 24n
  29 Backup the files marked as quarantined by AV. Acceptable values are \fByes\fR
  30 or \fBno\fR. The default is \fBno\fR.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fBdar-support\fR\fR
  37 .ad
  38 .RS 24n
  39 Set the Direct Access Recovery mode. Acceptable values are \fByes\fR or
  40 \fBno\fR. The default is \fBno\fR.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBdebug-path\fR\fR
  47 .ad
  48 .RS 24n
  49 The path to which to save the debug log. The default is \fB/var/log/ndmp\fR.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBdebug-mode\fR\fR
  56 .ad
  57 .RS 24n
  58 Enable or disable debug log messages.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBdump-pathnode\fR\fR
  65 .ad
  66 .RS 24n
  67 Enable or disable backing up the directories containing modified files or
  68 directories in \fBdump\fR(1) backup format. Acceptable values are yes or no.
  69 The default is no.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBignore-ctime\fR\fR
  76 .ad
  77 .RS 24n
  78 Determines whether the change timestamp (\fBctime\fR) of files and directories
  79 is used to determine whether a file should be backed up in level backup. If
  80 this parameter is set to \fByes\fR, only the modification time (\fBmtime\fR) of
  81 the file or directory determines whether it should be backed up. Acceptable
  82 values are \fByes\fR or \fBno\fR. The default value is \fBno\fR.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBoverwrite-quarantine\fR\fR
  89 .ad
  90 .RS 24n
  91 Restore quarantined files on top of current files if they already exist.
  92 Acceptable values are \fByes\fR or \fBno\fR. The default value is \fBno\fR.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBrestore-quarantine\fR\fR
  99 .ad
 100 .RS 24n
 101 Restore the files that had been marked as quarantined by AV and are backed up.
 102 Acceptable values are yes or no. The default value is no.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBtar-pathnode\fR\fR
 109 .ad
 110 .RS 24n
 111 Enable or disable backing up the directories containing modified files or
 112 directories in \fBtar\fR(1) backup format. Acceptable values are \fByes\fR or
 113 \fBno\fR. The default value is \fBno\fR.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBtoken-maxseq\fR\fR
 120 .ad
 121 .RS 24n
 122 Set the maximum sequence number for subsequent token-based incremental backup
 123 in NDMP-V4. The default value is \fB9\fR. There are two limits for this value:
 124 soft-limit, which is \fB59\fR, and hard-limit, equal to \fB64\fR. If the token
 125 sequence number, passed by the DMA, is between the soft and hard limits, a
 126 warning message is issued to the DMA. The token sequence number can never
 127 exceed the hard-limit value.
 128 .RE
 129
 130 .sp
 131 .ne 2
 132 .na
 133 \fB\fBversion\fR\fR
 134 .ad
 135 .RS 24n
 136 Set the maximum active NDMP protocol version. Valid values are currently
 137 \fB2\fR, \fB3\fR, and \fB4\fR. The default is \fB4\fR.
 138 .RE
 139
 140 .sp
 141 .LP
 142 The following property can only be set when using the \fBndmpadm enable\fR or
 143 \fBndmpadm disable\fR command:
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fBauth-type\fR\fR
 148 .ad
 149 .RS 13n
 150 Sets the password encryption type for the authentication of local users. Valid
 151 values are \fBcram-md5\fR or \fBcleartext\fR.
 152 .RE
 153
 154 .SH ATTRIBUTES
 155 .sp
 156 .LP
 157 See \fBattributes\fR(5) for descriptions of the following attributes:
 158 .sp
 159
 160 .sp
 161 .TS
 162 box;
 163 c | c
 164 l | l .
 165 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 166 _
 167 Interface Stability     Committed
 168 .TE
 169
 170 .SH SEE ALSO
 171 .sp
 172 .LP
 173 \fBdump\fR(1), \fBtar\fR(1), \fBndmpadm\fR(8), \fBndmpd\fR(8),
 174 \fBattributes\fR(5), \fBsmf\fR(5)