new Config()
Methods
agent(parentopt, reference, callbackopt) → {Array.<Agent>}
Searches for all Agents with the given reference within the given parent (if any). The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created. If the parent has been ommitted and the search yields no results and exception will be thrown.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
parent |
AgentGroup |
<optional> |
the AgentGroup inside which the agent must be. |
reference |
String | identifies objects. |
|
callback |
selectorCallbackAgent |
<optional> |
invoked for all matches of the search. |
Returns:
matching Agent objects in implementation defined order.
- Type
- Array.<Agent>
Examples
Search for all agents with reference 'ref' inside parent
var array = cfg.agent(parent, 'ref');
Search for all agents with reference 'ref' globally
var array = cfg.agent('ref');
Update or create a new Agent inside parent
cfg.agent(parent, 'ref', function(agent) { ... });
agentGroup(parentopt, reference, callbackopt) → {Array.<AgentGroup>}
Searches for all AgentGroups with the given reference within the given parent (if any). The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created. If the parent has been ommitted and the search yields no results and exception will be thrown.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
parent |
AgentGroup |
<optional> |
the AgentGroup inside which the agentGroup must be. |
reference |
String | identifies objects. |
|
callback |
selectorCallbackAgentGroup |
<optional> |
invoked for all matches of the search. |
Returns:
matching AgentGroup objects in implementation defined order.
- Type
- Array.<AgentGroup>
Examples
Search for all agentGroups with reference 'ref' inside parent
var array = cfg.agentGroup(parent, 'ref');
Search for all agentGroups with reference 'ref' globally
var array = cfg.agentGroup('ref');
Update or create a new AgentGroup inside parent
cfg.agentGroup(parent, 'ref', function(agentGroup) { ... });
agentGroups(parent, reference, instances, callback) → {Array.<AgentGroup>}
Searches for all AgentGroups with the given reference within the given parent (if any). The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance. If the parent has been ommitted but is required an exception will be thrown.
Parameters:
Name | Type | Description |
---|---|---|
parent |
AgentGroup | the AgentGroup inside which the agentGroup must be. |
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackAgentGroup | invoked for all instances. |
Returns:
all processed AgentGroup objects in implementation defined order.
- Type
- Array.<AgentGroup>
Example
Create AgentGroup instances for every element of the instances array
var agentGroups = cfg.agentGroups(parent, 'ref', ['node1', 'node2'], function(agentGroup, instance) { ... });
agents(parent, reference, instances, callback) → {Array.<Agent>}
Searches for all Agents with the given reference within the given parent (if any). The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance. If the parent has been ommitted but is required an exception will be thrown.
Parameters:
Name | Type | Description |
---|---|---|
parent |
AgentGroup | the AgentGroup inside which the agent must be. |
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackAgent | invoked for all instances. |
Returns:
all processed Agent objects in implementation defined order.
- Type
- Array.<Agent>
Example
Create Agent instances for every element of the instances array
var agents = cfg.agents(parent, 'ref', ['node1', 'node2'], function(agent, instance) { ... });
chart(parentopt, reference, callbackopt) → {Array.<Chart>}
Searches for all Charts with the given reference within the given parent (if any). The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created. If the parent has been ommitted and the search yields no results and exception will be thrown.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
parent |
Dashboard |
<optional> |
the Dashboard inside which the chart must be. |
reference |
String | identifies objects. |
|
callback |
selectorCallbackChart |
<optional> |
invoked for all matches of the search. |
Returns:
matching Chart objects in implementation defined order.
- Type
- Array.<Chart>
Examples
Search for all charts with reference 'ref' inside parent
var array = cfg.chart(parent, 'ref');
Search for all charts with reference 'ref' globally
var array = cfg.chart('ref');
Update or create a new Chart inside parent
cfg.chart(parent, 'ref', function(chart) { ... });
charts(parent, reference, instances, callback) → {Array.<Chart>}
Searches for all Charts with the given reference within the given parent (if any). The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance. If the parent has been ommitted but is required an exception will be thrown.
Parameters:
Name | Type | Description |
---|---|---|
parent |
Dashboard | the Dashboard inside which the chart must be. |
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackChart | invoked for all instances. |
Returns:
all processed Chart objects in implementation defined order.
- Type
- Array.<Chart>
Example
Create Chart instances for every element of the instances array
var charts = cfg.charts(parent, 'ref', ['node1', 'node2'], function(chart, instance) { ... });
configObject(reference, callbackopt) → {Array.<ConfigObject>}
Searches for all ConfigObjects with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackConfigObject |
<optional> |
invoked for all matches of the search. |
Returns:
matching ConfigObject objects in implementation defined order.
- Type
- Array.<ConfigObject>
Examples
Search for all configObjects with reference 'ref' globally
var array = cfg.configObject('ref');
Update or create a new ConfigObject
cfg.configObject('ref', function(configObject) { ... });
configObjects(reference, instances, callback) → {Array.<ConfigObject>}
Searches for all ConfigObjects with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackConfigObject | invoked for all instances. |
Returns:
all processed ConfigObject objects in implementation defined order.
- Type
- Array.<ConfigObject>
Example
Create ConfigObject instances for every element of the instances array
var configObjects = cfg.configObjects('ref', ['node1', 'node2'], function(configObject, instance) { ... });
counter(reference, callbackopt) → {Array.<Counter>}
Searches for all Counters with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackCounter |
<optional> |
invoked for all matches of the search. |
Returns:
matching Counter objects in implementation defined order.
- Type
- Array.<Counter>
Examples
Search for all counters with reference 'ref' globally
var array = cfg.counter('ref');
Update or create a new Counter
cfg.counter('ref', function(counter) { ... });
counters(reference, instances, callback) → {Array.<Counter>}
Searches for all Counters with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackCounter | invoked for all instances. |
Returns:
all processed Counter objects in implementation defined order.
- Type
- Array.<Counter>
Example
Create Counter instances for every element of the instances array
var counters = cfg.counters('ref', ['node1', 'node2'], function(counter, instance) { ... });
dashboard(reference, callbackopt) → {Array.<Dashboard>}
Searches for all Dashboards with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackDashboard |
<optional> |
invoked for all matches of the search. |
Returns:
matching Dashboard objects in implementation defined order.
- Type
- Array.<Dashboard>
Examples
Search for all dashboards with reference 'ref' globally
var array = cfg.dashboard('ref');
Update or create a new Dashboard
cfg.dashboard('ref', function(dashboard) { ... });
dashboards(reference, instances, callback) → {Array.<Dashboard>}
Searches for all Dashboards with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackDashboard | invoked for all instances. |
Returns:
all processed Dashboard objects in implementation defined order.
- Type
- Array.<Dashboard>
Example
Create Dashboard instances for every element of the instances array
var dashboards = cfg.dashboards('ref', ['node1', 'node2'], function(dashboard, instance) { ... });
enumInstances(agent, protocol, query) → {Array.<string>}
Enumerate all instances of the given protocol on the target identified by agent. Note: The special instance with the name "_Total" will NOT be returned in the set.
Parameters:
Name | Type | Description |
---|---|---|
agent |
Number | Agent | The Agent#id of an agent or an ionstance of Agent that shall be queried. Note: The Agent must already have been committed in a previous upgrade transaction before it can be used. |
protocol |
ServiceCheckProtocol | the protocol used to enumerate based on the given query. |
query |
String | a protocol specific query to limit the returned instances. |
Returns:
array of instance names.
- Type
- Array.<string>
fabasoftServiceDesk(reference, callbackopt) → {Array.<ServiceDeskFabasoftCloudTicketing>}
Searches for all ServiceDeskFabasoftCloudTicketings with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackServiceDeskFabasoftCloudTicketing |
<optional> |
invoked for all matches of the search. |
Returns:
matching ServiceDeskFabasoftCloudTicketing objects in implementation defined order.
- Type
- Array.<ServiceDeskFabasoftCloudTicketing>
Examples
Search for all fabasoftServiceDesks with reference 'ref' globally
var array = cfg.fabasoftServiceDesk('ref');
Update or create a new ServiceDeskFabasoftCloudTicketing
cfg.fabasoftServiceDesk('ref', function(fabasoftServiceDesk) { ... });
fabasoftServiceDesks(reference, instances, callback) → {Array.<ServiceDeskFabasoftCloudTicketing>}
Searches for all ServiceDeskFabasoftCloudTicketings with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackServiceDeskFabasoftCloudTicketing | invoked for all instances. |
Returns:
all processed ServiceDeskFabasoftCloudTicketing objects in implementation defined order.
- Type
- Array.<ServiceDeskFabasoftCloudTicketing>
Example
Create ServiceDeskFabasoftCloudTicketing instances for every element of the instances array
var fabasoftServiceDesks = cfg.fabasoftServiceDesks('ref', ['node1', 'node2'], function(fabasoftServiceDesk, instance) { ... });
filteredLogPool(parent, reference, callbackopt) → {Array.<FilterLogAnalyzer>}
Searches for all FilterLogAnalyzers with the given reference within the given parent (if any). The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created. If the parent has been ommitted and the search yields no results and exception will be thrown.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
parent |
APMLogAnalyzer | FilterLogAnalyzer | WebTimingLogAnalyzer | FormLogAnalyzer | the APMLogAnalyzer|FilterLogAnalyzer|WebTimingLogAnalyzer|FormLogAnalyzer inside which the filteredLogPool must be. |
|
reference |
String | identifies objects. |
|
callback |
selectorCallbackFilterLogAnalyzer |
<optional> |
invoked for all matches of the search. |
Returns:
matching FilterLogAnalyzer objects in implementation defined order.
- Type
- Array.<FilterLogAnalyzer>
Examples
Search for all filteredLogPools with reference 'ref' inside parent
var array = cfg.filteredLogPool(parent, 'ref');
Search for all filteredLogPools with reference 'ref' globally
var array = cfg.filteredLogPool('ref');
Update or create a new FilterLogAnalyzer inside parent
cfg.filteredLogPool(parent, 'ref', function(filteredLogPool) { ... });
filteredLogPools(parent, reference, instances, callback) → {Array.<FilterLogAnalyzer>}
Searches for all FilterLogAnalyzers with the given reference within the given parent (if any). The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance. If the parent has been ommitted but is required an exception will be thrown.
Parameters:
Name | Type | Description |
---|---|---|
parent |
APMLogAnalyzer | FilterLogAnalyzer | WebTimingLogAnalyzer | FormLogAnalyzer | the APMLogAnalyzer|FilterLogAnalyzer|WebTimingLogAnalyzer|FormLogAnalyzer inside which the filteredLogPool must be. |
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackFilterLogAnalyzer | invoked for all instances. |
Returns:
all processed FilterLogAnalyzer objects in implementation defined order.
- Type
- Array.<FilterLogAnalyzer>
Example
Create FilterLogAnalyzer instances for every element of the instances array
var filteredLogPools = cfg.filteredLogPools(parent, 'ref', ['node1', 'node2'], function(filteredLogPool, instance) { ... });
formLogPool(reference, callbackopt) → {Array.<FormLogAnalyzer>}
Searches for all FormLogAnalyzers with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackFormLogAnalyzer |
<optional> |
invoked for all matches of the search. |
Returns:
matching FormLogAnalyzer objects in implementation defined order.
- Type
- Array.<FormLogAnalyzer>
Examples
Search for all formLogPools with reference 'ref' globally
var array = cfg.formLogPool('ref');
Update or create a new FormLogAnalyzer
cfg.formLogPool('ref', function(formLogPool) { ... });
formLogPools(reference, instances, callback) → {Array.<FormLogAnalyzer>}
Searches for all FormLogAnalyzers with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackFormLogAnalyzer | invoked for all instances. |
Returns:
all processed FormLogAnalyzer objects in implementation defined order.
- Type
- Array.<FormLogAnalyzer>
Example
Create FormLogAnalyzer instances for every element of the instances array
var formLogPools = cfg.formLogPools('ref', ['node1', 'node2'], function(formLogPool, instance) { ... });
holiday(reference, callbackopt) → {Array.<Holiday>}
Searches for all Holidays with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackHoliday |
<optional> |
invoked for all matches of the search. |
Returns:
matching Holiday objects in implementation defined order.
- Type
- Array.<Holiday>
Examples
Search for all holidays with reference 'ref' globally
var array = cfg.holiday('ref');
Update or create a new Holiday
cfg.holiday('ref', function(holiday) { ... });
holidays(reference, instances, callback) → {Array.<Holiday>}
Searches for all Holidays with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackHoliday | invoked for all instances. |
Returns:
all processed Holiday objects in implementation defined order.
- Type
- Array.<Holiday>
Example
Create Holiday instances for every element of the instances array
var holidays = cfg.holidays('ref', ['node1', 'node2'], function(holiday, instance) { ... });
label(reference, callbackopt) → {Array.<Label>}
Searches for all Labels with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackLabel |
<optional> |
invoked for all matches of the search. |
Returns:
matching Label objects in implementation defined order.
- Type
- Array.<Label>
Examples
Search for all labels with reference 'ref' globally
var array = cfg.label('ref');
Update or create a new Label
cfg.label('ref', function(label) { ... });
labels(reference, instances, callback) → {Array.<Label>}
Searches for all Labels with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackLabel | invoked for all instances. |
Returns:
all processed Label objects in implementation defined order.
- Type
- Array.<Label>
Example
Create Label instances for every element of the instances array
var labels = cfg.labels('ref', ['node1', 'node2'], function(label, instance) { ... });
logPool(reference, callbackopt) → {Array.<APMLogAnalyzer>}
Searches for all APMLogAnalyzers with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackAPMLogAnalyzer |
<optional> |
invoked for all matches of the search. |
Returns:
matching APMLogAnalyzer objects in implementation defined order.
- Type
- Array.<APMLogAnalyzer>
Examples
Search for all logPools with reference 'ref' globally
var array = cfg.logPool('ref');
Update or create a new APMLogAnalyzer
cfg.logPool('ref', function(logPool) { ... });
logPools(reference, instances, callback) → {Array.<APMLogAnalyzer>}
Searches for all APMLogAnalyzers with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackAPMLogAnalyzer | invoked for all instances. |
Returns:
all processed APMLogAnalyzer objects in implementation defined order.
- Type
- Array.<APMLogAnalyzer>
Example
Create APMLogAnalyzer instances for every element of the instances array
var logPools = cfg.logPools('ref', ['node1', 'node2'], function(logPool, instance) { ... });
logPoolStatistic(reference, callbackopt) → {Array.<LogStatistic>}
Searches for all LogStatistics with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackLogStatistic |
<optional> |
invoked for all matches of the search. |
Returns:
matching LogStatistic objects in implementation defined order.
- Type
- Array.<LogStatistic>
Examples
Search for all logPoolStatistics with reference 'ref' globally
var array = cfg.logPoolStatistic('ref');
Update or create a new LogStatistic
cfg.logPoolStatistic('ref', function(logPoolStatistic) { ... });
logPoolStatistics(reference, instances, callback) → {Array.<LogStatistic>}
Searches for all LogStatistics with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackLogStatistic | invoked for all instances. |
Returns:
all processed LogStatistic objects in implementation defined order.
- Type
- Array.<LogStatistic>
Example
Create LogStatistic instances for every element of the instances array
var logPoolStatistics = cfg.logPoolStatistics('ref', ['node1', 'node2'], function(logPoolStatistic, instance) { ... });
module(reference, callbackopt) → {Array.<Module>}
Searches for all Modules with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackModule |
<optional> |
invoked for all matches of the search. |
Returns:
matching Module objects in implementation defined order.
- Type
- Array.<Module>
Examples
Search for all modules with reference 'ref' globally
var array = cfg.module('ref');
Update or create a new Module
cfg.module('ref', function(module) { ... });
modules(reference, instances, callback) → {Array.<Module>}
Searches for all Modules with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackModule | invoked for all instances. |
Returns:
all processed Module objects in implementation defined order.
- Type
- Array.<Module>
Example
Create Module instances for every element of the instances array
var modules = cfg.modules('ref', ['node1', 'node2'], function(module, instance) { ... });
mssqlDatabaseConnection(reference, callbackopt) → {Array.<DatabaseConnectionOLEDB>}
Searches for all DatabaseConnectionOLEDBs with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackDatabaseConnectionOLEDB |
<optional> |
invoked for all matches of the search. |
Returns:
matching DatabaseConnectionOLEDB objects in implementation defined order.
- Type
- Array.<DatabaseConnectionOLEDB>
Examples
Search for all mssqlDatabaseConnections with reference 'ref' globally
var array = cfg.mssqlDatabaseConnection('ref');
Update or create a new DatabaseConnectionOLEDB
cfg.mssqlDatabaseConnection('ref', function(mssqlDatabaseConnection) { ... });
mssqlDatabaseConnections(reference, instances, callback) → {Array.<DatabaseConnectionOLEDB>}
Searches for all DatabaseConnectionOLEDBs with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackDatabaseConnectionOLEDB | invoked for all instances. |
Returns:
all processed DatabaseConnectionOLEDB objects in implementation defined order.
- Type
- Array.<DatabaseConnectionOLEDB>
Example
Create DatabaseConnectionOLEDB instances for every element of the instances array
var mssqlDatabaseConnections = cfg.mssqlDatabaseConnections('ref', ['node1', 'node2'], function(mssqlDatabaseConnection, instance) { ... });
notificationAccount(parentopt, reference, callbackopt) → {Array.<NotificationAccount>}
Searches for all NotificationAccounts with the given reference within the given parent (if any). The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created. If the parent has been ommitted and the search yields no results and exception will be thrown.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
parent |
NotificationChannel |
<optional> |
the NotificationChannel inside which the notificationAccount must be. |
reference |
String | identifies objects. |
|
callback |
selectorCallbackNotificationAccount |
<optional> |
invoked for all matches of the search. |
Returns:
matching NotificationAccount objects in implementation defined order.
- Type
- Array.<NotificationAccount>
Examples
Search for all notificationAccounts with reference 'ref' inside parent
var array = cfg.notificationAccount(parent, 'ref');
Search for all notificationAccounts with reference 'ref' globally
var array = cfg.notificationAccount('ref');
Update or create a new NotificationAccount inside parent
cfg.notificationAccount(parent, 'ref', function(notificationAccount) { ... });
notificationAccounts(parent, reference, instances, callback) → {Array.<NotificationAccount>}
Searches for all NotificationAccounts with the given reference within the given parent (if any). The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance. If the parent has been ommitted but is required an exception will be thrown.
Parameters:
Name | Type | Description |
---|---|---|
parent |
NotificationChannel | the NotificationChannel inside which the notificationAccount must be. |
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackNotificationAccount | invoked for all instances. |
Returns:
all processed NotificationAccount objects in implementation defined order.
- Type
- Array.<NotificationAccount>
Example
Create NotificationAccount instances for every element of the instances array
var notificationAccounts = cfg.notificationAccounts(parent, 'ref', ['node1', 'node2'], function(notificationAccount, instance) { ... });
notificationChannel(reference, callbackopt) → {Array.<NotificationChannel>}
Searches for all NotificationChannels with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackNotificationChannel |
<optional> |
invoked for all matches of the search. |
Returns:
matching NotificationChannel objects in implementation defined order.
- Type
- Array.<NotificationChannel>
Examples
Search for all notificationChannels with reference 'ref' globally
var array = cfg.notificationChannel('ref');
Update or create a new NotificationChannel
cfg.notificationChannel('ref', function(notificationChannel) { ... });
notificationChannels(reference, instances, callback) → {Array.<NotificationChannel>}
Searches for all NotificationChannels with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackNotificationChannel | invoked for all instances. |
Returns:
all processed NotificationChannel objects in implementation defined order.
- Type
- Array.<NotificationChannel>
Example
Create NotificationChannel instances for every element of the instances array
var notificationChannels = cfg.notificationChannels('ref', ['node1', 'node2'], function(notificationChannel, instance) { ... });
notificationSchedule(reference, callbackopt) → {Array.<NotificationSchedule>}
Searches for all NotificationSchedules with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackNotificationSchedule |
<optional> |
invoked for all matches of the search. |
Returns:
matching NotificationSchedule objects in implementation defined order.
- Type
- Array.<NotificationSchedule>
Examples
Search for all notificationSchedules with reference 'ref' globally
var array = cfg.notificationSchedule('ref');
Update or create a new NotificationSchedule
cfg.notificationSchedule('ref', function(notificationSchedule) { ... });
notificationSchedules(reference, instances, callback) → {Array.<NotificationSchedule>}
Searches for all NotificationSchedules with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackNotificationSchedule | invoked for all instances. |
Returns:
all processed NotificationSchedule objects in implementation defined order.
- Type
- Array.<NotificationSchedule>
Example
Create NotificationSchedule instances for every element of the instances array
var notificationSchedules = cfg.notificationSchedules('ref', ['node1', 'node2'], function(notificationSchedule, instance) { ... });
pgsqlDatabaseConnection(reference, callbackopt) → {Array.<DatabaseConnectionPostgreSQL>}
Searches for all DatabaseConnectionPostgreSQLs with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackDatabaseConnectionPostgreSQL |
<optional> |
invoked for all matches of the search. |
Returns:
matching DatabaseConnectionPostgreSQL objects in implementation defined order.
- Type
- Array.<DatabaseConnectionPostgreSQL>
Examples
Search for all pgsqlDatabaseConnections with reference 'ref' globally
var array = cfg.pgsqlDatabaseConnection('ref');
Update or create a new DatabaseConnectionPostgreSQL
cfg.pgsqlDatabaseConnection('ref', function(pgsqlDatabaseConnection) { ... });
pgsqlDatabaseConnections(reference, instances, callback) → {Array.<DatabaseConnectionPostgreSQL>}
Searches for all DatabaseConnectionPostgreSQLs with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackDatabaseConnectionPostgreSQL | invoked for all instances. |
Returns:
all processed DatabaseConnectionPostgreSQL objects in implementation defined order.
- Type
- Array.<DatabaseConnectionPostgreSQL>
Example
Create DatabaseConnectionPostgreSQL instances for every element of the instances array
var pgsqlDatabaseConnections = cfg.pgsqlDatabaseConnections('ref', ['node1', 'node2'], function(pgsqlDatabaseConnection, instance) { ... });
server(reference, callbackopt) → {Array.<Server>}
Searches for all Servers with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackServer |
<optional> |
invoked for all matches of the search. |
Returns:
matching Server objects in implementation defined order.
- Type
- Array.<Server>
Examples
Search for all servers with reference 'ref' globally
var array = cfg.server('ref');
Update or create a new Server
cfg.server('ref', function(server) { ... });
servers(reference, instances, callback) → {Array.<Server>}
Searches for all Servers with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackServer | invoked for all instances. |
Returns:
all processed Server objects in implementation defined order.
- Type
- Array.<Server>
Example
Create Server instances for every element of the instances array
var servers = cfg.servers('ref', ['node1', 'node2'], function(server, instance) { ... });
serverSettings()
Returns:
service(parentopt, reference, callbackopt) → {Array.<Service>}
Searches for all Services with the given reference within the given parent (if any). The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created. If the parent has been ommitted and the search yields no results and exception will be thrown.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
parent |
ServiceGroup |
<optional> |
the ServiceGroup inside which the service must be. |
reference |
String | identifies objects. |
|
callback |
selectorCallbackService |
<optional> |
invoked for all matches of the search. |
Returns:
matching Service objects in implementation defined order.
- Type
- Array.<Service>
Examples
Search for all services with reference 'ref' inside parent
var array = cfg.service(parent, 'ref');
Search for all services with reference 'ref' globally
var array = cfg.service('ref');
Update or create a new Service inside parent
cfg.service(parent, 'ref', function(service) { ... });
serviceCheck(parentopt, reference, callbackopt) → {Array.<ServiceCheck>}
Searches for all ServiceChecks with the given reference within the given parent (if any). The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created. If the parent has been ommitted and the search yields no results and exception will be thrown.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
parent |
Service |
<optional> |
the Service inside which the serviceCheck must be. |
reference |
String | identifies objects. |
|
callback |
selectorCallbackServiceCheck |
<optional> |
invoked for all matches of the search. |
Returns:
matching ServiceCheck objects in implementation defined order.
- Type
- Array.<ServiceCheck>
Examples
Search for all serviceChecks with reference 'ref' inside parent
var array = cfg.serviceCheck(parent, 'ref');
Search for all serviceChecks with reference 'ref' globally
var array = cfg.serviceCheck('ref');
Update or create a new ServiceCheck inside parent
cfg.serviceCheck(parent, 'ref', function(serviceCheck) { ... });
serviceChecks(parent, reference, instances, callback) → {Array.<ServiceCheck>}
Searches for all ServiceChecks with the given reference within the given parent (if any). The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance. If the parent has been ommitted but is required an exception will be thrown.
Parameters:
Name | Type | Description |
---|---|---|
parent |
Service | the Service inside which the serviceCheck must be. |
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackServiceCheck | invoked for all instances. |
Returns:
all processed ServiceCheck objects in implementation defined order.
- Type
- Array.<ServiceCheck>
Example
Create ServiceCheck instances for every element of the instances array
var serviceChecks = cfg.serviceChecks(parent, 'ref', ['node1', 'node2'], function(serviceCheck, instance) { ... });
serviceDesk(reference, callbackopt) → {Array.<ServiceDesk>}
Searches for all ServiceDesks with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackServiceDesk |
<optional> |
invoked for all matches of the search. |
Returns:
matching ServiceDesk objects in implementation defined order.
- Type
- Array.<ServiceDesk>
Examples
Search for all serviceDesks with reference 'ref' globally
var array = cfg.serviceDesk('ref');
Update or create a new ServiceDesk
cfg.serviceDesk('ref', function(serviceDesk) { ... });
serviceDesks(reference, instances, callback) → {Array.<ServiceDesk>}
Searches for all ServiceDesks with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackServiceDesk | invoked for all instances. |
Returns:
all processed ServiceDesk objects in implementation defined order.
- Type
- Array.<ServiceDesk>
Example
Create ServiceDesk instances for every element of the instances array
var serviceDesks = cfg.serviceDesks('ref', ['node1', 'node2'], function(serviceDesk, instance) { ... });
serviceGroup(parentopt, reference, callbackopt) → {Array.<ServiceGroup>}
Searches for all ServiceGroups with the given reference within the given parent (if any). The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created. If the parent has been ommitted and the search yields no results and exception will be thrown.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
parent |
ServiceGroup |
<optional> |
the ServiceGroup inside which the serviceGroup must be. |
reference |
String | identifies objects. |
|
callback |
selectorCallbackServiceGroup |
<optional> |
invoked for all matches of the search. |
Returns:
matching ServiceGroup objects in implementation defined order.
- Type
- Array.<ServiceGroup>
Examples
Search for all serviceGroups with reference 'ref' inside parent
var array = cfg.serviceGroup(parent, 'ref');
Search for all serviceGroups with reference 'ref' globally
var array = cfg.serviceGroup('ref');
Update or create a new ServiceGroup inside parent
cfg.serviceGroup(parent, 'ref', function(serviceGroup) { ... });
serviceGroups(parent, reference, instances, callback) → {Array.<ServiceGroup>}
Searches for all ServiceGroups with the given reference within the given parent (if any). The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance. If the parent has been ommitted but is required an exception will be thrown.
Parameters:
Name | Type | Description |
---|---|---|
parent |
ServiceGroup | the ServiceGroup inside which the serviceGroup must be. |
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackServiceGroup | invoked for all instances. |
Returns:
all processed ServiceGroup objects in implementation defined order.
- Type
- Array.<ServiceGroup>
Example
Create ServiceGroup instances for every element of the instances array
var serviceGroups = cfg.serviceGroups(parent, 'ref', ['node1', 'node2'], function(serviceGroup, instance) { ... });
services(parent, reference, instances, callback) → {Array.<Service>}
Searches for all Services with the given reference within the given parent (if any). The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance. If the parent has been ommitted but is required an exception will be thrown.
Parameters:
Name | Type | Description |
---|---|---|
parent |
ServiceGroup | the ServiceGroup inside which the service must be. |
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackService | invoked for all instances. |
Returns:
all processed Service objects in implementation defined order.
- Type
- Array.<Service>
Example
Create Service instances for every element of the instances array
var services = cfg.services(parent, 'ref', ['node1', 'node2'], function(service, instance) { ... });
slaDefinition(reference, callbackopt) → {Array.<SLADefinition>}
Searches for all SLADefinitions with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackSLADefinition |
<optional> |
invoked for all matches of the search. |
Returns:
matching SLADefinition objects in implementation defined order.
- Type
- Array.<SLADefinition>
Examples
Search for all slaDefinitions with reference 'ref' globally
var array = cfg.slaDefinition('ref');
Update or create a new SLADefinition
cfg.slaDefinition('ref', function(slaDefinition) { ... });
slaDefinitions(reference, instances, callback) → {Array.<SLADefinition>}
Searches for all SLADefinitions with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackSLADefinition | invoked for all instances. |
Returns:
all processed SLADefinition objects in implementation defined order.
- Type
- Array.<SLADefinition>
Example
Create SLADefinition instances for every element of the instances array
var slaDefinitions = cfg.slaDefinitions('ref', ['node1', 'node2'], function(slaDefinition, instance) { ... });
viewLogPool(parent, reference, callbackopt) → {Array.<ViewLogAnalyzer>}
Searches for all ViewLogAnalyzers with the given reference within the given parent (if any). The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created. If the parent has been ommitted and the search yields no results and exception will be thrown.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
parent |
APMLogAnalyzer | FilterLogAnalyzer | ViewLogAnalyzer | WebTimingLogAnalyzer | FormLogAnalyzer | the APMLogAnalyzer|FilterLogAnalyzer|ViewLogAnalyzer|WebTimingLogAnalyzer|FormLogAnalyzer inside which the viewLogPool must be. |
|
reference |
String | identifies objects. |
|
callback |
selectorCallbackViewLogAnalyzer |
<optional> |
invoked for all matches of the search. |
Returns:
matching ViewLogAnalyzer objects in implementation defined order.
- Type
- Array.<ViewLogAnalyzer>
Examples
Search for all viewLogPools with reference 'ref' inside parent
var array = cfg.viewLogPool(parent, 'ref');
Search for all viewLogPools with reference 'ref' globally
var array = cfg.viewLogPool('ref');
Update or create a new ViewLogAnalyzer inside parent
cfg.viewLogPool(parent, 'ref', function(viewLogPool) { ... });
viewLogPools(parent, reference, instances, callback) → {Array.<ViewLogAnalyzer>}
Searches for all ViewLogAnalyzers with the given reference within the given parent (if any). The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance. If the parent has been ommitted but is required an exception will be thrown.
Parameters:
Name | Type | Description |
---|---|---|
parent |
APMLogAnalyzer | FilterLogAnalyzer | ViewLogAnalyzer | WebTimingLogAnalyzer | FormLogAnalyzer | the APMLogAnalyzer|FilterLogAnalyzer|ViewLogAnalyzer|WebTimingLogAnalyzer|FormLogAnalyzer inside which the viewLogPool must be. |
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackViewLogAnalyzer | invoked for all instances. |
Returns:
all processed ViewLogAnalyzer objects in implementation defined order.
- Type
- Array.<ViewLogAnalyzer>
Example
Create ViewLogAnalyzer instances for every element of the instances array
var viewLogPools = cfg.viewLogPools(parent, 'ref', ['node1', 'node2'], function(viewLogPool, instance) { ... });
webTimingLogPool(reference, callbackopt) → {Array.<WebTimingLogAnalyzer>}
Searches for all WebTimingLogAnalyzers with the given reference. The callback will be invoked for every found object. If there are no objects matching the reference and the reference is also from the current module a new object will be created.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reference |
String | identifies objects. |
|
callback |
selectorCallbackWebTimingLogAnalyzer |
<optional> |
invoked for all matches of the search. |
Returns:
matching WebTimingLogAnalyzer objects in implementation defined order.
- Type
- Array.<WebTimingLogAnalyzer>
Examples
Search for all webTimingLogPools with reference 'ref' globally
var array = cfg.webTimingLogPool('ref');
Update or create a new WebTimingLogAnalyzer
cfg.webTimingLogPool('ref', function(webTimingLogPool) { ... });
webTimingLogPools(reference, instances, callback) → {Array.<WebTimingLogAnalyzer>}
Searches for all WebTimingLogAnalyzers with the given reference. The array of instances is made unique and then objects found that don't match any of the given instances are deleted and missing objects are created. The callback will be invoked for every unique instance.
Parameters:
Name | Type | Description |
---|---|---|
reference |
String | the reference of the objects. |
instances |
Array.<(String|CISElement)> | the names of instances or instances of subclasses of CISElement. |
callback |
selectorInstancedCallbackWebTimingLogAnalyzer | invoked for all instances. |
Returns:
all processed WebTimingLogAnalyzer objects in implementation defined order.
- Type
- Array.<WebTimingLogAnalyzer>
Example
Create WebTimingLogAnalyzer instances for every element of the instances array
var webTimingLogPools = cfg.webTimingLogPools('ref', ['node1', 'node2'], function(webTimingLogPool, instance) { ... });