293 useradd/del/mod should be ZFS-aware
[illumos-gate.git] / usr / src / man / man1m / dsbitmap.1m
blobeac1e0d6a74a7ae9834c5ead7eae2eb86e3e0a71
1 '\" te
2 .\" Copyright (c) 2007, Sun Microsystems, Inc.  All rights reserved.
3 .\" 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.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" 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 fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH DSBITMAP 1M "Oct 2, 2007"
7 .SH NAME
8 dsbitmap \- size Availability Suite bitmap volumes
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBdsbitmap\fR \fB-h\fR
13 .fi
15 .LP
16 .nf
17 \fBdsbitmap\fR \fB-p\fR \fIdata_volume\fR [\fIbitmap_volume\fR]
18 .fi
20 .LP
21 .nf
22 \fBdsbitmap\fR \fB-r\fR \fIdata_volume\fR [\fIbitmap_volume\fR]
23 .fi
25 .SH DESCRIPTION
26 .sp
27 .LP
28 The \fBdsbitmap\fR command calculates the size of the Availability Suite bitmap
29 volume required for use with the specified data volume.
30 .SH OPTIONS
31 .sp
32 .LP
33 The following options are supported:
34 .sp
35 .ne 2
36 .na
37 \fB\fB-h\fR\fR
38 .ad
39 .sp .6
40 .RS 4n
41 Prints the usage message for the \fBdsbitmap\fR command
42 .RE
44 .sp
45 .ne 2
46 .na
47 \fB\fB-p\fR \fB\fIdata_volume\fR\fR \fB[\fIbitmap_volume\fR]\fR\fR
48 .ad
49 .sp .6
50 .RS 4n
51 For the given \fIdata_volume\fR, \fBdsbitmap\fR calculates and display the
52 required size for the associated Availability Suite Point in Time bitmap
53 volume. The bitmap volume sizes for all possible Availability Suite Point in
54 Time set configurations are displayed. These configurations include Independent
55 shadow, Full size dependent shadow, and Compact dependent shadow. If the
56 optional \fIbitmap_volume\fR argument is supplied, \fBdsbitmap\fR determines if
57 this volume is large enough to be used as the bitmap volume for
58 \fIdata_volume\fR.
59 .RE
61 .sp
62 .ne 2
63 .na
64 \fB\fB-r\fR \fB\fIdata_volume\fR\fR \fB[\fIbitmap_volume\fR]\fR\fR
65 .ad
66 .sp .6
67 .RS 4n
68 For the given \fIdata_volume\fR, \fBdsbitmap\fR calculates and displays the
69 required size for the associated Availability Suite Remote Mirror bitmap
70 volume. The bitmap volume sizes for all possible Availability Suite Remote
71 Mirror set configurations are displayed. These configurations include Sync
72 replication,  Async replication with memory queue, disk queue and 32 bit
73 refcount.   If the optional \fIbitmap_volume\fR argument is supplied,
74 \fBdsbitmap\fR determines if this volume is large enough to be used as the
75 bitmap volume for \fIdata_volume\fR.
76 .RE
78 .SH USAGE
79 .sp
80 .LP
81 \fBdsbitmap\fR is typically used by the system administrator during the initial
82 stages of configuring Sun StorageTek Availability Suite software in order to
83 determine the required bitmap volume sizes, and then to check if the bitmap
84 volumes that have been created are suitable.
85 .SH EXIT STATUS
86 .sp
87 .LP
88 The following exit values are returned:
89 .sp
90 .ne 2
91 .na
92 \fB\fB0\fR\fR
93 .ad
94 .RS 13n
95 Successful completion. If the name of a bitmap volume was specified, that
96 volume is sufficiently large for all potential uses.
97 .RE
99 .sp
100 .ne 2
102 \fB\fB1\fR\fR
104 .RS 13n
105 An error occurred.
109 .ne 2
111 \fB\fB2\fR\fR
113 .RS 13n
114 An invalid option was supplied on the command line.
118 .ne 2
120 \fB\fB3\fR\fR
122 .RS 13n
123 The specified bitmap volume is not large enough to be used as an Availability
124 Suite Remote Mirror bitmap for an asynchronous set with a disk queue, but is
125 large enough to be used for all other Remote Mirror set configurations.
129 .ne 2
131 \fB\fB4\fR\fR
133 .RS 13n
134 The specified bitmap volume is not large enough to be used as an Availability
135 Suite Remote Mirror bitmap for any Remote Mirror set configuration.
139 .ne 2
141 \fB\fB5\fR\fR
143 .RS 13n
144 The specified bitmap volume is not large enough to be used as an Availability
145 Suite Remote Mirror bitmap for any Remote Mirror set configuration.
149 .ne 2
151 \fB\fB6\fR\fR
153 .RS 13n
154 The specified bitmap volume is not large enough to be used as an Availability
155 Suite Point in Time bitmap for a compact dependent shadow, but is large enough
156 to be used for all other Point in Time set configurations.
159 .SH ATTRIBUTES
162 See \fBattributes\fR(5) for descriptions of the following attributes:
167 box;
168 c | c
169 l | l .
170 ATTRIBUTE TYPE  ATTRIBUTE VALUE
172 Interface Stability     Evolving
175 .SH SEE ALSO
178 \fBiiadm\fR(1M), \fBsndradm\fR(1M), \fBattributes\fR(5)