Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Zenoss::Router::ZenPacUser Contributed Perl DocumentZenoss::Router::ZenPack(3)

NAME
       Zenoss::Router::ZenPack - A JSON/ExtDirect interface to operations on
       ZenPacks

SYNOPSIS
	   use Zenoss;
	   my $api = Zenoss->connect(
	       {
		   username    => 'zenoss username',
		   password    => 'zenoss password',
		   url	       => 'http://zenossinstance:8080',
	       }
	   );

	   # Replace SOMEMETHOD	with one of the	available methods provided by this module
	   my $response	= $api->zenpack_SOMEMETHOD(
	       {
		   parameter1 => 'value',
		   parameter2 => 'value',
	       }
	   );

DESCRIPTION
       This module is NOT instantiated directly.  To call methods from this
       module create an	instance of Zenoss.  This document serves as a
       resource	of available Zenoss API	calls to Zenoss.

METHODS
       The following is	a list of available methods available for interaction
       with the	Zenoss API.  Please take note of the argument requirements,
       defaults	and return content.

       The documentation for this module was mostly taken from the Zenoss JSON
       API docs.  Keep in mind that their (Zenoss Monitoring System)
       programming is based around python, so descriptions such	as
       dictionaries will be represented	as hashes in Perl.

   $obj->zenpack_getEligiblePacks()
       Get a list of eligible ZenPacks to add to.

       ARGUMENTS
	   NONE

       REQUIRED	ARGUMENTS
	   N/A

       DEFAULT ARGUMENTS
	   N/A

       RETURNS
	   packs: ([dictionary]) List of objects representing ZenPacks

	   totalCount: (integer) Total number of eligible ZenPacks

   $obj->zenpack_addToZenPack()
       Add an object to	a ZenPack.

       ARGUMENTS
	   topack (string) - Unique ID of the object to	add to ZenPack

	   zenpack (string) - Unique ID	of the ZenPack to add object to

       REQUIRED	ARGUMENTS
	   topack

	   zenpack

       DEFAULT ARGUMENTS
	   N/A

       RETURNS
	   Success message

SEE ALSO
       o   Zenoss

       o   Zenoss::Response

AUTHOR
       Patrick Baker <patricksbaker@gmail.com>

COPYRIGHT AND LICENSE
       Copyright (C) 2010 by Patrick Baker <patricksbaker@gmail.com>

       This module is free software: you can redistribute it and/or modify it
       under the terms of the Artistic License 2.0.

       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.

       You can obtain the Artistic License 2.0 by either viewing the LICENSE
       file provided with this distribution or by navigating to
       <http://opensource.org/licenses/artistic-license-2.0.php>.

perl v5.32.1			  2011-08-14	    Zenoss::Router::ZenPack(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | SEE ALSO | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Zenoss::Router::ZenPack&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help