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
Zenoss::Connector(3) User Contributed Perl Documentation Zenoss::Connector(3)
 

Zenoss::Connector - Module responsible for establishing a connection to the Zenoss API

    use Zenoss::Connector;
    use Zenoss::Router;
    
    # Create a connection object
    my $connection = Zenoss::Connector->new(
        {
            username    => 'admin',
            password    => 'zenoss',
            url         => 'http://zenossinstance:8080',
        }
    );
    
    # Pass the connection to the router
    my $api = Zenoss::Router->new(
        {
            connector => $connection,
        }
    );
    
    # Call some API methods
    my $response = $api->device_getDevices();
    
    # Print the JSON return
    print $response->json;

This module creates a connection to the Zenoss API, and tests the connectivity. Once a Zenoss::Connector object has been established, it can be passed to Zenoss::Router to process Zenoss API calls.
While this module can be used directly, it is recommended that Zenoss facilitates the connection to the Zenoss::Router.
A croak will occur in the event a connection cannot be established.

Attributes can be set on object creation, see SYNOPSIS, or by calling $obj->attribute('value').
Attributes can be retrieved by calling $obj->attribute.

The username to log in with at the Zenos instance

The password to log in with at the Zenos instance

The url to be used in establishing a connection to the Zenoss instance. Note, that ports in the http(s) url are not required unless they're non-stanard. For example the url can be set to:
http://zenossinstance
https://zenossinstance
Without having to specify :80 or :443. However, non-standard ports must be specified! Zenoss by default uses :8080, so this must be specified on the url if your instance uses this.
IE
http://zenossinstance:8080

The timeout value for processing transactions. Note, if you process a large request, IE getting all historical events, its prudent to set this value to something higher than the default of 120 seconds.

This attribute cannot be set. However, once the object is created this attribute can be accessed to provide the full url, with credentials, to the Zenoss instance. For example,
http://admin:zenoss@zenossinstance:8080

Zenoss
Zenoss::Response

Patrick Baker <patricksbaker@gmail.com>

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>.
2010-12-06 perl v5.28.1

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

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