Solarwinds Orion nodejs module
Usage:
var orion = require("solar-orionjs")({
server: "127.0.0.1",
port: 17778,
auth: {
username:"admin",
password:""
}
});
- Orion()
Class definition
- query(query, callback)
Performs a SWQL query
- update(update, swisUri, callback)
Update Orion object
- read(swisUri, callback)
Read Orion object
- create(data, object, callback)
Create Orion object
- invoke(verb, data, callback)
Performs an Orion verb invoke
- remove(swisUri, callback)
remove Orion object
- removeBulk(swisUris, callback)
Bulk remove Orion objects
- getOptions() ⇒
object Get options
- setOptions(options)
Set options
Class definition
Kind: global function
Example
var orion = require("solar-orionjs")({
server: "127.0.0.1",
port: 17778,
auth: {
username: "admin",
password: "password"
}
});Performs a SWQL query
Kind: global function
| Param | Type | Description |
|---|---|---|
| query | Object |
JSON Query object in form of {query:""} |
| callback | function |
callback function on return |
Example
orion.query({query:"SELECT NodeID, URI from Orion.Nodes"},
function (result){
console.log(result);
});
// Also with the parameter syntax:
orion.query({query:"SELECT NodeID, URI from Orion.Nodes WHERE NodeID = @id", param:{id:5}},
function (result){
console.log(result);
}); Update Orion object
Kind: global function
| Param | Type | Description |
|---|---|---|
| update | Object |
JSON object of update |
| swisUri | String |
the swis URI of the object to be updated |
| callback | function |
callback function on return |
Example
orion.update({Caption:"new node caption"},
"swis://hostname/Orion/Orion.Nodes/NodeID=1",
function (result){
console.log(result);
});Read Orion object
Kind: global function
| Param | Type | Description |
|---|---|---|
| swisUri | String |
the swis URI of the object to be read |
| callback | function |
callback function on return |
Example
orion.read("swis://hostname/Orion/Orion.Nodes/NodeID=1",
function (result){
console.log(result);
});Create Orion object
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | Object |
JSON object of update |
| object | String |
the object to be created |
| callback | function |
callback function on return |
Performs an Orion verb invoke
Kind: global function
| Param | Type | Description |
|---|---|---|
| verb | String |
Verb to invoke, eg Orion.Nodes/Unmanage |
| data | Array |
An array of the data to be passed to Verb |
| callback | function |
callback function on return |
Example
var now = new Date();
var later = new Date();
later.setHours(later.getHours() + 3);
orion.invoke("Orion.Nodes/Unmanage", [ "N:1", now, later, false ],
function (result){
console.log(result);
});remove Orion object
Kind: global function
| Param | Type | Description |
|---|---|---|
| swisUri | String |
the swisURI of the object to be removed |
| callback | function |
callback function on return |
Bulk remove Orion objects
Kind: global function
| Param | Type | Description |
|---|---|---|
| swisUris | Array.<String> |
an array of swisUris representing objects to be deleted |
| callback | function |
callback function on return |
Get options
Kind: global function
Returns: object - options - currently set options
Set options
Kind: global function
| Param | Type | Description |
|---|---|---|
| options | object |
JSON object of options to set |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent