Zenoss::Router::Report - A JSON/ExtDirect interface to operations on reports
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->report_SOMEMETHOD( { parameter1 => 'value', parameter2 => 'value', } );
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.
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.
Get the available report types.
NONE
N/A
menuText: ([string]) Human readable list of report types
reportTypes: ([string]) A list of the available report type
Returns the tree structure of an organizer hierarchy where the root node is the organizer identified by the id parameter.
id (string) - (optional) Id of the root node of the tree to be returned
{id => '/zport/dmd/Reports'}
Object representing the tree
Add a new report or report organizer.
nodeType (string) - Type of new node. Can either be 'organizer' or one of the report types returned from report_getReportTypes()
contextUid (string) - The organizer where the new node should be added
id (string) - The new node's ID
nodeType
contextUid
id
tree: (dictionary) Object representing the new Reports tree
newNode: (dictionary) Object representing the added node
Remove a report or report organizer.
uid (string) - The UID of the node to delete
uid
Move a report or report organizer from one organizer to another.
uids ([string]) - The UID's of nodes to move
target (string) - The UID of the target Report organizer
uids
target
newNode: (dictionary) Object representing the moved node
Zenoss
Zenoss::Response
Patrick Baker <patricksbaker@gmail.com>
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.
To install Zenoss, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Zenoss
CPAN shell
perl -MCPAN -e shell install Zenoss
For more information on module installation, please visit the detailed CPAN module installation guide.