Class NSSaintAgent
Administration and maintenance of SAINT counters and statuses.
Syntax
Examples
NSSaintAgent agent;
agent.callMethod(arg1, arg2);
Constructors
NSSaintAgent()
Administration and maintenance of SAINT counters and statuses.
Declaration
Examples
NSSaintAgent agent;
agent.callMethod(arg1, arg2);
Methods
CreateDefaultSaintConfiguration()
Sets default values into a new NSSaintConfiguration.
Declaration
NSSaintConfiguration CreateDefaultSaintConfiguration()
Returns
Examples
NSSaintAgent agent;
NSSaintConfiguration thing = agent.CreateDefaultSaintConfiguration();
thing = agent.SaveSaintConfiguration(thing);
CreateDefaultStatusMonitor()
Sets default values into a new NSStatusMonitor.
Declaration
NSStatusMonitor CreateDefaultStatusMonitor()
Returns
Examples
NSSaintAgent agent;
NSStatusMonitor thing = agent.CreateDefaultStatusMonitor();
thing = agent.SaveStatusMonitor(thing);
CreateDefaultStatusMonitorPeriods()
Sets default values into a new NSStatusMonitorPeriods.
Declaration
NSStatusMonitorPeriods CreateDefaultStatusMonitorPeriods()
Returns
Examples
NSSaintAgent agent;
NSStatusMonitorPeriods thing = agent.CreateDefaultStatusMonitorPeriods();
thing = agent.SaveStatusMonitorPeriods(thing);
GetSaintConfigurations()
Returns the NSStatusMonitorPeriods entity.
Declaration
NSSaintConfiguration[] GetSaintConfigurations()
Returns
Examples
NSSaintAgent agent;
NSSaintConfiguration[] res = agent.GetSaintConfigurations();
GetStatusMonitor(Integer)
Gets a single status monitor based on its identity
Declaration
NSStatusMonitor GetStatusMonitor(Integer id)
Parameters
Returns
Examples
NSSaintAgent agent;
Integer id;
NSStatusMonitor res = agent.GetStatusMonitor(id);
GetStatusMonitorPeriods()
Returns the NSStatusMonitorPeriods entity.
Declaration
NSStatusMonitorPeriods GetStatusMonitorPeriods()
Returns
Examples
NSSaintAgent agent;
NSStatusMonitorPeriods res = agent.GetStatusMonitorPeriods();
GetStatusMonitors(Integer,String)
Gets all active status monitors for a specified target
Declaration
NSStatusMonitor[] GetStatusMonitors(Integer id, String type)
Parameters
Returns
Examples
NSSaintAgent agent;
Integer id;
String type;
NSStatusMonitor[] res = agent.GetStatusMonitors(id, type);
RegenerateCounters(Bool)
Regenerates the Saint counters* this can take several minutes
Declaration
NSBatchTaskInfo RegenerateCounters(Bool runAsBatch)
Parameters
Type |
Name |
Description |
Bool |
runAsBatch |
|
Returns
Examples
NSSaintAgent agent;
Bool runAsBatch;
NSBatchTaskInfo res = agent.RegenerateCounters(runAsBatch);
RegenerateStatusMonitor(Integer)
Regenerates the given status monitor
Declaration
Void RegenerateStatusMonitor(Integer statusMonitorId)
Parameters
Type |
Name |
Description |
Integer |
statusMonitorId |
|
Returns
Examples
NSSaintAgent agent;
Integer statusMonitorId;
agent.RegenerateStatusMonitor(statusMonitorId);
RegenerateStatusMonitors(Bool)
Regenerates status monitors
Declaration
NSBatchTaskInfo RegenerateStatusMonitors(Bool runAsBatch)
Parameters
Type |
Name |
Description |
Bool |
runAsBatch |
|
Returns
Examples
NSSaintAgent agent;
Bool runAsBatch;
NSBatchTaskInfo res = agent.RegenerateStatusMonitors(runAsBatch);
SaveSaintConfiguration(NSSaintConfiguration)
Updates the existing NSSaintConfiguration or creates a new NSSaintConfiguration if the id parameter is 0.
Declaration
NSSaintConfiguration SaveSaintConfiguration(NSSaintConfiguration saintConfiguration)
Parameters
Returns
Examples
NSSaint agent;
NSSaintConfiguration thing = agent.CreateDefaultSaintConfiguration();
thing = agent.SaveSaintConfiguration(thing);
SaveStatusMonitor(NSStatusMonitor)
Updates the existing NSStatusMonitor or creates a new NSStatusMonitor if the id parameter is 0
Declaration
NSStatusMonitor SaveStatusMonitor(NSStatusMonitor statusMonitor)
Parameters
Type |
Name |
Description |
NSStatusMonitor |
statusMonitor |
The NSStatusMonitor to save.
|
Returns
Examples
NSSaint agent;
NSStatusMonitor thing = agent.CreateDefaultStatusMonitor();
thing = agent.SaveStatusMonitor(thing);
SaveStatusMonitorPeriods(NSStatusMonitorPeriods)
Updates the existing NSStatusMonitorPeriods or creates a new NSStatusMonitorPeriods if the id parameter is 0
Declaration
NSStatusMonitorPeriods SaveStatusMonitorPeriods(NSStatusMonitorPeriods statusMonitorPeriods)
Parameters
Returns
Examples
NSSaint agent;
NSStatusMonitorPeriods thing = agent.CreateDefaultStatusMonitorPeriods();
thing = agent.SaveStatusMonitorPeriods(thing);
SetRankOnStatusMonitors(String,Integer[])
Sets rank order on status monitors
Declaration
Void SetRankOnStatusMonitors(String type, Integer[] itemsIds)
Parameters
Returns
Examples
NSSaintAgent agent;
String type;
Integer[] itemsIds;
agent.SetRankOnStatusMonitors(type, itemsIds);