/ 
Zenoss-API-1.01
/ Zenoss::API::Router::Network

NAME

Zenoss::API::Router::Network - A JSON/ExtDirect interface to operations on networks

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

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->network_discoverDevices()

Discover devices on a network.

PARAMETERS

uid (string) - Unique identifier of the network to discover

REQUIRED PARAMETERS

uid

DEFAULT PARAMETERS

N/A

RETURNS

jobId: (integer) The id of the discovery job

$obj->network_addNode()

Discover devices on a network.

PARAMETERS

newSubnet (string) - New subnet to add

contextUid (string) - Unique identifier of the network parent of the new subnet

REQUIRED PARAMETERS

newSubnet

contextUid

DEFAULT PARAMETERS

N/A

RETURNS

newNode: (dictionary) An object representing the new subnet node

$obj->network_deleteNode()

Delete a subnet.

PARAMETERS

uid (string) - Unique identifier of the subnet to delete

REQUIRED PARAMETERS

uid

DEFAULT PARAMETERS

N/A

RETURNS

tree: (dictionary) An object representing the new network tree

$obj->network_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

N/A

DEFAULT PARAMETERS

{id => '/zport/dmd/Networks'}

RETURNS

Object representing the tree

$obj->network_getInfo()

Returns a dictionary of the properties of an object

PARAMETERS

uid (string) - Unique identifier of an object

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 properties

$obj->network_setInfo()

Main method for setting attributes on a device or device organizer. 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 an object

REQUIRED PARAMETERS

uid

DEFAULT PARAMETERS

N/A

RETURNS

Not documented

$obj->network_getIpAddresses()

Given a subnet, get a list of IP addresses and their relations.

PARAMETERS

uid (string) - Unique identifier of a subnet

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

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

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

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

REQUIRED PARAMETERS

uid

DEFAULT PARAMETERS

{start => 0, limit => 50, sort => 'name', order => 'ASC'}

RETURNS

Not documented

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.