Zenoss::Router::Search - A JSON/ExtDirect interface to operations on searches
use Zenoss; my $api = Zenoss->connect( { username => 'zenoss username', password => 'zenoss password', url => 'http://zenossinstance:8080', } ); my $response = $api->search_getAllResults( { query => '10.10.10.1' } );
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.
Note, that use of this module is considered experimental! Zenoss hasn't documented these calls in the Public API JSON Docs, thus I've pieced together what I could from reading their code. Also, it would appear that this interface was meant to be used for the UI only as some of the attributes returned are formatted in HTML.
This module can be useful to search for meta information within a device. For example, I couldn't search for a specific interface (eth0) using the Zenoss::Router::Device module, but with Zenoss::Router::Search I can.
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.
Returns IQuickSearchResultSnippets for the results of the query.
query (string) - Query to search. Note this is like typing a query into the live search via the Zenoss UI.
query
N/A
results: (dictionary) Search results
Returns ISearchResultSnippets for the results of the query. It would appear that this returns less HTML.
total (integer): Number of results
Return query of saved search
searchName (string) - identifier of the search we are looking for
searchName
Saved Search / DirectResponse
Updates the specified search with the new query
searchName (string) - name of the search we want to update
queryString (string) - value of the new query we are searching on
queryString
Removes the search specified by searchName
searchName (string) - name of the search we want to remove
Direct Response (Success/Failure?)
Adds this search to our collection of saved searches
searchName (string) - term we are searching for
queryString (string) - our query string's identifier
Returns all the searches the logged in user can access
query = NONE
addManageSavedSearch = False
results: (dictionary) saved searches
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.