Print this page
1693 persistent 'comment' field for a zpool
   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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\" 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
   5 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .\" Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
   7 .TH ZPOOL 1M "Oct 25, 2011"
   8 .SH NAME
   9 zpool \- configures ZFS storage pools
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBzpool\fR [\fB-?\fR]
  14 .fi
  15 
  16 .LP
  17 .nf
  18 \fBzpool add\fR [\fB-fn\fR] \fIpool\fR \fIvdev\fR ...
  19 .fi
  20 
  21 .LP
  22 .nf
  23 \fBzpool attach\fR [\fB-f\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR
  24 .fi
  25 
  26 .LP
  27 .nf


 526 .sp
 527 .ne 2
 528 .na
 529 \fB\fBavailable\fR\fR
 530 .ad
 531 .RS 20n
 532 Amount of storage available within the pool. This property can also be referred
 533 to by its shortened column name, "avail".
 534 .RE
 535 
 536 .sp
 537 .ne 2
 538 .na
 539 \fB\fBcapacity\fR\fR
 540 .ad
 541 .RS 20n
 542 Percentage of pool space used. This property can also be referred to by its
 543 shortened column name, "cap".
 544 .RE
 545 











 546 .sp
 547 .ne 2
 548 .na
 549 \fB\fBhealth\fR\fR
 550 .ad
 551 .RS 20n
 552 The current health of the pool. Health can be "\fBONLINE\fR", "\fBDEGRADED\fR",
 553 "\fBFAULTED\fR", " \fBOFFLINE\fR", "\fBREMOVED\fR", or "\fBUNAVAIL\fR".
 554 .RE
 555 
 556 .sp
 557 .ne 2
 558 .na
 559 \fB\fBguid\fR\fR
 560 .ad
 561 .RS 20n
 562 A unique identifier for the pool.
 563 .RE
 564 
 565 .sp


   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright 2011, 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 ZPOOL 1M "Nov 14, 2011"

   8 .SH NAME
   9 zpool \- configures ZFS storage pools
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBzpool\fR [\fB-?\fR]
  14 .fi
  15 
  16 .LP
  17 .nf
  18 \fBzpool add\fR [\fB-fn\fR] \fIpool\fR \fIvdev\fR ...
  19 .fi
  20 
  21 .LP
  22 .nf
  23 \fBzpool attach\fR [\fB-f\fR] \fIpool\fR \fIdevice\fR \fInew_device\fR
  24 .fi
  25 
  26 .LP
  27 .nf


 526 .sp
 527 .ne 2
 528 .na
 529 \fB\fBavailable\fR\fR
 530 .ad
 531 .RS 20n
 532 Amount of storage available within the pool. This property can also be referred
 533 to by its shortened column name, "avail".
 534 .RE
 535 
 536 .sp
 537 .ne 2
 538 .na
 539 \fB\fBcapacity\fR\fR
 540 .ad
 541 .RS 20n
 542 Percentage of pool space used. This property can also be referred to by its
 543 shortened column name, "cap".
 544 .RE
 545 
 546 .sp
 547 .ne 2
 548 .na
 549 \fB\fBcomment\fR\fR
 550 .ad
 551 .RS 20n
 552 A text string consiting of printable ASCII characters that will be stored
 553 such that it is available even if the pool becomes faulted.  An administrator
 554 can provide additional information about a pool using this property.
 555 .RE
 556 
 557 .sp
 558 .ne 2
 559 .na
 560 \fB\fBhealth\fR\fR
 561 .ad
 562 .RS 20n
 563 The current health of the pool. Health can be "\fBONLINE\fR", "\fBDEGRADED\fR",
 564 "\fBFAULTED\fR", " \fBOFFLINE\fR", "\fBREMOVED\fR", or "\fBUNAVAIL\fR".
 565 .RE
 566 
 567 .sp
 568 .ne 2
 569 .na
 570 \fB\fBguid\fR\fR
 571 .ad
 572 .RS 20n
 573 A unique identifier for the pool.
 574 .RE
 575 
 576 .sp