.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "NetApp::Aggregate 3pm"
.TH NetApp::Aggregate 3pm "2008-11-26" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
NetApp::Aggregate \-\- OO class for creating and managing NetApp filer aggregates
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use NetApp::Filer;
\&    use NetApp::Aggregate;
\&
\&    my $filer = NetApp::Filer\->new({ .... });
\&
\&    my @aggregate_names = $filer\->get_aggregate_names;
\&
\&    my @aggregates      = $filer\->get_aggregates;
\&
\&    my $aggregate       = $filer\->get_aggregate( \*(Aqaggr01\*(Aq );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class encapsulates a single NetApp filer aggregate, and provides
methods for querying information about the aggregate and it's
sub-objects (eg. volumes), as well as methods for managing the
aggregate itself.
.SH "INSTANCE METHODS"
.IX Header "INSTANCE METHODS"
.SS "General Instance Methods"
.IX Subsection "General Instance Methods"
\fIget_filer\fR
.IX Subsection "get_filer"
.PP
Returns the NetApp::Filer object representing the filer on which the
aggregate exists.
.PP
\fIget_name\fR
.IX Subsection "get_name"
.PP
Returns the name of the aggregate as a string.
.PP
\fIget_states, get_statuses, get_options\fR
.IX Subsection "get_states, get_statuses, get_options"
.PP
Each of these methods returns a list of strings, each of which
represents a single state, status, or option for the aggregate.
.PP
.Vb 3
\&    NOTE: All you English grammar pluralization rules fanatics can
\&    give up trying to convince the author to call that one method
\&    get_stati.
.Ve
.PP
\fIget_state( \f(CI$state\fI ), get_status( \f(CI$status\fI ), get_option( \f(CI$option\fI )\fR
.IX Subsection "get_state( $state ), get_status( $status ), get_option( $option )"
.PP
Each of these methods returns the value for the specified state,
status or option.  If that particular key wasn't present, then this
method will return undef.  This makes it easy to tell the difference
between a key that doesn't exist, and one that has a false value.
.PP
\fIget_plex\fR
.IX Subsection "get_plex"
.PP
Returns the NetApp::Aggregate::Plex object representing the plex on
which the aggregate lives.
.SS "Volume Specific Methods"
.IX Subsection "Volume Specific Methods"
\fIget_volume_names\fR
.IX Subsection "get_volume_names"
.PP
Returns a list of the volume names which are contained within this
aggregate.
.PP
\fIget_volumes\fR
.IX Subsection "get_volumes"
.PP
Returns a list of NetApp::Volume objects, each of which represents one
of the volumes in the aggregate.
.PP
\fIget_volume( \f(CI$name\fI )\fR
.IX Subsection "get_volume( $name )"
.PP
Returns a single NetApp::Volume object representing the specified
volume.  If that volume doesn't exist on the aggregate, then a fatal
exception is raised.
.PP
\fIcreate_volume( \f(CI%args\fI )\fR
.IX Subsection "create_volume( %args )"
.PP
This method creates a flexible volume in the aggregate, and returns
the NetApp::Volume object representing the new volume.  The arguments
are as follows.  All values are simple strings, unless otherwise
noted.
.PP
.Vb 10
\&    $aggregate\->create_volume(
\&        # Required arguments
\&        name            => $name,
\&        size            => $size,
\&        # Optional arguments
\&        space           => \*(Aqnone\*(Aq | \*(Aqfile\*(Aq | \*(Aqvolume\*(Aq,
\&        language        => $language,
\&        source_filer    => $source_filer,
\&        source_volume   => $source_volume,
\&    );
.Ve
.PP
Both the source_filer and source_volume arguments must be given when
creating a flexcache volume.
.PP
The space and language arguments may not be specified with the
source_filer/source_volume arguments.
.PP
\fIdestroy_volume( \f(CI%args\fI )\fR
.IX Subsection "destroy_volume( %args )"
.PP
Destroys the specified volume.  Note that since this \s-1API\s0 is not
designed to be used interactively, the \-f (force) argument is always
used.  Be sure you really want to destroy the volume, programatically.
.PP
.Vb 4
\&    $aggregate\->destroy_volume(
\&        # Required argument
\&        name            => $name,
\&    );
.Ve
.PP
The \f(CW$name\fR must be a string, and it must be one of the volumes in the
\&\f(CW$aggregate\fR.
.SS "Qtree Specific Methods"
.IX Subsection "Qtree Specific Methods"
\fIget_qtree_names\fR
.IX Subsection "get_qtree_names"
.PP
Returns a list of strings, each of which is the name of a qtree on the
aggregate.
.PP
\fIget_qtrees\fR
.IX Subsection "get_qtrees"
.PP
Returns a list of NetApp::Qtree objects, each of which represents a
single qtree on the aggregate.
.PP
\fIget_qtree( \f(CI$name\fI )\fR
.IX Subsection "get_qtree( $name )"
.PP
Returns a single NetApp::Qtree object for the specified qtree
name. The name must in the form of a pathname, for example:
.PP
.Vb 1
\&    /vol/volume_name/qtree_name
.Ve
.PP
The qtree_name is optional if querying the object for a volume's
qtree.  This method simply returns nothing if the specified qtree
doesn't exist on the aggregate.
.SS "Snapshot Specific Methods"
.IX Subsection "Snapshot Specific Methods"
\fIget_snapshots\fR
.IX Subsection "get_snapshots"
.PP
Returns a list of NetApp::Snapshot objects for each of the snapshots
of the aggregate.
.PP
\fIget_snapshot( \f(CI$name\fI )\fR
.IX Subsection "get_snapshot( $name )"
.PP
Returns a single NetApp::Snapshot object matching the specified name,
if it exists for the aggregate.
.PP
\fIcreate_snapshot( \f(CI$name\fI )\fR
.IX Subsection "create_snapshot( $name )"
.PP
Creates a snapshot of the aggregate with the specified name.
.PP
\fIdelete_snapshot( \f(CI$name\fI )\fR
.IX Subsection "delete_snapshot( $name )"
.PP
Deletes a snapshot of the aggregate with the specified name.
.PP
\fIget_snapshot_deltas\fR
.IX Subsection "get_snapshot_deltas"
.PP
Returns a list of NetApp::Snapshot::Delta objects for each snapshot
delta for the aggregate.
.PP
\fIget_snapshot_reserved\fR
.IX Subsection "get_snapshot_reserved"
.PP
Returns a string representing the amount of reserved space, as a
percentage.  This string does \s-1NOT\s0 include the % sign.
.PP
\fIset_snapshot_reserved( \f(CI$percentage\fI )\fR
.IX Subsection "set_snapshot_reserved( $percentage )"
.PP
Sets the snapshot reserved space to the specified percentage, which
should also \s-1NOT\s0 include the % sign.
.PP
\fIget_snapshot_schedule\fR
.IX Subsection "get_snapshot_schedule"
.PP
Returns a NetApp::Snapshot::Schedule object representing the snapshot
schedule for the aggregate.
.PP
\fIset_snapshot_schedule( \f(CI%args\fI )\fR
.IX Subsection "set_snapshot_schedule( %args )"
.PP
Sets the snapshot schedule for the aggregate based on the arguments
passed.  The argument syntax is:
.PP
.Vb 8
\&    $aggregate\->set_snapshot_schedule(
\&        weekly          => $weekly,
\&        daily           => $daily,
\&        hourly          => $hourly,
\&        hourlist        => [
\&            $hour1, $hour2, $hour3, ....
\&        ],
\&    );
.Ve
.SH "TO BE IMPLEMENTED"
.IX Header "TO BE IMPLEMENTED"
\&\s-1NOTE:\s0 Currently, all of the following methods have yet to be
implemented, but will be soon.  This documentation serves as a
guideline for how to implement the perl \s-1API\s0 for each associates \s-1CLI\s0
function.
.SS "NetApp::Aggregate\->create( ... )"
.IX Subsection "NetApp::Aggregate->create( ... )"
.Vb 10
\&    my $aggregate       = NetApp::Aggregate\->create(
\&        # Required arguments
\&        filer           => $filer,      # NetApp::Filer object
\&        name            => $aggregate_name,
\&        # Required but mutually exclusive arguments
\&        # Either \*(Aqdisks\*(Aq OR \*(Aqdiskcount and/or disksize\*(Aq
\&        disks           => [
\&                             [ $disk1, $disk2, .... ],
\&                             [ $diskn, $diskn+1, .... ],
\&                           ],
\&        diskcount       => $diskcount,
\&        disksize        => $disksize,
\&        # Optional arguments
\&        raidtype        => \*(Aqraid0\*(Aq | \*(Aqraid4\*(Aq | \*(Aqraid\-dp\*(Aq,
\&        raidsize        => $raidsize,
\&        disktype        => \*(AqATA\*(Aq | \*(AqFCAL\*(Aq | \*(AqLUN\*(Aq | \*(AqSAS\*(Aq | \*(AqSATA\*(Aq | \*(AqSCSI\*(Aq,
\&        rpm             => $rpm,
\&        mirrored        => $boolean,
\&    );
.Ve
.ie n .SS "$aggregate\->add( ... )"
.el .SS "\f(CW$aggregate\fP\->add( ... )"
.IX Subsection "$aggregate->add( ... )"
.Vb 10
\&    $aggregate\->add(
\&        # Required arguments
\&        name            => $aggregate_name,
\&        # Required but mutually exclusive arguments
\&        # Either \*(Aqdisks\*(Aq OR \*(Aqdiskcount and/or disksize\*(Aq
\&        disks           => [
\&                             [ $disk1, $disk2, .... ],
\&                             [ $diskn, $diskn+1, .... ],
\&                           ],
\&        diskcount       => $diskcount,
\&        disksize        => $disksize,
\&        # Optional arguments
\&        raidgroup       => $raidgroup,
\&        force           => 1,
\&    );
.Ve
.ie n .SS "$aggregate\->\fIdestroy()\fP"
.el .SS "\f(CW$aggregate\fP\->\fIdestroy()\fP"
.IX Subsection "$aggregate->destroy()"
\&\s-1NOTE:\s0 This always uses the \-force option, since this \s-1API\s0 is not
interactive.
.ie n .SS "$aggregate\->\fIoffline()\fP"
.el .SS "\f(CW$aggregate\fP\->\fIoffline()\fP"
.IX Subsection "$aggregate->offline()"
.Vb 4
\&    $aggregate\->offline(
\&        # Optional arguments
\&        cifsdelaytime   => $cifsdelaytime,
\&    );
.Ve
.ie n .SS "$aggregate\->\fIonline()\fP"
.el .SS "\f(CW$aggregate\fP\->\fIonline()\fP"
.IX Subsection "$aggregate->online()"
\&\s-1NOTE:\s0 It is unclear whether or not we should always imply \-f (force =>
1), or whether we should treat the prompted scenario as an error, and
raise an exception.  Since forcing an aggregate online can result in
data loss when \-f is used, perhaps we should force that state to be
cleaned up first.
.ie n .SS "$aggregate\->rename( $newname )"
.el .SS "\f(CW$aggregate\fP\->rename( \f(CW$newname\fP )"
.IX Subsection "$aggregate->rename( $newname )"
.ie n .SS "$aggregate\->restrict( ... )"
.el .SS "\f(CW$aggregate\fP\->restrict( ... )"
.IX Subsection "$aggregate->restrict( ... )"
.Vb 4
\&    $aggregate\->restrict(
\&        # Optional arguments
\&        cifsdelaytime   => $cifsdelaytime,
\&    );
.Ve