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

FreeBSD Manual Pages

  
 
  

home | help
Zenoss::Router::ProcesUser Contributed Perl DocumentZenoss::Router::Process(3)

NAME
       Zenoss::Router::Process - A JSON/ExtDirect interface to operations on
       processes

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

   $obj->process_getTree()
       Returns the tree	structure of an	organizer hierarchy where the root
       node is the organizer identified	by the id parameter.

       ARGUMENTS
	   id (string) - Id of the root	node of	the tree to be returned

       REQUIRED	ARGUMENTS
	   id

	   target

       DEFAULT ARGUMENTS
	   N/A

       RETURNS
	   Object representing the tree

   $obj->process_moveProcess()
       Move a process or organizer from	one organizer to another.

       ARGUMENTS
	   uid (string)	- UID of the process or	organizer to move

	   targetUid (string) -	UID of the organizer to	move to

       REQUIRED	ARGUMENTS
	   uid

	   targetUid

       DEFAULT ARGUMENTS
	   N/A

       RETURNS
	   uid:	(dictionary) The new uid for moved process or organizer

   $obj->process_getInfo()
       Get the properties of a process.

       ARGUMENTS
	   uid (string)	- Unique identifier of a process

	   keys	(list) - List of keys to include in the	returned dictionary.
	   If None then	all keys will be returned

       REQUIRED	ARGUMENTS
	   uid

       DEFAULT ARGUMENTS
	   N/A

       RETURNS
	   data: (dictionary) Object representing a process's properties

   $obj->process_setInfo()
       Set attributes on a process. This method	accepts	any keyword argument
       for the property	that you wish to set. The only required	property is
       "uid".

       ARGUMENTS
	   uid (string)	- Unique identifier of a process

       REQUIRED	ARGUMENTS
	   uid

       DEFAULT ARGUMENTS
	   N/A

       RETURNS
	   data: (dictionary) Object representing a process's new properties

   $obj->process_getInstances()
       Get a list of instances for a process UID.

       ARGUMENTS
	   uid (string)	- Process UID to get instances of

	   start (integer) - Offset to return the results from;	used in
	   pagination

	   params (dictionary) - Key-value pair	of filters for this search.

	   limit (integer) - Number of items to	return;	used in	pagination

	   sort	(string) - Key on which	to sort	the return results

	   dir (string)	- Sort order; can be either 'ASC' or 'DESC'

       REQUIRED	ARGUMENTS
	   uid

       DEFAULT ARGUMENTS
	   {start => 0,	limit => 50, sort => 'name', dir => 'ASC'}

       RETURNS
	   data: ([dictionary])	List of	objects	representing process instances

	   total: (integer) Total number of instances

   $obj->process_getSequence()
       Get the current processes sequence.

       ARGUMENTS
	   NONE

       REQUIRED	ARGUMENTS
	   N/A

       DEFAULT ARGUMENTS
	   N/A

       RETURNS
	   data: ([dictionary])	List of	objects	representing processes in
	   sequence order

   $obj->process_setSequence()
       Set the current processes sequence.

       ARGUMENTS
	   uids	([string]) - The set of	process	uid's in the desired sequence

       REQUIRED	ARGUMENTS
	   uids

       DEFAULT ARGUMENTS
	   N/A

       RETURNS
	   Success message

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::Process(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::Process&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help