Skip to content


gzip_b64(string) gzip an arbitrary string, base64 encode it, and return it
deleteNode(uid) Delete a subnet.

@type uid: string
@param uid: Unique identifier of the subnet to delete
@rtype: DirectResponse
@return: B{Properties}:
- tree: (dictionary) An object representing the new network tree
asyncGetTree(**additionalKeys, **id) Server side method for asynchronous tree calls. Retrieves
the immediate children of the node specified by "id"

NOTE: our convention on the UI side is if we are asking
for the root node then return the root and its children
otherwise just return the children

@type id: string
@param id: The uid of the node we are getting the children for
@rtype: [dictionary]
@return: Object representing the immediate children
addNode(newSubnet, contextUid) Add a new subnet.

@type newSubnet: string
@param newSubnet: New subnet to add
@type contextUid: string
@param contextUid: Unique identifier of the network parent of the new subnet
@rtype: DirectResponse
@return: B{Properties}:
- newNode: (dictionary) An object representing the new subnet node
getIpAddresses(uid, **sort, **start, **params, **limit, **page, **dir) Given a subnet, get a list of IP addresses and their relations.

@type uid: string
@param uid: Unique identifier of a subnet
@type start: integer
@param start: Offset to return the results from; used in pagination
@type params: string
@param params: Not used
@type limit: integer
@param limit: Number of items to return; used in pagination
@type sort: string
@param sort: (optional) Key on which to sort the return results;
defaults to 'name'
@type order: string
@param order: Sort order; can be either 'ASC' or 'DESC'
@rtype: DirectResponse
discoverDevices(uid) Discover devices on a network.

@type uid: string
@param uid: Unique identifier of the network to discover
@rtype: DirectResponse
@return: B{Properties}:
- jobId: (integer) The id of the discovery job
getInfo(uid, **keys) Returns a dictionary of the properties of an object

@type uid: string
@param uid: Unique identifier of an object
@type keys: list
@param keys: (optional) List of keys to include in the returned
dictionary. If None then all keys will be returned
@rtype: DirectResponse
@return: B{Properties}
- data: (dictionary) Object properties
removeIpAddresses(**uids) Removes every ip address specified by uids that are
not attached to any device
@type uids: Array of Strings
@param uids: unique identfiers of the ip addresses to delete
getTree(**id) Returns the tree structure of an organizer hierarchy where
the root node is the organizer identified by the id parameter.

@type id: string
@param id: Id of the root node of the tree to be returned. Defaults to
the Networks tree root.
@rtype: [dictionary]
@return: Object representing the tree
setInfo() Main method for setting attributes on a network or network organizer.
This method accepts any keyword argument for the property that you wish
to set. The only required property is "uid".

@type uid: string
@keyword uid: Unique identifier of an object
@rtype: DirectResponse
objectExists(uid) @rtype: DirectResponse
- Properties:
- B{exists} - Returns true if we can find the object specified by the uid
newDiscoveryJob(**zProperties, **collector, **networks)
gunzip_b64(string) Base 64 decode a string, then gunzip it and return the result as JSON.
The input to this method should be gzipped, base 64 encoded JSON. Base
64 encoded strings are allowed to have up to 2 '='s of padding. The zenoss
Ext router eats these, so there is some logic to try padding them back into
the string should initial decoding fail.
moveOrganizer(targetUid, organizerUid) Move the organizer uid to be underneath the organizer
specified by the targetUid.

@type targetUid: string
@param targetUid: New parent of the organizer
@type organizerUid: string
@param organizerUid: The organizer to move
@rtype: DirectResponse
@return: B{Properties}:
- data: (dictionary) Moved organizer