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 nodes 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
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
DEFAULT ARGUMENTS N/A RETURNS data: (dictionary) Moved organizer
Patrick Baker <firstname.lastname@example.org>
Copyright (C) 2010 by Patrick Baker <email@example.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>.
|perl v5.20.3||ZENOSS::ROUTER::TREE (3)||2011-08-14|