action

Contents
casp1032
 
 
Use the Action resource to issue an action request to the 
SpectroSERVER
. An internal action code determines which operation is performed by the action.
  •  
    Base URL
     
    http://<hostname><:portnumber>/spectrum/restful/action
GET action
GET action issues an action request to the 
SpectroSERVER
. Initiated as an HTTP GET, the action performed on the 
SpectroSERVER
, including modifying data, is specified by an action code. All actions return results, which differ by the requested action.
  •  
    URL
     
    http://<hostname><:portnumber>/spectrum/restful/action/<action_code>[?mh=<model_handle>][&attr=<attr_ID>&val=<num>][&throttlesize=<num>]
  •  
    HTTP Method
    GET
  •  
    Body
    None
  •  
    Body Content
    Not used
  •  
    Header
    application/xml, application/json
  •  
    Output
    XML or JSON listing. Content differs depending on requested action.
 
URL Parameters
 
  •  
     
    action_code
     
    Specifies the action to perform on the 
    SpectroSERVER
    . The following table contains some common actions.
 
Action
 
 
Target Model
 
 
Description
 
0x1000e
device
Reconfigures a model (reconfig)
0x480003
watch
Activates a watch (activate)
0x480004
watch
Deactivates a watch (deactivate)
0x210008
device
Reconfigures application models on Cisco and Wellfleet devices (reconfigure_apps)
0x100a2
VNM
Updates the 
SpectroSERVER
 with changes to EventDisp and AlertMap files (reload_event_disp)
0x100f6
global collection
Updates membership for periodic search-based global collections
0x10274
VNM
Turns on EMS debugging
0x10275
VNM
Turns off EMS debugging
0x10301
VNM or global collection
Turns on Search Debug for all searches if directed to the VNM model or for a single global collection if directed to a global collection
0x10300
VNM or global collection
Turns off Search Debug for all searches if directed to the VNM model or for a single global collection if directed to a global collection
0xbc614d
RFC2790App
Toggles debug for File System Monitoring
0xbd6146
RFC2790App
Toggles debug for Process Monitoring
  •  
    &mh=<
    model_handle
    >
    (Optional) Specifies the target of the action.
  •  
    &attr=<
    attr_ID
    >&val=<
    num
    >
    (Optional) Specifies attribute values as input to the action. Multiple attribute-value pairs can be specified.
  •  
    &throttlesize=<
    num
    >
    (Optional) Specifies a throttle size.
 
Example
 
The following URL initiates the ‘FIND_DEV_MODELS_BY_IP’ action (0x10093) against the SearchManager model (0x400018):
http://<hostname><:portnumber>/spectrum/restful/action/0x10093?mh=0x400018&attr=0&val=172.22.96.11&attr=1&val=172.22.96.5
  • The SearchManager model handle will differ from 
    SpectroSERVER
     to 
    SpectroSERVER
    .
  • You can also find device models by IP by embedding the correct locater search in the POST body of a GET models.