.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "NetApp::Snapshot 3pm"
.TH NetApp::Snapshot 3pm "2022-11-19" "perl v5.36.0" "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::Snapshot \-\- OO class for creating and managing snapshots
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use NetApp::Filer;
\&    use NetApp::Snapshot;
\&
\&    my $filer   = NetApp::Filer\->new( .... );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class encapsulates a single NetApp snapshot, and provides methods
for querying information about the snapshot, as well as methods for
managing it.
.SH "METHODS"
.IX Header "METHODS"
.SS "get_parent"
.IX Subsection "get_parent"
Returns the NetApp::Aggregate or NetApp::Volume object for the
aggregate or volume for which object is a snapshot.
.SS "get_name"
.IX Subsection "get_name"
Returns a string representing the name of the snapshot.
.SS "get_date"
.IX Subsection "get_date"
Returns the date the snapshot was created.
.SS "get_used"
.IX Subsection "get_used"
Returns the percentage of space used by snapshot.
.SS "get_total"
.IX Subsection "get_total"
Returns the percentage of total space used by the snapshot.
.SS "get_snapshot_deltas"
.IX Subsection "get_snapshot_deltas"
Returns an array of NetApp::Snapshot:Delta objects, each representing
a single delta for this snapshot.
.SS "get_reclaimable"
.IX Subsection "get_reclaimable"
Returns the amount of reclaimable space, if the snapshot is deleted.
Note that experimentally, this command has a lot of failure scenarios,
most of which are reasonable (there are a lot of cases where you can't
query this data).  Therefore, unlike most of the methods in this \s-1API,\s0
it doesn't raise a fatal exception if it can't query the information,
it simply generates warnings.
.ie n .SS "rename( $newname )"
.el .SS "rename( \f(CW$newname\fP )"
.IX Subsection "rename( $newname )"
Renames the snapshot to the specified name.
.ie n .SS "restore( %args )"
.el .SS "restore( \f(CW%args\fP )"
.IX Subsection "restore( %args )"
This method is an interface to the \*(L"snap restore\*(R" command.  The
argument syntax is:
.PP
.Vb 5
\&    $snapshot\->restore(
\&        type            => \*(Aqvol\*(Aq | \*(Aqfile\*(Aq, # Defaults to vol
\&        from_path       => $from_path,
\&        to_path         => $to_path,
\&    );
.Ve
.PP
The 'type' argument maps to the \-t \s-1CLI\s0 argument, and the 'to_path'
argument maps to the \-r \s-1CLI\s0 argument.  Refer to the \fBna_snap\fR\|(1) man
page, and the \*(L"snap restore\*(R" documentation for further information.