# Copyright (c) 2001-2013 NetApp, Inc., All Rights Reserved
#   Any use, modification, or distribution is prohibited
#   without prior written consent from NetApp, Inc.
#

## @summary NetworkArpActiveEntry ComponentState Module (auto-generated by CGT)
## @author dl-nacl-dev@netapp.com
## @status shared
## @pod here

=head1 NAME

NACL::CS::NetworkArpActiveEntry

=head1 DESCRIPTION

C<NACL::CS::NetworkArpActiveEntry> is a derived class of
L<NACL::CS::ComponentState::ONTAP|lib-NACL-CS-ComponentState-ONTAP-pm>. It represents the
state of an ONTAP NetworkArpActiveEntry.  A related class is
L<NACL::C::NetworkArpActiveEntry|lib::NACL-C-NetworkArpActiveEntry-pm>, which represents access
to an ONTAP NetworkArpActiveEntry.

=head1 ATTRIBUTES

The individual pieces of data that are part of the state of the NetworkArpActiveEntry
element are the attributes of the NetworkArpActiveEntry ComponentState.

Additionally, the command_interface used to obtain the ComponentState object is
also an attribute of the object. This makes it easier to obtain the component
object corresponding to the CS object, using
L<get_component_instance|lib-NACL-CS-ComponentState-pm/get_component_instance>.

=over

=item command_interface

The command_interface with which the CS object was obtained. (Available in
all CS objects regardless of requested_fields and the mode/interface)

=item C<< subnet_group >>

Subnet Group Name possible value(s) are, <subnet>,default

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

For "requested_fields", "filter" and Output mapping:

<net-arp-operational-info subnet-group="$value" />



=item C<< vserver >>

Vserver Name

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

For "requested_fields", "filter" and Output mapping:

<net-arp-operational-info vserver="$value" />



=item C<< ipspace >>

IPspace

Filled in for CMode CLI.

=item C<< node >>

Node possible value(s) are, <nodename>,local

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

For "requested_fields", "filter" and Output mapping:

<net-arp-operational-info node="$value" />



=item C<< remotehost >>

Remote IP Address

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

For "requested_fields", "filter" and Output mapping:

<net-arp-operational-info remote-host="$value" />



=item C<< port >>

Port

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

For "requested_fields", "filter" and Output mapping:

<net-arp-operational-info port-name="$value" />



=item C<< mac >>

MAC Address

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

For "requested_fields", "filter" and Output mapping:

<net-arp-operational-info mac-address="$value" />



=back

=cut

package NACL::CS::NetworkArpActiveEntry;

use strict;
use warnings;
use Params::Validate qw(validate);
use NATE::Log qw(log_global);
use NACL::Exceptions::NoElementsFound qw(:try);

use NACL::CS::ComponentState::ZapiSkip qw(make_zapi_skip);
use NACL::CS::ComponentState::ZapiArray qw(make_zapi_array);
use base 'NACL::CS::ComponentState::ONTAP';

use Class::MethodMaker [
    scalar => 'subnet_group',
    scalar => 'vserver',
    scalar => 'ipspace',
    scalar => 'node',
    scalar => 'remotehost',
    scalar => 'port',
    scalar => 'mac',
];

my $Log = log_global();
my $may_enter = $Log->may_enter();
my $may_exit  = $Log->may_exit();

=head1 METHODS

=head2 fetch

    my $NetworkArpActiveEntry_state  = NACL::CS::NetworkArpActiveEntry->fetch(command_interface => $ci, ...);
	my @NetworkArpActiveEntry_states = NACL::CS::NetworkArpActiveEntry->fetch(command_interface => $ci, ...);

(Class method)
Discovers which elements are present and returns their state in ComponentState
objects. Called in scalar context it returns only one state object, in list
context it returns all state objects.
See L<NACL::CS::ComponentState|lib-NACL-CS-ComponentState-pm/fetch> for a
more detailed description along with a complete explanation of the options
it accepts.

Uses CMode CLI/ZAPI.

Invokes net-arp-active-entry-get-iter API for CMode ZAPI.


=over

=item Exceptions

=over

=item C<NACL::Exceptions::NoElementsFound>

When there are no elements matching the query specified or elements of that type
doesn't exist, then this exception will be thrown.

=back

=back

=cut

sub fetch {
    $Log->enter() if $may_enter;
    my ($pkg, @args) = @_;
    my @state_objs = $pkg->SUPER::fetch(
        @args,
        choices => [
            {   method    => '_fetch_cmode_cli',
                interface => 'CLI',
                set       => 'CMode'
            },
            {   method    => '_fetch_cmode_zapi',
                interface => 'ZAPI',
                set       => 'CMode'
            },
        ],
        show_cmd => 'network arp active-entry show',
	exception_text => 'No matching network arp active-entry(s) found',
        frontend       => 'NACL::CS::NetworkArpActiveEntry::fetch',
    );
    $Log->exit() if $may_exit;
    return wantarray ? @state_objs : $state_objs[0];
}

sub _fetch_cmode_cli {
    $Log->enter() if $may_enter;
    my ($pkg, @args) = @_;
    my @state_objs = $pkg->SUPER::_fetch_cmode_cli(@args,
        api => 'network_arp_active_entry_show',);
    $Log->exit() if $may_exit;
    return @state_objs;
}

sub _fetch_cmode_zapi {
    $Log->enter() if $may_enter;
    my ($pkg, @args) = @_;
    my @state_objs = $pkg->SUPER::_fetch_cmode_zapi(
        @args,
        copy => [
            qw(subnet-group vserver node
                )
        ],
        map => {
            'mac'        => 'mac-address',
            'port'       => 'port-name',
            'remotehost' => 'remote-host',
        },
        api => "net-arp-active-entry-get-iter",
    );
    $Log->exit() if $may_exit;
    return @state_objs;
}
1;