/ 
Zenoss-1.11
River stage zero No dependents
/ Zenoss::Router::Mib

NAME

Zenoss::Router::Mib - A JSON/ExtDirect interface to operations on MIBs

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->mib_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.

Mib is now working in Zenoss 3.2 - but the API docs are sketchy. You might need to trial and error to get things to work correctly. I recommend using FireBug with the UI to see what parameters are supposed to be sent!

$obj->device_getTree()

Not documented - however it likely returns the organizational structure of install mibs

ARGUMENTS

id

REQUIRED ARGUMENTS

id

DEFAULT ARGUMENTS

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

RETURNS

data: ([dictionary])

$obj->device_getOrganizerTree()

Not documented

ARGUMENTS

id

REQUIRED ARGUMENTS

id

DEFAULT ARGUMENTS

N/A

RETURNS

data: ([dictionary])

$obj->device_addNode()

Add organizer or MIB

ARGUMENTS

contextUid (string)

id (string)

type (string) - Can be either organizer or MIB

REQUIRED ARGUMENTS

id

DEFAULT ARGUMENTS

N/A

RETURNS

tree: ([dictionary])

$obj->device_deleteNode()

Delete node

ARGUMENTS

uid (string)

REQUIRED ARGUMENTS

uid

DEFAULT ARGUMENTS

N/A

RETURNS

tree: ([dictionary])

$obj->device_moveNode()

Move a node from its current organizer to another

ARGUMENTS

uids (list of strings)

target (string)

REQUIRED ARGUMENTS

uids

target

DEFAULT ARGUMENTS

N/A

RETURNS

tree: ([dictionary])

$obj->device_getInfo()

Returns the details of a single info object as well as the form describing its schema

ARGUMENTS

uid (string)

useFieldSets (bool)

REQUIRED ARGUMENTS

uid

DEFAULT ARGUMENTS

{useFieldSets => JSON::true}

RETURNS

success: ([bool])

data: ([dictionary])

$obj->device_setInfo()

Set info - no description

ARGUMENTS

uid (string)

any vars that can be set?

REQUIRED ARGUMENTS

uid

any vars that can be set?

DEFAULT ARGUMENTS

N/A

RETURNS

data: ([dictionary])

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.