/ 
Zenoss-API
/ Zenoss::API::Router::Process

NAME

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

SYNOPSIS

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

# Replace SOMEMETHOD() with one of the available methods provided by this package
my $response = $api->zenoss->process_SOMEMETHOD({parameter1 => 'value', parameter2 => 'value'});

DESCRIPTION

This class is NOT instantiated directly. To call methods from this package create an instance of Zenoss::API. This document serves as a resource of available Zenoss API calls available for use with Zenoss::API.

$obj->process_getTree()

Returns the tree structure of an organizer hierarchy where the root node is the organizer identified by the id parameter.

PARAMETERS

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

REQUIRED PARAMETERS

id

target

DEFAULT PARAMETERS

N/A

RETURNS

Object representing the tree

$obj->process_moveProcess()

Move a process or organizer from one organizer to another.

PARAMETERS

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

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

REQUIRED PARAMETERS

uid

targetUid

DEFAULT PARAMETERS

N/A

RETURNS

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

$obj->process_getInfo()

Get the properties of a process.

PARAMETERS

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 PARAMETERS

uid

DEFAULT PARAMETERS

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

PARAMETERS

uid (string) - Unique identifier of a process

REQUIRED PARAMETERS

uid

DEFAULT PARAMETERS

N/A

RETURNS

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

$obj->process_getInstances()

Get a list of instances for a process UID.

PARAMETERS

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 PARAMETERS

uid

DEFAULT PARAMETERS

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

PARAMETERS

NONE

REQUIRED PARAMETERS

N/A

DEFAULT PARAMETERS

N/A

RETURNS

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

$obj->process_setSequence()

Set the current processes sequence.

PARAMETERS

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

REQUIRED PARAMETERS

uids

DEFAULT PARAMETERS

N/A

RETURNS

Success message

SEE ALSO

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.