GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  ZENOSS::ROUTER::TEMPLATE (3)

.ds Aq ’

NAME

Zenoss::Router::Template - A JSON/ExtDirect interface to operations on templates

CONTENTS

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

CW$obj->template_getTemplates()

Get all templates.
ARGUMENTS NONE
REQUIRED ARGUMENTS N/A
DEFAULT ARGUMENTS N/A
RETURNS List of objects representing the templates in tree hierarchy

CW$obj->template_getDeviceClassTemplates()

Get all templates by device class. This will return a tree where device classes are nodes, and templates are leaves.

THIS IS CURRENTLY BROKEN AT THE ZENOSS API LEVEL

CW$obj->template_getAddTemplateTargets()

Get a list of available device classes where new templates can be added.
ARGUMENTS NONE
REQUIRED ARGUMENTS N/A
DEFAULT ARGUMENTS N/A
RETURNS data: ([dictionary]) List of objects containing an available device class UID and a human-readable label for that class

CW$obj->template_addTemplate()

Add a template to a device class.
ARGUMENTS id (string) - Unique ID of the template to add

targetUid (string) - Unique ID of the device class to add template to

REQUIRED ARGUMENTS id

targetUid

DEFAULT ARGUMENTS N/A
RETURNS nodeConfig: (dictionary) Object representing the added template

CW$obj->template_deleteTemplate()

Delete a template.
ARGUMENTS uid (string) - Unique ID of the template to delete
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS Success message

CW$obj->template_getThresholds()

Get the thresholds for a template.
ARGUMENTS uid (string) - Unique ID of a template
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS List of objects representing representing thresholds

CW$obj->template_getThresholdDetails()

Get a threshold’s details.
ARGUMENTS uid (string) - Unique ID of a threshold
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS record: (dictionary) Object representing the threshold

form: (dictionary) Object representing an ExtJS form for the threshold

CW$obj->template_getDataPoints()

Get a list of available data points for a template.
ARGUMENTS uid (string) - Unique ID of a template
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS data: ([dictionary]) List of objects representing data points

CW$obj->template_addDataPoint()

Add a new data point to a data source.
ARGUMENTS dataSourceUid (string) - Unique ID of the data source to add data point to

name (string) - ID of the new data point

REQUIRED ARGUMENTS dataSourceUid

name

DEFAULT ARGUMENTS N/A
RETURNS Success message

CW$obj->template_addDataSource()

Add a new data source to a template.
ARGUMENTS templateUid (string) - Unique ID of the template to add data source to

name (string) - ID of the new data source

type (string) - Type of the new data source. From getDataSourceTypes()

REQUIRED ARGUMENTS templateUid

name

type

DEFAULT ARGUMENTS N/A
RETURNS Success message

CW$obj->template_getDataSources()

Get the data sources for a template.
ARGUMENTS id (string) - Unique ID of a template
REQUIRED ARGUMENTS id
DEFAULT ARGUMENTS N/A
RETURNS List of objects representing representing data sources

CW$obj->template_getDataSourceDetails()

Get a data source’s details.
ARGUMENTS uid (string) - Unique ID of a data source
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS record: (dictionary) Object representing the data source

form: (dictionary) Object representing an ExtJS form for the data source

CW$obj->template_getDataPointDetails()

Get a data point’s details.
ARGUMENTS uid (string) - Unique ID of a data point
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS record: (dictionary) Object representing the data point

form: (dictionary) Object representing an ExtJS form for the data point

CW$obj->template_setInfo()

Set attributes on an object. 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 an object
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS data: (dictionary) The modified object

CW$obj->template_addThreshold()

Add a threshold.
ARGUMENTS uid (string) - Unique identifier of template to add threshold to

thresholdType (string) - Type of the new threshold. From template_getThresholdTypes()

thresholdId (string) - ID of the new threshold

dataPoints ([string]) - List of data points to select for this threshold

REQUIRED ARGUMENTS uid

thresholdType

thresholdId

dataPoints

DEFAULT ARGUMENTS N/A
RETURNS Success message

CW$obj->template_removeThreshold()

Remove a threshold.
ARGUMENTS uid (string) - Unique identifier of threshold to remove
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS Success message

CW$obj->template_getThresholdTypes()

Get a list of available threshold types.
ARGUMENTS NONE
REQUIRED ARGUMENTS N/A
DEFAULT ARGUMENTS N/A
RETURNS List of objects representing threshold types

CW$obj->template_getDataSourceTypes()

Get a list of available data source types.
ARGUMENTS NONE
REQUIRED ARGUMENTS N/A
DEFAULT ARGUMENTS N/A
RETURNS List of objects representing data source types

CW$obj->template_getGraphs()

Get the graph definitions for a template.
ARGUMENTS uid (string) - Unique ID of a template
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS List of objects representing representing graphs

CW$obj->template_addDataPointToGraph()

Add a data point to a graph.
ARGUMENTS dataPointUid (string) - Unique ID of the data point to add to graph

graphUid (string) - Unique ID of the graph to add data point to

includeThresholds (boolean) - True to include related thresholds

REQUIRED ARGUMENTS dataPointUid

graphUid

DEFAULT ARGUMENTS { includeThresholds => JSON::false }
RETURNS Success message

CW$obj->template_getCopyTargets()

Get a list of available device classes to copy a template to.
ARGUMENTS uid (string) - Unique ID of the template to copy

query (string) - Filter the returned targets’ names based on this parameter

REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS { query => ’’ }
RETURNS data: ([dictionary]) List of objects containing an available device class UID and a human-readable label for that class

CW$obj->template_copyTemplate()

Copy a template to a device or device class.
ARGUMENTS uid (string) - Unique ID of the template to copy

targetUid (string) - Unique ID of the device or device class to bind to template

REQUIRED ARGUMENTS uid

targetUid

DEFAULT ARGUMENTS N/A
RETURNS Success message

CW$obj->template_addGraphDefinition()

Add a new graph definition to a template.
ARGUMENTS templateUid (string) - Unique ID of the template to add graph definition to

graphDefinitionId (string) - ID of the new graph definition

REQUIRED ARGUMENTS templateUid

graphDefinitionId

DEFAULT ARGUMENTS N/A
RETURNS Success message

CW$obj->template_deleteDataSource()

Delete a data source.
ARGUMENTS uid (string) - Unique ID of the data source to delete
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS Success message

CW$obj->template_deleteDataPoint()

Delete a data point.
ARGUMENTS uid (string) - Unique ID of the data point to delete
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS Success message

CW$obj->template_deleteGraphDefinition()

Delete a graph definition.
ARGUMENTS uid (string) - Unique ID of the graph definition to delete
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS Success message

CW$obj->template_deleteGraphPoint()

Delete a graph point.
ARGUMENTS uid (string) - Unique ID of the graph point to delete
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS Success message

CW$obj->template_getGraphPoints()

Get a list of graph points for a graph definition.
ARGUMENTS uid (string) - Unique ID of a graph definition
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS data: ([dictionary]) List of objects representing graph points

CW$obj->template_getInfo()

Get the properties of an object.
ARGUMENTS uid (string) - Unique identifier of an object
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS data: (dictionary) Object properties

form: (dictionary) Object representing an ExtJS form for the object

CW$obj->template_addThresholdToGraph()

Add a threshold to a graph definition.
ARGUMENTS graphUid (string) - Unique ID of the graph definition to add threshold to

thresholdUid (string) - Unique ID of the threshold to add

REQUIRED ARGUMENTS graphUid

thresholdUid

DEFAULT ARGUMENTS N/A
RETURNS Success message

CW$obj->template_addCustomToGraph()

Add a custom graph point to a graph definition.
ARGUMENTS graphUid (string) - Unique ID of the graph definition to add graph point to

customId (string) - ID of the new custom graph point

customType (string) - Type of the new graph point. From getGraphInstructionTypes()

REQUIRED ARGUMENTS graphUid

customId

customType

DEFAULT ARGUMENTS N/A
RETURNS Success message

CW$obj->template_getGraphInstructionTypes()

Get a list of available instruction types for graph points.
ARGUMENTS NONE
REQUIRED ARGUMENTS N/A
DEFAULT ARGUMENTS N/A
RETURNS data: ([dictionary]) List of objects representing instruction types

CW$obj->template_setGraphPointSequence()

Sets the sequence of graph points in a graph definition.
ARGUMENTS uids ([string]) - List of graph point UID’s in desired order
REQUIRED ARGUMENTS uids
DEFAULT ARGUMENTS N/A
RETURNS Success message

CW$obj->template_getGraphDefinition()

Get a graph definition.
ARGUMENTS uid (string) - Unique ID of the graph definition to retrieve
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS data: (dictionary) Object representing a graph definition

CW$obj->template_setGraphDefinition()

Set attributes on an graph definition. This method accepts any keyword argument for the property that you wish to set. Properties are enumerated via getGraphDefinition(). The only required property is uid.
ARGUMENTS uid (string) - Unique identifier of an object
REQUIRED ARGUMENTS uid
DEFAULT ARGUMENTS N/A
RETURNS data: (dictionary) The modified object

CW$obj->template_setGraphDefinitionSequence()

Sets the sequence of graph definitions.
ARGUMENTS uids ([string]) - List of graph definition UID’s in desired order
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>.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 ZENOSS::ROUTER::TEMPLATE (3) 2011-08-14

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.