# $Id$

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

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

=head1 NAME

NACL::CS::MetroclusterVserver

=head1 DESCRIPTION

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

=head1 ATTRIBUTES

The individual pieces of data that are part of the state of the MetroclusterVserver
element are the attributes of the MetroclusterVserver 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<< configuration_state >>


Configuration State possible value(s) are, healthy,unhealthy,degraded,pending-setup

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

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

<metrocluster-vserver-info configuration-state="$value" />



=item C<< stream_uuid >>

Stream

Filled in for CMode CLI.

=item C<< destination_vserver >>

Destination Vserver

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

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

<metrocluster-vserver-info destination-vserver="$value" />



=item C<< cluster >>

Cluster Name

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

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

<metrocluster-vserver-info cluster="$value" />



=item C<< source_vserver >>

Source Vserver

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

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

<metrocluster-vserver-info source-vserver="$value" />


=item C<< vserver >>

Vserver in the MetroCluster relationship

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

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

<metrocluster-vserver-info vserver="$value" />


=item C<< partner_vserver >>

Partner Vserver in the MetroCluster relationship

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

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

<metrocluster-vserver-info partner-vserver="$value" />


=item C<< last_fail_time >>

Last Fail Time

Filled in for CMode CLI.

=item C<< failed_op >>


Failed Operation possible value(s) are, baseline_generate,configuration_apply

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

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

<metrocluster-vserver-info failed-op="$value" />



=item C<< corrective_action >>

Corrective Action

Filled in for CMode CLI.

=item C<< drain_sync_time >>

Last Drain Sync Time

Filled in for CMode CLI.

=item C<< failed_reason >>

Reason for Failure

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

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

<metrocluster-vserver-info failed-reason="$value" />



=item C<< failed_row >>

Failed Row

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

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

<metrocluster-vserver-info failed-row="$value" />



=item C<< last_fail_time >>

Last Fail Time

Filled in for CMode CLI.

=item C<< drain_sync_time >>

Last Drain Sync Time

Filled in for CMode CLI.


=back

=cut

package NACL::CS::MetroclusterVserver;

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 => 'configuration_state',
    scalar => 'stream_uuid',
    scalar => 'destination_vserver',
    scalar => 'cluster',
    scalar => 'source_vserver',
    scalar => 'last_fail_time',
    scalar => 'failed_op',
    scalar => 'corrective_action',
    scalar => 'drain_sync_time',
    scalar => 'failed_reason',
    scalar => 'failed_row',
    scalar => 'vserver',
    scalar => 'partner_vserver',
];
my $Log = log_global();
my $may_enter = $Log->may_enter();
my $may_exit  = $Log->may_exit();

=head1 METHODS

=head2 fetch

    my $MetroclusterVserver_state  = NACL::CS::MetroclusterVserver->fetch(command_interface => $ci, ...);
	my @MetroclusterVserver_states = NACL::CS::MetroclusterVserver->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 metrocluster-vserver-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'
            },
        ],
        exception_text => 'No matching metrocluster vserver(s) found',
        frontend       => 'NACL::CS::MetroclusterVserver::fetch',
        show_cmd       => 'metrocluster vserver show',
    );
    $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 => 'metrocluster_vserver_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(configuration-state cluster destination-vserver source-vserver failed-op
                failed-reason failed-row vserver partner-vserver
            )
        ],
        api => "metrocluster-vserver-get-iter",
    );
    $Log->exit() if $may_exit;
    return @state_objs;
}
1;