# # Copyright (c) 2001-2013 NetApp, Inc., All Rights Reserved # Any use, modification, or distribution is prohibited # without prior written consent from NetApp, Inc. # ## @summary LunBind ComponentState Module (auto-generated by CGT) ## @author dl-nacl-dev@netapp.com , raghaveb@netapp.com ## @status shared ## @pod here =head1 NAME NACL::CS::LunBind =head1 DESCRIPTION C is a derived class of L. It represents the state of an ONTAP LunBind. A related class is L, which represents access to an ONTAP LunBind. =head1 ATTRIBUTES The individual pieces of data that are part of the state of the LunBind element are the attributes of the LunBind 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. =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<< vvol_msid >> *VVol MSID Filled in for CMode CLI =item C<< reference-count >> *Reference Count Filled in for CMode CLI/ZAPI. Maps to: CM ZAPI: For "filter", "requested_fields" and Output mapping: $value =item C<< protocol_endpoint_msid >> *PE MSID Filled in for CMode CLI/ZAPI. Maps to: CM ZAPI: For "filter", "requested_fields" and Output mapping: $value =item C<< secondary-lun-id >> *Secondary LUN ID Filled in for CMode CLI/ZAPI. Maps to: CM ZAPI: For "filter", "requested_fields" and Output mapping: $value =item C<< vserver >> *Vserver Filled in for CMode CLI/ZAPI. Maps to: CM ZAPI: For "filter", "requested_fields" and Output mapping: $value =item C<< protocol_endpoint_path >> *Protocol Endpoint Filled in for CMode CLI/ZAPI Maps to: CM ZAPI: For "filter", "requested_fields" and Output mapping: $value =item C<< is-optimal >> *Optimal binding, possible value(s) are true,false Filled in for CMode CLI/ZAPI. Maps to: CM ZAPI: For "filter", "requested_fields" and Output mapping: $value =item C<< protocol_endpoint_vdisk_id >> *PE Vdisk ID Filled in for CMode CLI =item C<< vvol_node >> *VVol Node Filled in for CMode CLI =item C<< vvol-path >> *VVol Filled in for CMode CLI/ZAPI. Maps to: CM ZAPI: For "filter", "requested_fields" and Output mapping: $value =item C<< protocol_endpoint_node >> *PE Node Filled in for CMode CLI =item C<< vvol_vdisk_id >> *VVol Vdisk ID Filled in for CMode CLI =item C<< vserver_uuid >> *UUID Filled in for CMode CLI =item C<< vvol-uuid >> *VVol UUID Filled in for CMode CLI/ZAPI Maps to: CM ZAPI: For "filter", "requested_fields" and Output mapping: $value =item C<< secondary-lun >> *Secondary LUN Filled in for CMode CLI/ZAPI. Maps to: CM ZAPI: For "filter", "requested_fields" and Output mapping: $value =item C<< protocol-endpoint-uuid >> PE UUID Filled in for CMode CLI/ZAPI. Maps to: CM ZAPI: For "filter", "requested_fields" and Output mapping: $value =back =cut package NACL::CS::LunBind; use strict; use warnings; use Params::Validate qw(validate); use NATE::Log qw(log_global); my $Log = log_global(); my $may_enter = $Log->may_enter(); my $may_exit = $Log->may_exit(); use NACL::Exceptions::NoElementsFound qw(:try); use base 'NACL::CS::ComponentState::ONTAP'; use Class::MethodMaker [ scalar => 'vvol_msid', scalar => 'reference_count', scalar => 'protocol_endpoint_msid', scalar => 'secondary_lun_id', scalar => 'vserver', scalar => 'protocol_endpoint_path', scalar => 'is_optimal', scalar => 'protocol_endpoint_vdisk_id', scalar => 'vvol_node', scalar => 'vvol_path', scalar => 'protocol_endpoint_node', scalar => 'vvol_vdisk_id', scalar => 'vserver_uuid', scalar => 'vvol_uuid', scalar => 'secondary_lun', scalar => 'protocol_endpoint_uuid', ]; =head1 METHODS =head2 fetch my $LunBind_state = NACL::CS::LunBind->fetch(command_interface => $ci, ...); my @LunBind_states = NACL::CS::LunBind->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 for a more detailed description along with a complete explanation of the options it accepts. Supports CMode CLI/ZAPI. Invokes "lun-bind-get-iter" API for CMode ZAPI. =over =item Exceptions =over =item C 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 = shift; my @state_objs = $pkg->SUPER::fetch( @_, choices => [ { method => '_fetch_cmode_cli', interface => 'CLI', set => 'CMode' }, { method => '_fetch_cmode_zapi', interface => 'ZAPI', set => 'CMode' } ], exception_text => 'No matching lun bind(s) found', ); $Log->exit() if $may_exit; return wantarray ? @state_objs : $state_objs[0]; } sub _fetch_cmode_cli { $Log->enter() if $may_enter; my $pkg = shift; my @state_objs = $pkg->SUPER::_fetch_cmode_cli(@_, api => 'lun_bind_show',); $Log->exit() if $may_exit; return @state_objs; } sub _fetch_cmode_zapi { $Log->enter() if $may_enter; my ($pkg, %opts) = @_; my @state_objs = $pkg->SUPER::_fetch_cmode_zapi( %opts, api => 'lun_bind_get_iter', copy => [ qw( is-optimal protocol-endpoint-path reference-count secondary-lun-id vserver vvol-path secondary-lun protocol-endpoint-uuid vvol-uuid) ], ); $Log->exit() if $may_exit; return @state_objs; } 1;