lib/Net/Plesk/Method/client_ippool_add_ip.pm

   1 package Net::Plesk::Method::client_ippool_add_ip;
   2
   3 use strict;
   4
   5 use vars qw( $VERSION @ISA $AUTOLOAD $DEBUG );
   6
   7 @ISA = qw( Net::Plesk::Method );
   8 $VERSION = '0.01';
   9
  10 $DEBUG = 0;
  11
  12 =head1 NAME
  13
  14 Net::Plesk::Method::client_ippool_add_ip - Perl extension for Plesk XML
  15 Remote API client ippool addition
  16
  17 =head1 SYNOPSIS
  18
  19   use Net::Plesk::Method::client_ippool_add_ip
  20
  21   my $p = new Net::Plesk::Method::client_ippool_add_ip ( $clientID, $ipaddress );
  22
  23 =head1 DESCRIPTION
  24
  25 This module implements an interface to construct a request for a ippool
  26 addition to a client using SWSOFT's Plesk.
  27
  28 =head1 METHODS
  29
  30 =over 4
  31
  32 =item init args ...
  33
  34 Initializes a Plesk client ippool_add_ip.  The I<clientID> and I<ipaddress>
  35 options are required.
  36
  37 =cut
  38
  39 sub init {
  40   my ($self, $clientid, $ipaddress) = @_;
  41   $$self = join ( "\n", (
  42                     '<client>',
  43                     '<ippool_add_ip>',
  44                     '<client_id>',
  45                     $self->encode($clientid),
  46                     '</client_id>',
  47                     '<ip_address>',
  48                     $self->encode($ipaddress),
  49                     '</ip_address>',
  50                     '</ippool_add_ip>',
  51                     '</client>',
  52                   ));
  53 }
  54
  55 =back
  56
  57 =head1 BUGS
  58
  59   Creepy crawlies.
  60
  61 =head1 SEE ALSO
  62
  63 SWSOFT Plesk Remote API documentation (1.4.0.0 or later)
  64
  65 =head1 AUTHOR
  66
  67 Jeff Finucane E<lt>jeff@cmh.netE<gt>
  68
  69 =head1 COPYRIGHT AND LICENSE
  70
  71 Copyright (C) 2006 Jeff Finucane
  72
  73 This library is free software; you can redistribute it and/or modify
  74 it under the same terms as Perl itself.
  75
  76 =cut
  77
  78 1;
  79