Ping External Class

Problem this snippet solves:

To successfully force a reload of an external data group, it is needed to forcefully modify the external file name from the data group. This example illustrates how to request the external file name from an external data group and then re-set that value forcing a reload of the files contents.

Code :

#!/usr/bin/perl
#----------------------------------------------------------------------------
# The contents of this file are subject to the iControl Public License
# Version 4.5 (the "License"); you may not use this file except in
# compliance with the License. You may obtain a copy of the License at
# http://www.f5.com/.
#
# Software distributed under the License is distributed on an "AS IS"
# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
# the License for the specific language governing rights and limitations
# under the License.
#
# The Original Code is iControl Code and related documentation
# distributed by F5.
#
# The Initial Developer of the Original Code is F5 Networks,
# Inc. Seattle, WA, USA. Portions created by F5 are Copyright (C) 1996-2003 F5 Networks,
# Inc. All Rights Reserved.  iControl (TM) is a registered trademark of F5 Networks, Inc.
#
# Alternatively, the contents of this file may be used under the terms
# of the GNU General Public License (the "GPL"), in which case the
# provisions of GPL are applicable instead of those above.  If you wish
# to allow use of your version of this file only under the terms of the
# GPL and not to allow others to use your version of this file under the
# License, indicate your decision by deleting the provisions above and
# replace them with the notice and other provisions required by the GPL.
# If you do not delete the provisions above, a recipient may use your
# version of this file under either the License or the GPL.
#----------------------------------------------------------------------------

#use SOAP::Lite + trace => qw(method debug);
use SOAP::Lite;

#----------------------------------------------------------------------------
# Validate Arguments
#----------------------------------------------------------------------------
my $sHost = $ARGV[0];
my $sPort = $ARGV[1];
my $sUID = $ARGV[2];
my $sPWD = $ARGV[3];
my $sClass = $ARGV[4];
my $sProtocol = "https";

sub usage()
{
die ("Usage: pingClass.pl host port uid pwd [classname] \n");
}

if ( ($sHost eq "") or ($sPort eq "") or ($sUID eq "") or ($sPWD eq "") )
{
usage();
}

if ( ("80" eq $sPort) or ("8080" eq $sPort) )
{
$sProtocol = "http";
}

#----------------------------------------------------------------------------
# Transport Information
#----------------------------------------------------------------------------
sub SOAP::Transport::HTTP::Client::get_basic_credentials-->
{
return "$sUID" => "$sPWD";
}

#----------------------------------------------------------------------------
# support for custom enum types
#----------------------------------------------------------------------------
sub SOAP::Deserializer::typecast-->
{
my ($self, $value, $name, $attrs, $children, $type) = @_;
my $retval = undef;
if ( "{urn:iControl}Class.ClassType" == $type )
{
$retval = $value;
}
return $retval;
}


$Class = SOAP::Lite
-> uri('urn
-> readable(1)
-> proxy("$sProtocol://$sHost:$sPort/iControl/iControlPortal.cgi");

#----------------------------------------------------------------------------
# Main program logic
#----------------------------------------------------------------------------
if ( "" eq $sClass )
{
&listClasses();
}
else
{
&pingClass($sClass);
}

#----------------------------------------------------------------------------
# sub listClasses
#----------------------------------------------------------------------------
sub listClasses()
{
$soapResponse = $Class->get_external_class_list();
&checkResponse($soapResponse);
@MetaInformationList = @{$soapResponse->result};
foreach $MetaInformation (@MetaInformationList)
{
$class_name = $MetaInformation->{"class_name"};
$class_type = $MetaInformation->{"class_type"};
$file_name = $MetaInformation->{"file_name"};
$file_mode = $MetaInformation->{"file_mode"};
$file_format = $MetaInformation->{"file_format"};

print "Class Name: $class_name\n";
print "      Type: $class_type\n";
print "      File: $file_name\n";
print "      Mode: $file_mode\n";
print "    Format: $file_format\n";
}
}

#----------------------------------------------------------------------------
# sub pingClass
#----------------------------------------------------------------------------
sub pingClass()
{
($class) = (@_);

$file_name = &getFileNameFromClass($class);
if ( "" ne $file_name )
{
$soapResponse = $Class->set_external_class_file_name
(
SOAP::Data->name(class_names => [$class]),
SOAP::Data->name(file_names => [$file_name])
);
&checkResponse($soapResponse);
print "class $class successfully pinged\n";
}
else
{
print "Invalid class: $class\n";
}
}

#----------------------------------------------------------------------------
# sub getFileNameFromClass
#----------------------------------------------------------------------------
sub getFileNameFromClass()
{
($class) = (@_);
$soapResponse = $Class->get_external_class_file_name
(
SOAP::Data->name(class_names => [$class])
);
&checkResponse($soapResponse);

@file_names = @{$soapResponse->result};
$file_name = @file_names[0];
return $file_name;
}

#----------------------------------------------------------------------------
# checkResponse makes sure the error isn't a SOAP error
#----------------------------------------------------------------------------
sub checkResponse()
{
my ($soapResponse) = (@_);
if ( $soapResponse->fault )
{
print $soapResponse->faultcode, " ", $soapResponse->faultstring, "\n";
exit();
}
}