NAME
Zenoss::Router::Service - A JSON/ExtDirect interface to operations on services
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->service_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 available to Zenoss.
METHODS
The following is a list of available methods available for interaction with the Zenoss API. Please take note of the arguement requirements, defaults and return content.
$obj->service_addClass()
Add a new service class.
- PARAMETERS
-
contextUid (string) - Unique ID of the service ogranizer to add new class to
id (string) - ID of the new service
posQuery (dictionary) - Object defining a query where the returned position will lie
- RETURNS
-
newIndex: (integer) Index of the newly added class in the query defined by posQuery
$obj->service_query()
Retrieve a list of services based on a set of parameters.
- PARAMETERS
-
limit (integer) - Number of items to return; used in pagination
start (integer) - Offset to return the results from; used in pagination
sort (string) - Key on which to sort the return results
dir (string) - Sort order; can be either 'ASC' or 'DESC'
params (dictionary) - Key-value pair of filters for this search.
uid (string) - Service class UID to query
- RETURNS
-
services: ([dictionary]) List of objects representing services
totalCount: (integer) Total number of services
hash: (string) Hashcheck of the current services state
disabled: (boolean) True if current user cannot manage services
$obj->service_getTree()
Returns the tree structure of an organizer hierarchy.
- PARAMETERS
-
id (string) - Id of the root node of the tree to be returned
- RETURNS
-
Object representing the tree
$obj->service_getOrganizerTree()
Returns the tree structure of an organizer hierarchy, only including organizers.
- PARAMETERS
-
id (string) - Id of the root node of the tree to be returned
- RETURNS
-
Object representing the organizer tree
$obj->service_getInfo()
Get the properties of a service.
- PARAMETERS
-
uid (string) - Unique identifier of a service
keys (list) - List of keys to include in the returned dictionary. If None then all keys will be returned
- RETURNS
-
data: (dictionary) Object representing a service's properties
disabled: (boolean) True if current user cannot manage service
$obj->service_setInfo()
Set attributes on a service. 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 service
- RETURNS
-
Success message
$obj->service_getInstances()
Get a list of instances for a service UID.
- PARAMETERS
-
uid (string) - Service 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'
- RETURNS
-
data: ([dictionary]) List of objects representing service instances
totalCount: (integer) Total number of instances
$obj->service_moveServices()
Move service(s) from one organizer to another.
- PARAMETERS
-
sourceUids ([string]) - UID(s) of the service(s) to move
targetUid (string) - UID of the organizer to move to
- RETURNS
-
Success message
$obj->service_getUnmonitoredStartModes()
Get a list of unmonitored start modes for a Windows service.
- PARAMETERS
-
uid (string) - Unique ID of a Windows service.
- RETURNS
-
data: ([string]) List of unmonitored start modes for a Windows service
$obj->service_getMonitoredStartModes()
Get a list of monitored start modes for a Windows service.
- PARAMETERS
-
uid (string) - Unique ID of a Windows service.
- RETURNS
-
data: ([string]) List of monitored start modes for a Windows service
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.