Skip to content

ApplicationRouter

getApplicationConfigFiles(id) Returns all the configuration files for an application
getAllResourcePools(**query) Returns a list of resource pool identifiers.
@rtype: DirectResponse
@return: B{Properties}:
- data: ([String]) List of resource pool identifiers
deleteNode() Deletes a node from the tree.

B{NOTE}: You can not delete a root node of a tree

@type uid: string
@param uid: Unique identifier of the node we wish to delete
@rtype: DirectResponse
@return: B{Properties}:
- msg: (string) Status message
asyncGetTree(id) Returns the tree structure of the application and collector
hierarchy.

@type id: string
@param id: Id of the root node of the tree to be returned
@rtype: [dictionary]
@return: Object representing the tree
addNode() Add a node to the existing tree underneath the node specified
by the context UID

@type type: string
@param type: Either 'class' or 'organizer'
@type contextUid: string
@param contextUid: Path to the node that will
be the new node's parent (ex. /zport/dmd/Devices)
@type id: string
@param id: Identifier of the new node, must be unique in the
parent context
@type description: string
@param description: (optional) Describes this new node (default: None)
@rtype: dictionary
@return: Marshaled form of the created node
getInfo(id) Returns the serialized info object for the given id
@type: id: String
@param id: Valid id of a application
@rtype: DirectResponse
@return: DirectResponse with data of the application
getForm(uid) Given an object identifier, this returns all of the editable fields
on that object as well as their ExtJs xtype that one would
use on a client side form.

@type uid: string
@param uid: Unique identifier of an object
@rtype: DirectResponse
@return: B{Properties}
- form: (dictionary) form fields for the object
stop(uids) Will issue the command to stop the selected ids
@type uids: Array[Strings]
@param uids: List of valid daemon ids that will need to stopped
@rtype: DirectResposne
@return: DirectReponse of success if no errors are encountered
gzip_b64(string) gzip an arbitrary string, base64 encode it, and return it
getTree(id) Returns the tree structure of the application and collector
hierarchy.

@type id: string
@param id: Id of the root node of the tree to be returned
@rtype: [dictionary]
@return: Object representing the tree
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.
objectExists(uid) @rtype: DirectResponse
@return:
- Properties:
- B{exists} - Returns true if we can find the object specified by the uid
setAutoStart(uids, enabled) Enables or disables autostart on all applications passed into uids.
If it is already in that state it is a noop.
@type uids: Array[Strings]
@param uids: List of valid daemon ids that will need to enabled
@type enabled: boolean
@param uids: true for enabled or false for disabled
@rtype: DirectResposne
@return: DirectReponse of success if no errors are encountered
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
start(uids) Will issue the command to start the selected ids
@type uids: Array[Strings]
@param uids: List of valid daemon ids that will need to started
@rtype: DirectResposne
@return: DirectReponse of success if no errors are encountered
restart(uids) Will issue the command to restart the selected ids
@type uids: Array[Strings]
@param uids: List of valid daemon ids that will need to restarted
@rtype: DirectResposne
@return: DirectReponse of success if no errors are encountered
updateConfigFiles(id, configFiles) Updates the configuration files for an application specified by id.
The configFiles parameters is an array of dictionaries of the form:
{
filename: "blah",
content: "line 1
line 2
..."
}
The filename parameter serves as the "id" of each configFile
passed in.