Skip to content

ProcessRouter

getSequence() Get the current processes sequence.

@rtype: DirectResponse
@return: B{Properties}:
- data: ([dictionary]) List of objects representing processes in
sequence order
applyOSProcessClassMatchers() Get the current processes sequence.

@rtype: DirectResponse
@return: B{Properties}:
- data: ([dictionary]) List of objects representing processes in
sequence order
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(**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() 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(uid, **keys) Get the properties of a process.

@type uid: string
@param uid: Unique identifier of a process
@type keys: list
@param keys: (optional) List of keys to include in the returned
dictionary. If None then all keys will be returned
(default: None)
@rtype: DirectResponse
@return: B{Properties}
- data: (dictionary) Object representing a process's properties
gzip_b64(string) gzip an arbitrary string, base64 encode it, and return it
getProcessList() @type deviceGuid: string
@param deviceGuid: Service class UUID of the device to get process list
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
@rtype: [dictionary]
@return: Object representing the tree
setInfo() Set attributes on a process.
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 a process
@rtype: DirectResponse
@return: B{Properties}
- data: (dictionary) Object representing a process's new properties
objectExists(uid) @rtype: DirectResponse
@return:
- Properties:
- B{exists} - Returns true if we can find the object specified by the uid
query(**sort, **uid, **start, **limit, **criteria, **params, **page, **dir, **history) Retrieve a list of processes based on a set of parameters.

@type limit: integer
@param limit: (optional) Number of items to return; used in pagination
(default: None)
@type start: integer
@param start: (optional) Offset to return the results from; used in
pagination (default: None)
@type sort: string
@param sort: (optional) Key on which to sort the return results (default:
None)
@type dir: string
@param dir: (optional) Sort order; can be either 'ASC' or 'DESC'
(default: None)
@type params: dictionary
@param params: (optional) Key-value pair of filters for this search.
@type history: boolean
@param history: not used
@type uid: string
@param uid: Service class UID to query
@type criteria: list
@param criteria: not used
@rtype: DirectResponse
@return: B{Properties}:
- processes: ([dictionary]) List of objects representing processes
- totalCount: (integer) Total number of processes
- hash: (string) Hashcheck of the current processes state
- disabled: (boolean) True if current user cannot manage processes
getInstances(uid, **sort, **start, **params, **limit, **page, **dir) Get a list of instances for a process UID.

@type uid: string
@param uid: Process UID to get instances of
@type start: integer
@param start: (optional) Offset to return the results from; used in
pagination (default: 0)
@type params: dictionary
@param params: (optional) Key-value pair of filters for this search.
@type limit: integer
@param limit: (optional) Number of items to return; used in pagination
(default: 50)
@type sort: string
@param sort: (optional) Key on which to sort the return results (default:
'name')
@type dir: string
@param dir: (optional) Sort order; can be either 'ASC' or 'DESC'
(default: 'ASC')
@rtype: DirectResponse
@return: B{Properties}:
- data: ([dictionary]) List of objects representing process instances
- total: (integer) Total number of instances
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.
setSequence(uids) Set the current processes sequence.

@type uids: [string]
@param uids: The set of process uid's in the desired sequence
@rtype: DirectResponse
@return: Success message
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
moveProcess(uid, targetUid) Move a process or organizer from one organizer to another.

@type uid: string
@param uid: UID of the process or organizer to move
@type targetUid: string
@param targetUid: UID of the organizer to move to
@rtype: DirectResponse
@return: B{Properties}:
- uid: (dictionary) The new uid for moved process or organizer
getSequence2() Get the current processes sequence.

@rtype: DirectResponse
@return: B{Properties}:
- data: ([dictionary]) List of objects representing processes in
sequence order