GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  ZENOSS::ROUTER::TREE (3)

.ds Aq ’

NAME

Zenoss::Router::Tree - A common base class for routers that have a hierarchical tree structure.

CONTENTS

SYNOPSIS



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

    # Replace router and SOMEMETHOD() with one of the available methods provided by this module.
    # Note, that router will be replaced with something like device, network, process.  Please
    # read the DESCRIPTION for additional information.
    my $response = $api->router_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.

The following Zenoss::Router:: modules implement methods from Zenoss::Router::Tree
o Zenoss::Router::Device
o Zenoss::Router::Network
o Zenoss::Router::Process
o Zenoss::Router::Service
o Zenoss::Router::Template

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.

CW$obj->addNode()

Add a node to the existing tree underneath the node specified by the context UID
ARGUMENTS type (string) - Either ’class’ or ’organizer’

contextUid (string) - Path to the node that will be the new node’s parent (ex. /zport/dmd/Devices)

id (string) - Identifier of the new node, must be unique in the parent context

description (string) - Describes this new node

REQUIRED ARGUMENTS type

contextUid

id

DEFAULT ARGUMENTS N/A
RETURNS Marshaled form of the created node

CW$obj->deleteNode()

Deletes a node from the tree. <B>NOTE:B> You can not delete a root node of a tree
ARGUMENTS uid (string) - Unique identifier of the node we wish to delete
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS msg: (string) Status message

CW$obj->moveOrganizer()

Move the organizer uid to be underneath the organizer specified by the targetUid.
ARGUMENTS targetUid (string) - New parent of the organizer

organizerUid (string) - The organizer to move

REQUIRED ARGUMENTS targetUid

organizerUid

DEFAULT ARGUMENTS N/A
RETURNS data: (dictionary) Moved organizer

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 ZENOSS::ROUTER::TREE (3) 2011-08-14

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.