https://github.com/robincher/node-f5-icontrol-client
🚥 F5 iControl Rest API Simplified Node.js Client
https://github.com/robincher/node-f5-icontrol-client
f5 icontrol nodejs npm-package rest-api up-for-grabs welcome-pr
Last synced: 6 months ago
JSON representation
🚥 F5 iControl Rest API Simplified Node.js Client
- Host: GitHub
- URL: https://github.com/robincher/node-f5-icontrol-client
- Owner: robincher
- License: gpl-3.0
- Created: 2018-03-17T13:03:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-05T06:23:11.000Z (over 1 year ago)
- Last Synced: 2025-02-10T15:14:29.931Z (8 months ago)
- Topics: f5, icontrol, nodejs, npm-package, rest-api, up-for-grabs, welcome-pr
- Language: JavaScript
- Homepage:
- Size: 458 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Node.js library for F5 iControl API
[](https://app.codacy.com/app/robincher/node-f5-icontrol-client?utm_source=github.com&utm_medium=referral&utm_content=robincher/node-f5-icontrol-client&utm_campaign=badger)
[](https://app.codeship.com/projects/281946)
[](https://snyk.io/test/github/robincher/node-f5-icontrol-client?targetFile=package.json)
[](https://coveralls.io/github/robincher/node-f5-icontrol-client?branch=master)
[](http://makeapullrequest.com)
A helper client to interact with F5 iControl APIs.
See F5 iControl REST API documentation for more details
https://devcentral.f5.com/d/icontrol-rest-user-guide
## Getting Started
### Create iControl Client Instance
```
const iControl = require('node-icontrol-client').IControlUtil;
let iControlClient = new iControl({
host: '127.0.0.1',
proto: 'https',
port: 443,
token: 'token value', //Authorization Token for Basic Auth
output: false //Set to true if you want to see output
});
iControlClient.list('/mgmt/tm/net/bwc/policy').then(function(res) {
//Do Something
})
.catch((err) => {
//Do Something
})
```
- host : F5's hostname
- proto : (Optional) Protocol, either https or http. It will be default to https if not specify
- port: (Optional) TCP/IP port. Default to 443 if not indicated
- ca : CA file content, required if strict mode is set on.
- token: F5 generated basic token. Please refer [here](https://devcentral.f5.com/wiki/iControl.Authentication_with_the_F5_REST_API.ashx) on how you can generate a basic auth token.
- output : Set it true to print out console logs
### Local Live Testing
Refer to the examples shared within repository.
Please ensure you have access to a test or development F5 Proxy. You can specify your own testing environment
A sample.json has been included to help you kick start the testing
Running the example file
```
cd example/
node filename.js
```
### Unit Testing
Run the following to start unit test
```
npm test
```
### Test Coverage
Run the following to check out the code coverage
```
npm run testCoverage
```
### License
Release under [GNU GENERAL PUBLIC LICENSE](https://github.com/robincher/node-f5-icontrol-client/blob/master/LICENSE)
## References
+ [Node iControl Package](https://github.com/thwi/node-icontrol)
+ [F5 iControl REST API](https://devcentral.f5.com/d/icontrol-rest-user-guide)
+ [Code Coverage with Codeship CI](https://cdaringe.com/node-js-project-coverage-with-coveralls-io/)