OPNSense

Manage OPNsense Firewall. For more information see OPNsense documentation. OPNsense is an open source, easy-to-use and easy-to-build HardenedBSD based firewall and routing platform.

Network Security · OPNSense

Configuration parameters

  • url — Server URL (e.g. https://opnsense.mydomain.ltd) (required)
  • apikey — API Key (required)
  • apisecret — API Secret (required)
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings

Commands (32)

  • opnsense-alias-add

    Create new alias.

  • opnsense-alias-apply

    Apply configuration.

  • opnsense-alias-del

    Delete alias with uuid.

  • opnsense-alias-get

    Get alias details.

  • opnsense-alias-get-uuid

    Get alias UUID.

  • opnsense-alias-list

    Get aliases list.

  • opnsense-alias-mod

    Modify an existing alias.

  • opnsense-alias-mod-additem

    Add item into existing alias.

  • opnsense-alias-mod-delitem

    Del item into existing alias.

  • opnsense-category-add

    Create new category.

  • opnsense-category-del

    Delete category with uuid.

  • opnsense-category-get

    Get category details.

  • opnsense-category-list

    Get categories list.

  • opnsense-category-mod

    Modify an axisting category.

  • opnsense-device-reboot

    Reboot the device.

  • opnsense-firmware-info

    Get firmware info.

  • opnsense-firmware-status

    Get firmware status.

  • opnsense-firmware-update

    Do firmware update.

  • opnsense-firmware-upgrade

    Do firmware upgrade.

  • opnsense-firmware-upgradestatus

    Get firmware upgrade status.

  • opnsense-interfaces-list

    Get interfaces list.

  • opnsense-logs-search

    Search into firewall logs.

  • opnsense-rule-add

    Create a new rule.

  • opnsense-rule-apply

    Apply rules current configuration.

  • opnsense-rule-del

    Delete an existing rule.

  • opnsense-rule-get

    Get rule details.

  • opnsense-rule-list

    Get rules list.

  • opnsense-rule-mod

    Modify an existing rule.

  • opnsense-rule-revert

    Revert config to given savepoint.

  • opnsense-rule-savepoint

    Save rules current configuration.

  • opnsense-state-del

    Delete state with ID.

  • opnsense-states-search

    Query states.