https://github.com/lirantal/operations-orchestration-api
HPE's Operations Orchestration client API module for NodeJS
https://github.com/lirantal/operations-orchestration-api
hacktoberfest hacktoberfest-accepted hpe operations-orchestration orchestration
Last synced: 6 months ago
JSON representation
HPE's Operations Orchestration client API module for NodeJS
- Host: GitHub
- URL: https://github.com/lirantal/operations-orchestration-api
- Owner: lirantal
- License: mit
- Created: 2015-11-26T21:19:40.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-10-27T11:03:51.000Z (almost 2 years ago)
- Last Synced: 2025-04-12T22:48:56.661Z (6 months ago)
- Topics: hacktoberfest, hacktoberfest-accepted, hpe, operations-orchestration, orchestration
- Language: JavaScript
- Homepage:
- Size: 172 KB
- Stars: 5
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.org/package/operations-orchestration-api)
[](https://www.npmjs.org/package/operations-orchestration-api)
[](https://www.npmjs.org/package/operations-orchestration-api)
[](https://snyk.io/test/github/lirantal/operations-orchestration-api?targetFile=package.json)
[](https://travis-ci.org/lirantal/operations-orchestration-api)
[](https://coveralls.io/github/lirantal/operations-orchestration-api?branch=master)
[](https://github.com/nodejs/security-wg/blob/master/processes/responsible_disclosure_template.md)
[](https://snyk.io/advisor/npm-package/operations-orchestration-api)
# operations-orchestration-api
HPE's Operations Orchestration client API module for NodeJS
# Install
Install the API module as a depdency in your project so you can easily use it to query Operations Orchestration REST API
```javascript
npm install operations-orchestration-api --save
```
# Setup as easy as 1-2-3
1. Require the module
```javascript
var OO = require('operations-orchestration-api');
```
2. Create an options object with the `username`, and `password` that are allowed to query the REST API, as well as the `baseUrl` property for the full URL where the OO REST API is available
```javascript
var options = {
username: 'admin',
password: 'admin',
baseUrl: 'http://localhost:8050/oo/rest/v1'
};
```
3. Initialize the OO object with the options
```javascript
OO.setClient(options);
```
# Usage
After the OO module is initialized with the correct options, we can begin querying information.
## Statistics
The following example will query for the statistics, and you can inspect the `err` or `data` object for the returned result.
```javascript
try {
const data = await OO.dashboard.statistics(); // Throws err if Promise got rejected
console.log(data);
} catch (err) {
console.log(err);
}
```
## Configuration
### Getting all configuration items in OO
The `data` object will contain an array of objects with all the config-items set in OO
```javascript
try {
const data = await OO.config.getAllItems(); // Throws err if Promise got rejected
console.log(data);
} catch (err) {
console.log(err);
}
```
# Versions and Node.js support
Version 2.x has been updated to employ Promises functionality based on async/await, and as such requires a current Node.js release.
Version compatibility matrix for this library:
| OO API Library version | Node.js support | Comments
| ---------------------- | --------------- | --------
| v1.x | Node.js 4.x, 5.x, 6.x, 7.x | based on callbacks, for example: `OO.dashboard.statistics(function(err, data) { console.log(data); });`
| v2.x | Node.js >= 7.8.x |
# References
1. [Operations Orchestration product resources on HPE Live Network](https://hpln.hp.com/group/operations-orchestration)
2. [Operations Orchestration API Guide](https://hpln.hpe.com/node/21991)
# Author
Liran Tal