Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Zenoss::Router::SearchUser Contributed Perl DocumentaZenoss::Router::Search(3)

NAME
       Zenoss::Router::Search -	A JSON/ExtDirect interface to operations on
       searches

SYNOPSIS
	   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'
	       }
	   );

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.

       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.

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.

   $obj->search_getLiveResults()
       Returns IQuickSearchResultSnippets for the results of the query.

       ARGUMENTS
	   query (string) - Query to search.  Note this	is like	typing a query
	   into	the live search	via the	Zenoss UI.

       REQUIRED	ARGUMENTS
	   query

       DEFAULT ARGUMENTS
	   N/A

       RETURNS
	   results: (dictionary) Search	results

   $obj->search_getAllResults()
       Returns ISearchResultSnippets for the results of	the query.  It would
       appear that this	returns	less HTML.

       ARGUMENTS
	   query (string) - Query to search.  Note this	is like	typing a query
	   into	the live search	via the	Zenoss UI.

       REQUIRED	ARGUMENTS
	   query

       DEFAULT ARGUMENTS
	   N/A

       RETURNS
	   total (integer): Number of results

	   results: (dictionary) Search	results

   $obj->search_getSavedSearch()
       Return query of saved search

       ARGUMENTS
	   searchName (string) - identifier of the search we are looking for

       REQUIRED	ARGUMENTS
	   searchName

       DEFAULT ARGUMENTS
	   N/A

       RETURNS
	   Saved Search	/ DirectResponse

   $obj->search_updateSavedSearch()
       Updates the specified search with the new query

       ARGUMENTS
	   searchName (string) - name of the search we want to update

	   queryString (string)	- value	of the new query we are	searching on

       REQUIRED	ARGUMENTS
	   searchName

	   queryString

       DEFAULT ARGUMENTS
	   N/A

       RETURNS
	   Saved Search	/ DirectResponse

   $obj->search_removeSavedSearch()
       Removes the search specified by searchName

       ARGUMENTS
	   searchName (string) - name of the search we want to remove

       REQUIRED	ARGUMENTS
	   searchName

       DEFAULT ARGUMENTS
	   N/A

       RETURNS
	   Direct Response (Success/Failure?)

   $obj->search_saveSearch()
       Adds this search	to our collection of saved searches

       ARGUMENTS
	   searchName (string) - term we are searching for

	   queryString (string)	- our query string's identifier

       REQUIRED	ARGUMENTS
	   searchName

       DEFAULT ARGUMENTS
	   N/A

       RETURNS
	   Direct Response (Success/Failure?)

   $obj->search_getAllSavedSearches()
       Returns all the searches	the logged in user can access

       ARGUMENTS
	   N/A

       REQUIRED	ARGUMENTS
	   N/A

       DEFAULT ARGUMENTS
	   query = NONE

	   addManageSavedSearch	= False

       RETURNS
	   results: (dictionary) saved searches

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

perl v5.32.1			  2011-08-14	     Zenoss::Router::Search(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | SEE ALSO | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Zenoss::Router::Search&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help