Module: OPNsenseAPI::Core

Included in:

CaptivePortal, CaptivePortal::Access, CaptivePortal::Service, CaptivePortal::Session, CaptivePortal::Settings, CaptivePortal::Voucher, Core, Core::Firmware, Core::Menu, Core::System, Cron, Cron::Service, Cron::Settings, Diagnostics, Diagnostics::Activity, Diagnostics::DNS, Diagnostics::DNSDiagnostics, Diagnostics::Firewall, Diagnostics::Interface, Diagnostics::LVTemplate, Diagnostics::Netflow, Diagnostics::NetworkInsight, Diagnostics::PacketCapture, Diagnostics::System, Diagnostics::SystemHealth, Diagnostics::Traffic, Firewall, Firewall::Alias, Firewall::AliasUtil, Firewall::Category, Firewall::FilterUtil, IDS, IDS::Service, IDS::Settings, IPSec, IPSec::KeyPairs, IPSec::Leases, IPSec::LegacySubsystem, IPSec::PreSharedKeys, IPSec::SAD, IPSec::SPD, IPSec::Service, IPSec::Sessions, IPSec::Tunnel, Interfaces, Interfaces::Base, Monit, Monit::Service, Monit::Settings, Monit::Status, OpenVPN, OpenVPN::Export, Proxy, Proxy::Service, Proxy::Settings, Proxy::Template, Routes, Routes::Gateway, Routes::Routes, Syslog, Syslog::Service, Syslog::Settings, TrafficShaping, TrafficShaping::Service, TrafficShaping::Settings, Unbound, Unbound::Diagnostics, Unbound::Service, Unbound::Settings

Defined in:

lib/opnsense_api/core.rb,
lib/opnsense_api/core/ids.rb,
lib/opnsense_api/core/core.rb,
lib/opnsense_api/core/cron.rb,
lib/opnsense_api/core/ipsec.rb,
lib/opnsense_api/core/monit.rb,
lib/opnsense_api/core/proxy.rb,
lib/opnsense_api/core/routes.rb,
lib/opnsense_api/core/syslog.rb,
lib/opnsense_api/core/unbound.rb,
lib/opnsense_api/core/firewall.rb,
lib/opnsense_api/core/open_vpn.rb,
lib/opnsense_api/core/core/menu.rb,
lib/opnsense_api/core/ipsec/sad.rb,
lib/opnsense_api/core/ipsec/spd.rb,
lib/opnsense_api/core/interfaces.rb,
lib/opnsense_api/core/core/system.rb,
lib/opnsense_api/core/diagnostics.rb,
lib/opnsense_api/core/ids/service.rb,
lib/opnsense_api/core/cron/service.rb,
lib/opnsense_api/core/ids/settings.rb,
lib/opnsense_api/core/ipsec/leases.rb,
lib/opnsense_api/core/ipsec/tunnel.rb,
lib/opnsense_api/core/monit/status.rb,
lib/opnsense_api/core/core/firmware.rb,
lib/opnsense_api/core/cron/settings.rb,
lib/opnsense_api/core/ipsec/service.rb,
lib/opnsense_api/core/monit/service.rb,
lib/opnsense_api/core/proxy/service.rb,
lib/opnsense_api/core/routes/routes.rb,
lib/opnsense_api/core/captive_portal.rb,
lib/opnsense_api/core/firewall/alias.rb,
lib/opnsense_api/core/ipsec/sessions.rb,
lib/opnsense_api/core/monit/settings.rb,
lib/opnsense_api/core/proxy/settings.rb,
lib/opnsense_api/core/proxy/template.rb,
lib/opnsense_api/core/routes/gateway.rb,
lib/opnsense_api/core/syslog/service.rb,
lib/opnsense_api/core/diagnostics/dns.rb,
lib/opnsense_api/core/interfaces/base.rb,
lib/opnsense_api/core/ipsec/key_pairs.rb,
lib/opnsense_api/core/open_vpn/export.rb,
lib/opnsense_api/core/syslog/settings.rb,
lib/opnsense_api/core/traffic_shaping.rb,
lib/opnsense_api/core/unbound/service.rb,
lib/opnsense_api/core/unbound/settings.rb,
lib/opnsense_api/core/firewall/category.rb,
lib/opnsense_api/core/diagnostics/system.rb,
lib/opnsense_api/core/diagnostics/netflow.rb,
lib/opnsense_api/core/diagnostics/traffic.rb,
lib/opnsense_api/core/firewall/alias_util.rb,
lib/opnsense_api/core/unbound/diagnostics.rb,
lib/opnsense_api/core/diagnostics/activity.rb,
lib/opnsense_api/core/diagnostics/firewall.rb,
lib/opnsense_api/core/firewall/filter_util.rb,
lib/opnsense_api/core/captive_portal/access.rb,
lib/opnsense_api/core/diagnostics/interface.rb,
lib/opnsense_api/core/ipsec/pre_shared_keys.rb,
lib/opnsense_api/core/captive_portal/service.rb,
lib/opnsense_api/core/captive_portal/session.rb,
lib/opnsense_api/core/captive_portal/voucher.rb,
lib/opnsense_api/core/ipsec/legacy_subsystem.rb,
lib/opnsense_api/core/captive_portal/settings.rb,
lib/opnsense_api/core/diagnostics/lv_template.rb,
lib/opnsense_api/core/interfaces/vip_settings.rb,
lib/opnsense_api/core/traffic_shaping/service.rb,
lib/opnsense_api/core/interfaces/vlan_settings.rb,
lib/opnsense_api/core/traffic_shaping/settings.rb,
lib/opnsense_api/core/diagnostics/system_health.rb,
lib/opnsense_api/core/interfaces/vxlan_settings.rb,
lib/opnsense_api/core/diagnostics/packet_capture.rb,
lib/opnsense_api/core/diagnostics/dns_diagnostics.rb,
lib/opnsense_api/core/diagnostics/network_insight.rb,
lib/opnsense_api/core/interfaces/loopback_settings.rb

Overview

See Also:

• https://docs.opnsense.org/development/api.html#core-api

Defined Under Namespace

Classes: CaptivePortal, Core, Cron, Diagnostics, Firewall, IDS, IPSec, Interfaces, Monit, OpenVPN, Proxy, Routes, Syslog, TrafficShaping, Unbound

Instance Method Summary

• #initialize(client) ⇒ Object

Instance Method Details

#initialize(client) ⇒ Object

# File 'lib/opnsense_api/core.rb', line 38

def initialize(client)
  @client = client
end