Skip to main content

Knocker - a cli utility for agents

The Knocker utility is a command-line tool for managing various backends with ease. It provides commands for enabling, disabling, installing, uninstalling, and performing health checks for supported backends.

Usage

/opt/knocknoc-agent/knocker/knocker <command> [backend] [options...]

Commands

  • help: Show the help message or detailed help for a specific backend. 
    knocker help <backend>
  • list: List all available backends. 
    knocker list
  • status: Check the status of the specified backend. 
    knocker status <backend>
  • enable: Enable the specified backend. 
    knocker enable <backend>
  • disable: Disable the specified backend. 
    knocker disable <backend>
  • install: Install the specified backend. 
    knocker install <backend>
  • uninstall: Uninstall the specified backend. 
    knocker uninstall <backend>
  • check: Perform a health or dependency check for the specified backend. 
    knocker check <backend>
  • test-grant: Test granting permissions for the backend. 
    knocker test-grant <backend> <params>
  • test-revoke: Test revoking permissions for the backend. 
    knocker test-revoke <backend> <params>

Available Backends

The following backends are currently supported:

  • aws: Manage AWS integrations.
  • haproxy: Manage HAProxy configurations.
  • ipset: Manage IPSet configurations.
  • junos: Manage Junos SRX dynamic address updates.
  • plesk: Manage Plesk access restrictions.
  • proxmox: Manage Proxmox VM firewalls.

Examples

# Show help for a specific backend
knocker help aws

# List all available backends
knocker list

# Check the status of the haproxy backend
knocker status haproxy

# Enable the ipset backend
knocker enable ipset

# Perform a health check for the junos backend
knocker check junos

Notes

For root users, ensure that the knocker script is accessible in your PATH. Consider creating a symlink or wrapper script in /usr/local/sbin if needed.

Back to top