CipUX::Dog(3pm) User Contributed Perl Documentation CipUX::Dog(3pm)
NAME
CipUX::Dog - Adds a hook to CipUX::Task to execute commands.
VERSION
This document describes CipUX::Dog version 3.4.0.0
SYNOPSIS
use CipUX::Dog;
or
use English qw( -no_match_vars);
eval { require CipUX::Dog; };
if ( not $EVAL_ERROR ) {
my $dog = CipUX::Dog->new(
{
dog_hr => $dog_hr,
object => $object,
overwrite_hr => $overwrite_hr,
}
);
$dog->bite(); # exec files system command
}
DESCRIPTION
CipuX::Dog can be used as a hook for CipUX::Task. If CipUX::Dog is installed it can be configured by the administrator to execute commands
triggered by execution of a given task.
SUBROUTINES
/METHODS
BUILD
Create the Object, reads the config file
DEMOLISH
Removes the object
bite
Calls the dog to bite.
execute
Execute a command.
my $return = $self->execute(
{ command => $self->l($cmd), cmdargs_ar => $cmd_args_ar } );
DIAGNOSTICS
This section list every single error and warning message that the module can generate (even the ones that will "never happen"), with a full
explanation of each problem, one or more likely causes, and any suggested remedies.
"The section "commands" is not defined in cipux-dog.perl for %s"
The hash key 'commands' is not inside the configuration for a given dog hash key in cipux-dog.perl configuration. The problem might
look like this:
$cfg = {
cipux_dogs => {
create_homedir => {
},
},
};
It can be solved by adding a 'commands' key:
$cfg = {
cipux_dogs => {
create_homedir => {
commands => {
},
},
},
};
"Cannot execute [%s]. Please provide this command or change [cipux-dog.perl]. The error message was: %s"
There can be different reasons for this message. It depends on the last %s. The following reasons are foreseen:
"Command do not exist!"
The command specified in cipux-dog.perl do not exist. You should copy, provide or write this command.
"Command is not executable! (forget chmod +x ?)"
The command specified in cipux-dog.perl exists but can not be executed. Either it has no executable flags or you have not the right to
execute it. Check and/ro set the execution bit on this command or try do give you the right to execute it.
"?"
Other reasons not be able to execute the command might come from the system and will display after the message.
"Can not close command %s"
If the file handle can not be closed this message will be displayed.
CONFIGURATION AND ENVIRONMENT
CipUX::Dog requires a configuration file but no environment variables. It can be configured by cipux-dog.$ext, where $ext is a valid and
capable extension from CipUX configuration space. The default configuration for CipUX::Dog is in: /usr/share/cipux/etc/cipux-dog.perl
DEPENDENCIES
Carp CipUX Class::Std Data::Dumper English Log::Log4perl Readonly version
INCOMPATIBILITIES
None reported.
BUGS AND LIMITATIONS
No bugs have been reported.
SEE ALSO
See the CipUX webpage and the manual at <http://www.cipux.org>
AUTHOR
Christian Kuelker "<christian.kuelker@cipworx.org>"
LICENSE AND COPYRIGHT
Copyright (C) 2008 - 2009, Christian Kuelker. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
perl v5.12.3 2011-05-05 CipUX::Dog(3pm)