/ 
Zenoss-1.08
River stage zero No dependents
/ Zenoss::Router::Report

NAME

Zenoss::Router::Report - A JSON/ExtDirect interface to operations on reports

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->report_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 available 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.

$obj->report_getReportTypes()

Get the available report types.

ARGUMENTS

NONE

REQUIRED ARGUMENTS

N/A

DEFAULT ARGUMENTS

N/A

RETURNS

menuText: ([string]) Human readable list of report types

reportTypes: ([string]) A list of the available report type

$obj->report_getTree()

Returns the tree structure of an organizer hierarchy where the root node is the organizer identified by the id parameter.

ARGUMENTS

id (string) - (optional) Id of the root node of the tree to be returned

REQUIRED ARGUMENTS

N/A

DEFAULT ARGUMENTS

{id => '/zport/dmd/Reports'}

RETURNS

Object representing the tree

$obj->report_addNode()

Add a new report or report organizer.

ARGUMENTS

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

REQUIRED ARGUMENTS

nodeType

contextUid

id

DEFAULT ARGUMENTS

N/A

RETURNS

tree: (dictionary) Object representing the new Reports tree

newNode: (dictionary) Object representing the added node

$obj->report_deleteNode()

Remove a report or report organizer.

ARGUMENTS

uid (string) - The UID of the node to delete

REQUIRED ARGUMENTS

uid

DEFAULT ARGUMENTS

N/A

RETURNS

tree: (dictionary) Object representing the new Reports tree

$obj->report_moveNode()

Move a report or report organizer from one organizer to another.

ARGUMENTS

uids ([string]) - The UID's of nodes to move

target (string) - The UID of the target Report organizer

REQUIRED ARGUMENTS

uids

target

DEFAULT ARGUMENTS

N/A

RETURNS

tree: (dictionary) Object representing the new Reports tree

newNode: (dictionary) Object representing the moved node

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.