NetApp...gregate(3pm)

✨ NetApp::Aggregate — the perl manual page but make it cute ✨

okay bestie, welcome to NetApp...gregate(3pm) from the User Contributed Perl Documentation ✨ it's giving very "I manage NetApp filer aggregates for a living and I'm also fun at parties". let's get into it 💅

---

🌸 NAME 🌸

NetApp::Aggregate — it's an OO class, and its whole job is creating and managing NetApp filer aggregates. that's it. that's the girl. 👑

---

🦋 SYNOPSIS 🦋

here's the vibe, literally copy-paste core:

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( 'aggr01' );

look at that. gorgeous. no notes. 🌈

---

💖 DESCRIPTION 💖

so this class wraps up a single NetApp filer aggregate (one. just one. main character energy only) and gives you methods to:

• query info about the aggregate itself
• query info about its sub-objects (eg. volumes, iykyk)
• manage the aggregate itself

that's the whole thing bestie, it's honestly so tidy 🎀

---

🫶 INSTANCE METHODS 🫶

⭐ General Instance Methods ⭐

• get_filer — hands you the NetApp::Filer object for the filer that this aggregate lives on. it's the aggregate's home address basically 🏠
• get_name — returns the name of the aggregate, as a string. simple. iconic.
• get_states, get_statuses, get_options — each one of these gives you back a list of strings, and each string is a single state, status, or option for the aggregate. so like, one string per thing, in a list. 💫

NOTE: to all you English grammar pluralization rules fanatics out there — give up trying to convince the author to call that one method get_stati. it's get_statuses. periodt. 😌

• get_state( $state ), get_status( $status ), get_option( $option ) — each of these returns the value for the state / status / option you asked for. and here's the cute part: if that particular key wasn't present, it returns undef. which means you can tell the difference between a key that literally doesn't exist and a key that exists but has a false value. slay, honestly 🔥
• get_plex — returns the NetApp::Aggregate::Plex object for the plex the aggregate lives on. yes, plex. no, we're not elaborating. 🦋

🍓 Volume Specific Methods 🍓

• get_volume_names — returns a list of the volume names that live inside this aggregate. just names. 💖
• get_volumes — returns a list of NetApp::Volume objects, and each one represents one of the volumes in the aggregate. the full objects this time, not just names 👑
• get_volume( $name ) — returns a single NetApp::Volume object for the volume you specified. but if that volume doesn't exist on the aggregate, a fatal exception is raised. so, like, know your volumes bestie 😭
• create_volume( %args ) — makes a flexible volume in the aggregate and returns the NetApp::Volume object for the brand new volume. the arguments go like this — all values are simple strings unless noted otherwise:

$aggregate->create_volume(
    # Required arguments
    name            => $name,
    size            => $size,
    # Optional arguments
    space           => 'none' | 'file' | 'volume',
    language        => $language,
    source_filer    => $source_filer,
    source_volume   => $source_volume,
);

heads up: both source_filer and source_volume must be given when you're creating a flexcache volume. and the space and language arguments may not be specified alongside the source_filer/source_volume arguments. pick a lane, bestie 💅

• destroy_volume( %args ) — destroys the volume you specify. and listen: since this API is not designed to be used interactively, the -f (force) argument is always used. be sure you really want to destroy the volume, programatically. like, sure sure. 🫣

$aggregate->destroy_volume(
    # Required argument
    name            => $name,
);

the $name must be a string, and it must be one of the volumes in the $aggregate. no random names, no ghost volumes, we don't do that here ✨

🧚 Qtree Specific Methods 🧚

• get_qtree_names — returns a list of strings, and each string is the name of a qtree on the aggregate. 🌸
• get_qtrees — returns a list of NetApp::Qtree objects, each one representing a single qtree on the aggregate. 💜
• get_qtree( $name ) — returns a single NetApp::Qtree object for the qtree name you gave. the name has to be in the form of a pathname, for example:

/vol/volume_name/qtree_name

also: the qtree_name is optional if you're querying the object for a volume's qtree. and this method simply returns nothing if the specified qtree doesn't exist on the aggregate. no drama, just silence 💀

🎀 Snapshot Specific Methods 🎀

• get_snapshots — returns a list of NetApp::Snapshot objects, one for each of the aggregate's snapshots. 📸
• get_snapshot( $name ) — returns a single NetApp::Snapshot object matching the name you gave, if it exists for the aggregate. 🦋
• create_snapshot( $name ) — creates a snapshot of the aggregate with the name you specified. ✨
• delete_snapshot( $name ) — deletes a snapshot of the aggregate with the name you specified. bye bestie 👋
• get_snapshot_deltas — returns a list of NetApp::Snapshot::Delta objects, one for each snapshot delta for the aggregate. 🌈
• get_snapshot_reserved — returns a string representing the amount of reserved space, as a percentage. and this string does NOT include the % sign. it's just the number, bestie, do not add the percent 🚫
• set_snapshot_reserved( $percentage ) — sets the snapshot reserved space to the percentage you specify, which should also NOT include the % sign. same energy, opposite direction 💅
• get_snapshot_schedule — returns a NetApp::Snapshot::Schedule object representing the snapshot schedule for the aggregate. 🗓️
• set_snapshot_schedule( %args ) — sets the snapshot schedule for the aggregate based on the args you pass. the syntax is:

$aggregate->set_snapshot_schedule(
    weekly          => $weekly,
    daily           => $daily,
    hourly          => $hourly,
    hourlist        => [
        $hour1, $hour2, $hour3, ....
    ],
);

---

🔮 TO BE IMPLEMENTED 🔮

NOTE: currently, all of the following methods have yet to be implemented, but they will be soon. this documentation is serving as a guideline for how to implement the perl API for each associated CLI function. so like, manifesting ✨

👑 NetApp::Aggregate->create( ... )

my $aggregate       = NetApp::Aggregate->create(
    # Required arguments
    filer           => $filer,      # NetApp::Filer object
    name            => $aggregate_name,
    # Required but mutually exclusive arguments
    # Either 'disks' OR 'diskcount and/or disksize'
    disks           => [
                         [ $disk1, $disk2, .... ],
                         [ $diskn, $diskn+1, .... ],
                       ],
    diskcount       => $diskcount,
    disksize        => $disksize,
    # Optional arguments
    raidtype        => 'raid0' | 'raid4' | 'raid-dp',
    raidsize        => $raidsize,
    disktype        => 'ATA' | 'FCAL' | 'LUN' | 'SAS' | 'SATA' | 'SCSI',
    rpm             => $rpm,
    mirrored        => $boolean,
);

note the mutual exclusivity bestie — it's either disks OR diskcount and/or disksize. not both. we don't do both 🚫

🌸 $aggregate->add( ... )

$aggregate->add(
    # Required arguments
    name            => $aggregate_name,
    # Required but mutually exclusive arguments
    # Either 'disks' OR 'diskcount and/or disksize'
    disks           => [
                         [ $disk1, $disk2, .... ],
                         [ $diskn, $diskn+1, .... ],
                       ],
    diskcount       => $diskcount,
    disksize        => $disksize,
    # Optional arguments
    raidgroup       => $raidgroup,
    force           => 1,
);

same mutually exclusive situation up top — disks or diskcount and/or disksize, choose one ✨

💀 $aggregate->destroy()

NOTE: this always uses the -force option, since this API is not interactive. no take-backs, no confirmation prompt, just vibes and consequences 😭

🌙 $aggregate->offline()

$aggregate->offline(
    # Optional arguments
    cifsdelaytime   => $cifsdelaytime,
);

⭐ $aggregate->online()

NOTE: 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. and 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. so like… unresolved. thinking about it. 🫠

🦋 $aggregate->rename( $newname )

that's the whole signature. it renames. with a new name. $newname. cute 💜

🎀 $aggregate->restrict( ... )

$aggregate->restrict(
    # Optional arguments
    cifsdelaytime   => $cifsdelaytime,
);

---

and that's the whole page bestie!! 🫶 this was NetApp...gregate(3pm) from the User Contributed Perl Documentation, perl v5.36.0, dated 2022-11-19. go forth and manage those aggregates responsibly, mwah 💅✨🎀