pfsense

package
v0.0.0-...-8f1a291 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 27, 2022 License: MIT Imports: 12 Imported by: 0

README

Pukcab module: PFSense

Module name: pfsense

This module enables you toback up the configuration from a running PFSense router.

Requirements

  • The backup host must be able to access the PFSense devices' web UI.
  • The PFSense device must be configured to use TLS. Plain-Text configurations are not supported.

Configuration

Key Type Description
host_address string The host address of the PFSense device. Do not include a protocol or path.
username string The username to log in as.
password string The password for that user.
allow_untrusted_certificates boolean (Optional) If true then TLS errors are ignored.
encrypt_password string (Optional) If included the backup will be encrypted with this password.

Example

{
    "name": "pfsense",
    "config": {
        "host_address": "192.168.1.1",
        "username": "exampleUser",
        "password": "examplePassword",
        "encrypt_password": "not_a_good_password",
    }
}

Documentation

Index

Constants

View Source 
const Name = "pfsense"

Variables

This section is empty.

Functions

This section is empty.

Types

type PFSenseConfig 

type PFSenseConfig struct {
	HostAddress                string `json:"host_address"`
	Username                   string `json:"username"`
	Password                   string `json:"password"`
	AllowUntrustedCertificates bool   `json:"allow_untrusted_certificates"`
	EncryptPassword            string `json:"encrypt_password"`
}

type PFSenseModule 

type PFSenseModule struct{}

PFSenseModule the PFSense pukcab module

func (PFSenseModule) Name 

func (m PFSenseModule) Name() string

func (PFSenseModule) Run 

func (m PFSenseModule) Run(c interface{}) ([]pukcab.File, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.