/ 
Zenoss-API-1.0
/ Zenoss::API::Router::ZenPack

NAME

Zenoss::API::Router::Zenpack - A JSON/ExtDirect interface to operations on ZenPacks

SYNOPSIS

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

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

DESCRIPTION

This class is NOT instantiated directly. To call methods from this package create an instance of Zenoss::API. This document serves as a resource of available Zenoss API calls available for use with Zenoss::API.

METHODS

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

$obj->zenpack_getEligiblePacks()

Get a list of eligible ZenPacks to add to.

PARAMETERS

NONE

REQUIRED PARAMETERS

N/A

DEFAULT PARAMETERS

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.

PARAMETERS

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

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

REQUIRED PARAMETERS

topack

zenpack

DEFAULT PARAMETERS

N/A

RETURNS

Success message

SEE ALSO

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.