https://github.com/fabianfrz/opnsense_client_lib
Library to use the OPNsense API - written in Ruby
https://github.com/fabianfrz/opnsense_client_lib
client opnsense ruby
Last synced: about 1 year ago
JSON representation
Library to use the OPNsense API - written in Ruby
- Host: GitHub
- URL: https://github.com/fabianfrz/opnsense_client_lib
- Owner: fabianfrz
- License: bsd-2-clause
- Created: 2016-02-03T15:54:41.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-04-18T13:22:53.000Z (about 10 years ago)
- Last Synced: 2025-04-04T08:45:35.497Z (about 1 year ago)
- Topics: client, opnsense, ruby
- Language: Ruby
- Homepage:
- Size: 9.77 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OPNsense client library
This is an implementation of a library which allows you to communicate
with your OPNsense appliance.
How can this library be used?
-----------------------------
``` ruby
require_relative 'relative/path/to/this/library/requireall'
# OPNsense requires credentials
cred = OPNsense::APICredentials.new(api_key, api_secret, api_url, certificate)
# now you can create a request object
OPNsense::Request.new(cred)
# everything is ready - you can access the api now
OPNsense::FirmwareUpdate.upgrade!
```