Netgate Documentation

https://docs.netgate.com/
Admin
Official documentation for Netgate's network security products, including pfSense and TNSR software,...
Tokens:5,573,706
Snippets:35,392
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### CentOS Default Login Prompt

Source: https://docs.netgate.com/platforms/rcc-ve-8860-1u/getting-started

Illustrates the initial login prompt displayed on the CentOS Linux console. Users should enter 'root' as the username to proceed.

```Shell
CentOS Linux (Core)
Kernal 3.10.0-123.e17.x86_64 on an x86_64

Localhost login:

```

--------------------------------

### Example Interactive Program Startup Notice

Source: https://docs.netgate.com/tnsr/en/24.02/licensing/gplv2-libgit2

Illustrates a short notice that an interactive program should output when it starts, informing users about copyright, warranty, and redistribution conditions, and guiding them to further details.

```program-output
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### Example QAT Driver Output from lsmod

Source: https://docs.netgate.com/tnsr/en/20.08/setup/setup-qat

An example of the expected output when verifying QAT drivers, showing various QAT-related modules loaded.

```text
qat_dh895xccvf         13281  0
qat_dh895xcc           13510  0
intel_qat             141755  2 qat_dh895xccvf,qat_dh895xcc
dh_generic             13286  1 intel_qat
rsa_generic            18819  1 intel_qat
authenc                17776  1 intel_qat
```

--------------------------------

### CentOS Login Prompt

Source: https://docs.netgate.com/platforms/rcc-dff-2220/getting-started

This snippet shows the initial login prompt displayed on the CentOS console, including system and kernel version information, where the user is expected to enter their username.

```Shell
CentOS Linux (Core)
Kernal 3.10.0-123.e17.x86_64 on an x86_64

Localhost login:
```

--------------------------------

### CentOS Console Login Prompt

Source: https://docs.netgate.com/platforms/rcc-ve-4860/getting-started

This snippet displays the initial login prompt observed on the console for a CentOS Linux system. It provides system information such as the kernel version and architecture before prompting the user for a username.

```Shell
CentOS Linux (Core)
Kernal 3.10.0-123.e17.x86_64 on an x86_64

Localhost login:
```

--------------------------------

### CentOS Linux Console Login Prompt

Source: https://docs.netgate.com/platforms/rcc-ve-2440/getting-started

This snippet shows the initial console login prompt for a CentOS Linux (Core) system, indicating the kernel version and architecture. Users are prompted to enter their username, typically 'root' for initial access.

```Console
CentOS Linux (Core)
Kernal 3.10.0-123.e17.x86_64 on an x86_64

Localhost login:

```

--------------------------------

### CentOS Linux Console Password Prompt

Source: https://docs.netgate.com/platforms/rcc-ve-2440/getting-started

Following the username entry, this snippet displays the password prompt on the CentOS Linux console. Users are expected to enter the default password, 'password', to gain root access.

```Console
Password:

```

--------------------------------

### CentOS Login Prompt on Netgate C2758

Source: https://docs.netgate.com/platforms/c2758-with-centos/getting-started

This console output displays the initial login prompt for a CentOS Linux system running on the Netgate C2758, showing system details like the kernel version and architecture. Users are prompted to enter their username.

```Shell
CentOS Linux (Core)
Kernal 3.10.0-123.e17.x86_64 on an x86_64

Localhost login:
```

--------------------------------

### GNU GPL Interactive Program Startup Notice

Source: https://docs.netgate.com/tnsr/en/19.12/licensing/gplv2

Example of a short notice to be displayed when an interactive program starts, informing users about the software's license, warranty status, and how to get more details.

```Text
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### GNU GPL: Interactive Program Startup Notice

Source: https://docs.netgate.com/tnsr/en/24.10/licensing/gplv2-libgit2

This snippet shows an example of a short notice that an interactive program licensed under the GNU GPL should output when it starts. It informs users about the program's copyright, lack of warranty, and conditions for redistribution, suggesting commands to view full license details.

```APIDOC
Gnomovision version 69, Copyright (C) year name of author
    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type `show c' for details.
```

--------------------------------

### Interactive Program GPL Startup Notice

Source: https://docs.netgate.com/pfsense/en/latest/_downloads/7a77de17677286446b25e3cfd8648404/libgpg-error_GPLv2

This snippet shows an example of a short notice that an interactive program should output when it starts, informing users about its GPL status, lack of warranty, and redistribution conditions. It suggests hypothetical commands for users to get more details.

```Text
Gnomovision version 69, Copyright (C) year  name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### Example TNSR Dataplane Crypto Initialization Logs

Source: https://docs.netgate.com/tnsr/en/23.06/recipes/tnsr-remote-office/setup-tasks

Provides an example of log messages that may appear during the initialization of the crypto hardware device (QAT) on the TNSR dataplane. These messages are typically informational and can be ignored.

```Log
[  836.798096] c3xxxvf 0000:01:01.4: enabling device (0000 -> 0002)
[  836.804235] DMAR: 64bit 0000:01:01.4 uses identity mapping
[  836.839343] c3xxxvf 0000:01:01.0: Failed to register crypto algs
[  836.859227] c3xxxvf: probe of 0000:01:01.0 failed with error -14
[  836.865313] c3xxxvf 0000:01:01.1: enabling device (0000 -> 0002)
[  836.871718] DMAR: 64bit 0000:01:01.1 uses identity mapping
[  836.877853] c3xxxvf 0000:01:01.4: Failed to register crypto algs
[  836.897244] c3xxxvf: probe of 0000:01:01.4 failed with error -14
```

--------------------------------

### Modify Debian Installer Kernel Command Line

Source: https://docs.netgate.com/platforms/rcc-ve-8860/debian

Before starting the Debian installer, modify the kernel boot parameters to enable console output on ttyS1 for RCC-VE devices. This ensures installation progress is visible via the serial console.

```shell
/install.amd/vmlinuz vga=788 initrd=/install.amd/initrd.gz -- quiet console=ttyS1,115200n8
```

--------------------------------

### Example VPP startup.conf DPDK configuration

Source: https://docs.netgate.com/tnsr/en/22.02/setup/setup-qat

Shows a sample 'dpdk' block within '/etc/vpp/startup.conf', detailing the 'uio-driver' and 'dev' entries required for QAT and interface binding.

```conf
dpdk {
    uio-driver igb_uio
    dev 0000:04:01.0
    dev 0000:05:00.1
    dev 0000:03:00.0
    dev 0000:03:00.1
}
```

--------------------------------

### Example Output: Loaded QAT Drivers

Source: https://docs.netgate.com/tnsr/en/20.02/setup/setup-qat

This snippet provides an example of the expected output when QAT drivers are successfully loaded, showing various QAT-related kernel modules and their dependencies.

```text
qat_dh895xccvf         13281  0
qap_dh895xcc           13510  0
intel_qat             141755  2 qat_dh895xccvf,qat_dh895xcc
dh_generic             13286  1 intel_qat
rsa_generic            18819  1 intel_qat
authenc                17776  1 intel_qat
```

--------------------------------

### CentOS Default Password Prompt

Source: https://docs.netgate.com/platforms/rcc-ve-8860-1u/getting-started

Shows the password prompt after a username has been entered. The default password for root access is 'password'.

```Shell
Password:

```

--------------------------------

### Example Output: Loaded QAT Drivers

Source: https://docs.netgate.com/tnsr/en/24.02/setup/setup-qat

This output demonstrates what a successful `lsmod | grep qat` command should look like, indicating that the QAT drivers are loaded and active.

```text
qat_dh895xccvf         13281  0
qat_dh895xcc           13510  0
intel_qat             141755  2 qat_dh895xccvf,qat_dh895xcc
dh_generic             13286  1 intel_qat
rsa_generic            18819  1 intel_qat
authenc                17776  1 intel_qat
```

--------------------------------

### CentOS Password Prompt

Source: https://docs.netgate.com/platforms/rcc-dff-2220/getting-started

This snippet displays the password prompt that appears after a username has been entered on the CentOS console, allowing the user to input their password for authentication.

```Shell
Password:
```

--------------------------------

### Example VPP DPDK Configuration for QAT

Source: https://docs.netgate.com/tnsr/en/24.10/setup/setup-qat

Shows /etc/vpp/startup.conf snippet for binding igb_uio driver and specifying PCI IDs for TNSR interfaces and QAT VFs.

```text
dpdk {
    uio-driver igb_uio
    dev 0000:04:01.0
    dev 0000:05:00.1
    dev 0000:03:00.0
    dev 0000:03:00.1
}
```

--------------------------------

### pfSense Installation: Console Terminal Type Selection

Source: https://docs.netgate.com/platforms/rcc-ve-4860/pfsense

During the pfSense installation, users are prompted to select a terminal type. This snippet displays the available options, such as ANSI, VT100, and xterm, which are crucial for proper console display and interaction during the setup process.

```Console
Please choose the appropriate terminal type for your system.
Common console types are:
   ansi     Standard ANSI terminal
   vt100    VT100 or compatible terminal
   xterm    xterm terminal emulator (or compatible)
   cons25w  cons25w terminal
```

--------------------------------

### Interactive Program Startup Notice Example

Source: https://docs.netgate.com/pfsense/en/latest/licensing/licensetext/smartmontools_GPLv2%2B

Example of a short notice to be displayed by an interactive program when it starts, informing users about the software's version, copyright, warranty status, and redistribution terms, with prompts for more details.

```text
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### Configure Terminal Settings for OpenBSD Boot

Source: https://docs.netgate.com/platforms/rcc-ve-2440/openbsd

These commands are entered at the 'boot>' prompt to configure the serial console settings (baud rate and TTY device) before the OpenBSD installer starts. This ensures proper display and interaction during the installation process, preventing issues with terminal output.

```Shell
stty com1 115200
set tty com1
boot
```

--------------------------------

### Interactive Program Startup Notice Example

Source: https://docs.netgate.com/pfsense/en/latest/_downloads/97784dc079768a81b972c82dc65acd3f/dmidecode_GPLv2

This example demonstrates a short notice that interactive programs should output when they start in interactive mode. It informs users about the software's copyright, lack of warranty, and where to find details about redistribution conditions.

```Text
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### CentOS Console Password Prompt

Source: https://docs.netgate.com/platforms/rcc-ve-4860/getting-started

This snippet shows the password prompt that appears on the console after a username has been entered at the login screen. Users are expected to input their password to gain root access to the system.

```Shell
Password:
```

--------------------------------

### Example Interactive Program Startup Notice for GPL Software

Source: https://docs.netgate.com/tnsr/en/20.02/licensing/gplv2

This example demonstrates a short notice to be displayed by interactive programs when they start, informing users about the software's copyright, lack of warranty, and redistribution conditions. It suggests placeholder commands (`show w`, `show c`) for users to access more detailed license information.

```Text
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### Example QAT PF and VF device binding on C3XXX

Source: https://docs.netgate.com/tnsr/en/23.06/setup/setup-qat

This output demonstrates how QAT physical and virtual functions are bound to their respective drivers (e.g., `c3xxx`, `igb_uio`, `c3xxxvf`) on a C3XXX system, indicating proper setup.

```text
0000:01:00.0   0  8086:19e2   5.0 GT/s x16  c3xxx
0000:01:01.0   0  8086:19e3   unknown       igb_uio
0000:01:01.1   0  8086:19e3   unknown       c3xxxvf
```

--------------------------------

### Interactive Program Startup Notice Example

Source: https://docs.netgate.com/tnsr/en/latest/licensing/gplv2-libgit2

Example of a short notice to be displayed by interactive programs upon startup, informing users about the program's license, warranty status, and how to access more details.

```Text
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### Example: Start RESTCONF Server with TLS

Source: https://docs.netgate.com/tnsr/en/23.06/restconf/index

This example demonstrates configuring the RESTCONF service to run in the 'host' namespace, listening on IP 198.51.100.2, port 443, with TLS encryption enabled. This is a common setup for secure production environments.

```TNSR CLI
tnsr(config-restconf)# server host 198.51.100.2 443 true
```

--------------------------------

### GNU GPL Interactive Program Startup Notice Example

Source: https://docs.netgate.com/pfsense/en/latest/_downloads/3868577c4b80a8c747bce44fd8856b55/readline_GPLv3

Example of a short notice to be displayed by interactive programs upon startup, informing users about the warranty status and redistribution conditions under the GNU General Public License.

```Text
<program>  Copyright (C) <year>  <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### CentOS Password Prompt on Netgate C2758

Source: https://docs.netgate.com/platforms/c2758-with-centos/getting-started

Following the username entry, this console output shows the password prompt for a CentOS Linux system on the Netgate C2758. Users are expected to enter the default password 'password' to gain root access.

```Shell
Password:
```

--------------------------------

### Example Interactive Program Startup Notice

Source: https://docs.netgate.com/pfsense/en/latest/_downloads/5da18ceed2c0c99f84bff46c9dfde602/smartmontools_GPLv2%2B

A sample notice to be displayed by interactive programs when they start in interactive mode. This notice informs users about the software's version, copyright, warranty status, and conditions for redistribution, directing them to specific commands for more details.

```Text
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### Example igb_uio Driver Binding Output from vppctl

Source: https://docs.netgate.com/tnsr/en/20.08/setup/setup-qat

An example of the expected output from `vppctl` showing PCI devices bound to the `igb_uio` driver, including TNSR interfaces and the QAT VF.

```text
0000:03:00.0   0  8086:15ac   2.5 GT/s x1  igb_uio
0000:03:00.1   0  8086:15ac   2.5 GT/s x1  igb_uio
0000:04:01.0   0  8086:0443   unknown      igb_uio
0000:05:00.1   0  8086:1521   5.0 GT/s x4  igb_uio
```

--------------------------------

### Connect to Console with GNU Screen

Source: https://docs.netgate.com/pfsense/en/latest/solutions/xg-7100/connect-to-console

Connects to a serial console using GNU screen. The first example shows basic connection with specified baud rate. The second example adds the -U flag to force UTF-8 character encoding, useful for resolving display issues.

```Shell
$ sudo screen <console-port> 115200
```

```Shell
$ sudo screen -U <console-port> 115200
```

--------------------------------

### Interactive Program GPL Startup Notice Example

Source: https://docs.netgate.com/tnsr/en/22.06/licensing/gplv2

This example demonstrates a concise notice to be displayed by an interactive program upon startup. It informs users about the program's GPL licensing, the absence of warranty, and provides instructions (e.g., `show w`, `show c`) for accessing more detailed information on warranty and redistribution conditions.

```Console Output
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### Example VPP DPDK configuration in startup.conf

Source: https://docs.netgate.com/tnsr/en/23.06/setup/setup-qat

This configuration block from `/etc/vpp/startup.conf` shows how to specify the UIO driver and bind specific PCI devices (including QAT VFs and network interfaces) to DPDK for VPP.

```text
dpdk {
    uio-driver igb_uio
    dev 0000:04:01.0
    dev 0000:05:00.1
    dev 0000:03:00.0
    dev 0000:03:00.1
}
```

--------------------------------

### Retrieve Specific ACL Rule (curl GET)

Source: https://docs.netgate.com/tnsr/en/21.07/recipes/restconf-pki-nacm/index

Demonstrates how to fetch a single ACL rule by its sequence number from a Netgate device using a `GET` request via `curl`. The example shows retrieving the default permit rule (sequence 5000) and its corresponding JSON output.

```bash
$ curl -f --cert ~/tnsr/tnsr-myuser.crt \
  --key ~/tnsr/tnsr-myuser.key \
  --cacert ~/tnsr/tnsr-selfca.crt \
  -X GET \
  https://tnsr.example.com/restconf/data/netgate-acl:acl-config/acl-table/acl-list=blockbadhosts/acl-rules/acl-rule=5000
```

```json
{
    "netgate-acl:acl-rule": [
      {
        "sequence": 5000,
        "acl-rule-description": "Default Permit",
        "action": "permit",
        "ip-version": "ipv4"
      }
    ]
  }
```

--------------------------------

### Retrieve Specific ACL Rule via cURL GET

Source: https://docs.netgate.com/tnsr/en/20.08/recipes/restconf-pki-nacm/index

Demonstrates how to fetch a single ACL rule by its sequence number from a specific ACL using a GET request via cURL. This example uses client certificates for authentication and shows the expected JSON output for a rule.

```Shell
$ curl --cert ~/tnsr/tnsr-myuser.crt \
  --key ~/tnsr/tnsr-myuser.key \
  --cacert ~/tnsr/tnsr-selfca.crt \
  -X GET \
  https://tnsr.example.com/restconf/data/netgate-acl:acl-config/acl-table/acl-list=blockbadhosts/acl-rules/acl-rule=5000
```

```JSON
{
    "netgate-acl:acl-rule": [
      {
        "sequence": 5000,
        "acl-rule-description": "Default Permit",
        "action": "permit",
        "ip-version": "ipv4"
      }
    ]
  }
```

--------------------------------

### Example Interactive Program Startup Message

Source: https://docs.netgate.com/pfsense/en/latest/_downloads/9b768bdba181d7fcabc16308d8ea36bf/standard_GPLv2

This snippet shows a sample startup message for an interactive program licensed under the GPL. It informs users about the program's version, copyright, lack of warranty, and conditions for redistribution, directing them to commands for more details.

```TEXT
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### GNU GPL Interactive Program Startup Notice

Source: https://docs.netgate.com/pfsense/en/latest/licensing/licensetext/lzo2_GPLv2

This snippet provides a sample notice to be displayed when an interactive program starts, informing users about the software's license, warranty status, and how to access more details about the GNU GPL terms.

```Text
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### Install or Load CP210x USB to UART Bridge Driver on Linux

Source: https://docs.netgate.com/pfsense/en/latest/solutions/netgate-8200/connect-to-console

Instructions and commands for installing or manually loading the Silicon Labs CP210x USB to UART Bridge driver module on Linux. This includes using `modprobe` for distribution-provided drivers and `insmod` for manually built modules.

```bash
sudo modprobe cp210x
```

```bash
insmod ./cp210x.ko
```

--------------------------------

### Example VPP startup.conf DPDK configuration

Source: https://docs.netgate.com/tnsr/en/latest/setup/setup-qat

This configuration snippet from `/etc/vpp/startup.conf` demonstrates how to configure DPDK within VPP, specifying the `igb_uio` driver and listing the PCI IDs of network interfaces and a QAT Virtual Function for DPDK binding.

```config
dpdk {
    uio-driver igb_uio
    dev 0000:04:01.0
    dev 0000:05:00.1
    dev 0000:03:00.0
    dev 0000:03:00.1
}
```

--------------------------------

### Default Netgate Web Interface Credentials

Source: https://docs.netgate.com/pfsense/en/latest/solutions/sg-1000/getting-started

The default username and password required for the first login to the Netgate appliance's web interface. These credentials should be changed immediately after the initial setup for security purposes.

```Credentials
Username: admin
Password: pfsense
```

--------------------------------

### Example QAT PF and VF Devices on C3XXX System

Source: https://docs.netgate.com/tnsr/en/24.02/setup/setup-qat

This example shows the `vppctl show pci all` output for a C3XXX system with QAT, demonstrating how both PF and VF devices are listed with their respective drivers, including `igb_uio`.

```text
0000:01:00.0   0  8086:19e2   5.0 GT/s x16  c3xxx
0000:01:01.0   0  8086:19e3   unknown       igb_uio
0000:01:01.1   0  8086:19e3   unknown       c3xxxvf
```

--------------------------------

### Interactive Program GPL Startup Notice

Source: https://docs.netgate.com/pfsense/en/latest/_downloads/ccf43f65882b8fc5afc9a4236d9c3b78/dbus_GPLv2

Example of a short notice to be displayed by interactive programs when they start in interactive mode, informing users about the GNU General Public License, the absence of warranty, and redistribution conditions. It suggests using commands like `show w` and `show c` for details.

```Text
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### Default Netgate Hostname and Domain

Source: https://docs.netgate.com/pfsense/en/latest/solutions/sg-1000/getting-started

The default hostname and domain name used for the Netgate appliance during initial setup. The hostname can be used to access the GUI after configuration, and the domain affects DHCP client assignments.

```System Configuration
Hostname: pfsense
Domain: localdomain
```

--------------------------------

### Example QAT Device and VF Listing from lspci

Source: https://docs.netgate.com/tnsr/en/20.08/setup/setup-qat

Illustrates the typical output from `lspci` showing the QAT co-processor and its associated virtual functions.

```text
04:00.0 Co-processor: Intel Corporation DH895XCC Series QAT
04:01.0 Co-processor: Intel Corporation DH895XCC Series QAT Virtual Function
04:01.1 Co-processor: Intel Corporation DH895XCC Series QAT Virtual Function
```

--------------------------------

### Wipe Drive and Start pfSense Plus Recovery Installer

Source: https://docs.netgate.com/pfsense/en/latest/solutions/netgate-2100/reinstall-pfsense

This command is an alternative to `run usbboot`, used if the standard installer fails or if a complete wipe of the target drive is desired before installation. It ensures the drive is erased prior to starting the pfSense Plus installation process.

```CLI
run usbrecovery
```

--------------------------------

### Example QAT Driver Listing

Source: https://docs.netgate.com/tnsr/en/19.12/setup/setup-qat

This is an example output from `lsmod | grep qat`, showing the typical loaded modules for Intel QAT devices. The presence of these modules indicates that the QAT drivers are correctly loaded.

```shell-output
qat_dh895xccvf         13281  0
qat_dh895xcc           13510  0
intel_qat             141755  2 qat_dh895xccvf,qat_dh895xcc
dh_generic             13286  1 intel_qat
rsa_generic            18819  1 intel_qat
authenc                17776  1 intel_qat
```

--------------------------------

### Retrieve Specific ACL Rule via RESTCONF cURL GET

Source: https://docs.netgate.com/tnsr/en/23.06/recipes/restconf-pki-nacm/index

Fetches a single ACL rule by its sequence number from a Netgate device using a cURL GET request to the RESTCONF API. This example retrieves the default permit rule (sequence 5000) for the 'blockbadhosts' ACL, requiring client certificate authentication.

```shell
$ curl -f --cert ~/tnsr/tnsr-restconf-client.crt \
  --key ~/tnsr/tnsr-restconf-client.key \
  --cacert ~/tnsr/tnsr-restconf-CA.crt \
  -X GET \
  https://tnsr.example.com/restconf/data/netgate-acl:acl-config/acl-table/acl-list=blockbadhosts/acl-rules/acl-rule=5000
```

```json
{
    "netgate-acl:acl-rule": [
      {
        "sequence": 5000,
        "acl-rule-description": "Default Permit",
        "action": "permit",
        "ip-version": "ipv4"
      }
    ]
  }
```

--------------------------------

### Configure FreeBSD Loader Prompt for Serial Console

Source: https://docs.netgate.com/platforms/rcc-ve-8860/freebsd

These commands are entered at the FreeBSD loader 'OK' prompt to temporarily configure the serial console settings, including the port address, baud rate, and UART flags. This setup is crucial for displaying the boot process and interacting with the installer via a serial connection before the OS fully loads.

```Shell
set comconsole_port=0x2F8
set comconsole_speed=115200
set hint.uart.0.flags=0x0
set hint.uart.1.flags=0x10
set console=comconsole
boot
```

--------------------------------

### Example PCI output for C3XXX system with QAT

Source: https://docs.netgate.com/tnsr/en/22.02/setup/setup-qat

Provides an example of 'vppctl show pci all' output for a C3XXX system, showing how QAT PF and VF devices are listed with their respective drivers.

```text
0000:01:00.0   0  8086:19e2   5.0 GT/s x16  c3xxx
0000:01:01.0   0  8086:19e3   unknown       igb_uio
0000:01:01.1   0  8086:19e3   unknown       c3xxxvf
```

--------------------------------

### Example QAT PF/VF Devices on C3XXX System

Source: https://docs.netgate.com/tnsr/en/22.06/setup/setup-qat

Provides a specific example of vppctl show pci all output for a C3XXX system, demonstrating how QAT Physical Function (PF) and Virtual Function (VF) devices might appear with their respective drivers.

```Shell
0000:01:00.0   0  8086:19e2   5.0 GT/s x16  c3xxx
0000:01:01.0   0  8086:19e3   unknown       igb_uio
0000:01:01.1   0  8086:19e3   unknown       c3xxxvf
```

--------------------------------

### VPP DPDK Configuration for QAT and Interfaces

Source: https://docs.netgate.com/tnsr/en/22.06/setup/setup-qat

Provides an example of the dpdk configuration block within /etc/vpp/startup.conf, detailing how to specify the igb_uio driver and bind specific PCI IDs for network interfaces and QAT VFs.

```Configuration
dpdk {
    uio-driver igb_uio
    dev 0000:04:01.0
    dev 0000:05:00.1
    dev 0000:03:00.0
    dev 0000:03:00.1
}
```

--------------------------------

### Example TNSR Dataplane Crypto Initialization Logs

Source: https://docs.netgate.com/tnsr/en/20.02/recipes/tnsr-remote-office/setup-tasks

This snippet provides an example of log messages that may appear during the initialization of the crypto hardware device (QAT) on the TNSR dataplane. These messages, including 'Failed to register crypto algs' and 'probe failed with error', are typically normal and can be ignored during system boot or console port operations.

```log
[  836.798096] c3xxxvf 0000:01:01.4: enabling device (0000 -> 0002)
[  836.804235] DMAR: 64bit 0000:01:01.4 uses identity mapping
[  836.839343] c3xxxvf 0000:01:01.0: Failed to register crypto algs
[  836.859227] c3xxxvf: probe of 0000:01:01.0 failed with error -14
[  836.865313] c3xxxvf 0000:01:01.1: enabling device (0000 -> 0002)
[  836.871718] DMAR: 64bit 0000:01:01.1 uses identity mapping
[  836.877853] c3xxxvf 0000:01:01.4: Failed to register crypto algs
[  836.897244] c3xxxvf: probe of 0000:01:01.4 failed with error -14
```

--------------------------------

### Interactive Program Startup Notice Example

Source: https://docs.netgate.com/tnsr/en/20.08/licensing/gplv2

Example of a short notice to be displayed by an interactive program upon startup, informing users about copyright, warranty, and redistribution conditions.

```Text
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### Default Netgate Network Configuration

Source: https://docs.netgate.com/pfsense/en/latest/solutions/sg-1000/getting-started

Details of the default network settings for the Netgate appliance, including LAN subnet, firewall IP, and recommended DNS servers. This information is crucial for initial setup and troubleshooting network connectivity.

```Network Configuration
Default LAN Subnet: 192.168.1.0/24
Firewall IP Address: 192.168.1.1
Recommended Static IP Subnet Mask: 255.255.255.0
DHCP Assigned IP Range: 192.168.1.x
Google Public DNS Servers: 8.8.8.8, 8.8.4.4
```

--------------------------------

### Configure Basic SPAN on TNSR

Source: https://docs.netgate.com/tnsr/en/latest/interfaces/types-span

Example demonstrating how to create a SPAN instance that mirrors all hardware-level packets (both transmit and receive) from a source interface (GigabitEthernet0/14/0) to a destination interface (memif1/1). This is a fundamental SPAN setup for general traffic monitoring.

```CLI
tnsr(config)# span GigabitEthernet0/14/0
tnsr(config-span)# onto memif1/1 hw both
tnsr(config-span)# exit
```

--------------------------------

### Example VPP PCI Device Output with igb_uio

Source: https://docs.netgate.com/tnsr/en/22.06/setup/setup-qat

Shows a sample output from vppctl show pci all highlighting devices that are successfully bound to the igb_uio driver, including both network interfaces and QAT VFs.

```Shell
0000:03:00.0   0  8086:15ac   2.5 GT/s x1  igb_uio
0000:03:00.1   0  8086:15ac   2.5 GT/s x1  igb_uio
0000:04:01.0   0  8086:0443   unknown      igb_uio
0000:05:00.1   0  8086:1521   5.0 GT/s x4  igb_uio
```

--------------------------------

### Retrieve ACL Configuration via RESTCONF GET with curl

Source: https://docs.netgate.com/tnsr/en/22.10/recipes/restconf-pki-nacm/index

This snippet shows how to retrieve the full configuration of a specific Access Control List (ACL) using the HTTP GET method. It is typically used to verify changes made by other operations like PATCH or DELETE, or to inspect the current state of an ACL. The example fetches the 'blockbadhosts' ACL.

```bash
curl -f --cert ~/tnsr/tnsr-myuser.crt \
  --key ~/tnsr/tnsr-myuser.key \
  --cacert ~/tnsr/tnsr-selfca.crt \
  -X GET \
  https://tnsr.example.com/restconf/data/netgate-acl:acl-config/acl-table/acl-list=blockbadhosts
```

--------------------------------

### Interactive Program GPL Startup Message Example

Source: https://docs.netgate.com/pfsense/en/latest/_downloads/91e7a3ae7fdac8a69a8155347c78d61e/iftop_GPLv2

This example shows a short notice to be displayed by interactive programs when they start, informing users about the software's copyright, lack of warranty, and free software status. It suggests commands to access full license details.

```Plaintext
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### Accessing Netgate Web Interface

Source: https://docs.netgate.com/pfsense/en/latest/solutions/sg-1000/getting-started

The default URL to access the Netgate appliance's web-based management interface from a connected computer. Browsers may show security warnings due to self-signed certificates, which are safe to bypass during initial setup.

```URL
https://192.168.1.1
```

--------------------------------

### Example TNSR Dataplane Crypto Device Initialization Logs

Source: https://docs.netgate.com/tnsr/en/24.06/recipes/tnsr-remote-office/setup-tasks

This snippet provides an example of typical log messages that may appear on the console during the initialization of the crypto hardware device (QAT) on the TNSR system. These messages are generally informational and can be ignored.

```CLI
[  836.798096] c3xxxvf 0000:01:01.4: enabling device (0000 -> 0002)
[  836.804235] DMAR: 64bit 0000:01:01.4 uses identity mapping
[  836.839343] c3xxxvf 0000:01:01.0: Failed to register crypto algs
[  836.859227] c3xxxvf: probe of 0000:01:01.0 failed with error -14
[  836.865313] c3xxxvf 0000:01:01.1: enabling device (0000 -> 0002)
[  836.871718] DMAR: 64bit 0000:01:01.1 uses identity mapping
[  836.877853] c3xxxvf 0000:01:01.4: Failed to register crypto algs
[  836.897244] c3xxxvf: probe of 0000:01:01.4 failed with error -14
```

--------------------------------

### Example C3XXX System QAT Device Binding Output

Source: https://docs.netgate.com/tnsr/en/24.10/setup/setup-qat

Demonstrates expected PCI device binding for QAT Physical and Virtual Functions on a C3XXX system, showing c3xxx and igb_uio drivers.

```text
0000:01:00.0   0  8086:19e2   5.0 GT/s x16  c3xxx
0000:01:01.0   0  8086:19e3   unknown       igb_uio
0000:01:01.1   0  8086:19e3   unknown       c3xxxvf
```

--------------------------------

### Netgate Installer Image Filename

Source: https://docs.netgate.com/pfsense/en/latest/solutions/xg-7100-1u/reinstall-pfsense

The specific filename of the compressed installer image for AMD64 architecture, required for installing pfSense Plus on Netgate devices.

```text
netgate-installer-amd64.img.gz
```

--------------------------------

### Example JSON Output for ACL GET Request

Source: https://docs.netgate.com/tnsr/en/20.08/recipes/restconf-pki-nacm/index

This JSON structure illustrates the typical response from a successful RESTCONF GET request for an ACL's configuration. It includes the ACL's name, description, and an array of its rules, each detailing sequence, action, IP version, and source IP prefix. This output confirms the current state of the ACL on the system.

```json
{
    \"netgate-acl:acl-list\": [
      {
        \"acl-name\": \"blockbadhosts\",
        \"acl-description\": \"Block packets from bad hosts\",
        \"acl-rules\": {
          \"acl-rule\": [
            {
              \"sequence\": 1,
              \"action\": \"deny\",
              \"ip-version\": \"ipv4\",
              \"src-ip-prefix\": \"203.0.113.14/32\"
            },
            {
              \"sequence\": 2,
              \"action\": \"deny\",
              \"ip-version\": \"ipv4\",
              \"src-ip-prefix\": \"203.0.113.15/32\"
            },
            {
              \"sequence\": 10,
              \"action\": \"deny\",
              \"ip-version\": \"ipv4\",
              \"src-ip-prefix\": \"10.222.111.222/32\"
            },
            {
              \"sequence\": 555,
              \"action\": \"deny\",
              \"ip-version\": \"ipv4\",
              \"src-ip-prefix\": \"5.5.5.5/32\"
            },
            {
              \"sequence\": 5000,
              \"acl-rule-description\": \"Default Permit\",
              \"action\": \"permit\",
              \"ip-version\": \"ipv4\"
            }
          ]
        }
      }
    ]
  }
```

--------------------------------

### Display GNU GPL Startup Notice for Interactive Programs

Source: https://docs.netgate.com/pfsense/en/latest/_downloads/2292246491efd7cd1ecb7cb748a92eed/gettext-runtime_GPLv3%2B

This snippet provides a template for a short notice to be displayed by interactive programs upon startup. It informs users about the program's copyright, warranty status, and redistribution conditions under the GNU GPL, suggesting commands for more details.

```Text
<program>  Copyright (C) <year>  <name of author>
    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type `show c' for details.
```

--------------------------------

### Change TNSR User Password (Administrator via Sudo)

Source: https://docs.netgate.com/tnsr/en/23.02/ztp/index

An administrator can use this command with 'sudo' to change the password for the 'tnsr' user without needing to know the current password. This is useful for resetting forgotten passwords or for initial setup by an administrative user.

```CLI
tnsr# host shell sudo passwd tnsr
Changing password for user tnsr.
New password:
Retype new password:
passwd: all authentication tokens updated successfully.
tnsr#
```

--------------------------------

### Example JSON Output for TNSR RESTCONF ACL Retrieval

Source: https://docs.netgate.com/tnsr/en/20.10/recipes/restconf-pki-nacm/index

This is an example of the JSON response received when successfully retrieving an ACL from the TNSR RESTCONF API. It illustrates the data structure for an ACL, including its name, description, and a list of rules, each with sequence numbers, actions, IP versions, and source IP prefixes. This output is a direct result of the cURL GET request.

```json
{
    "netgate-acl:acl-list": [
      {
        "acl-name": "blockbadhosts",
        "acl-description": "Block bad hosts",
        "acl-rules": {
          "acl-rule": [
            {
              "sequence": 1,
              "action": "deny",
              "ip-version": "ipv4",
              "src-ip-prefix": "203.0.113.14/32"
            },
            {
              "sequence": 2,
              "action": "deny",
              "ip-version": "ipv4",
              "src-ip-prefix": "203.0.113.15/32"
            },
            {
              "sequence": 555,
              "action": "deny",
              "ip-version": "ipv4",
              "src-ip-prefix": "5.5.5.5/32"
            },
            {
              "sequence": 5000,
              "acl-rule-description": "Default Permit",
              "action": "permit",
              "ip-version": "ipv4"
            }
          ]
        }
      }
    ]
  }
```

--------------------------------

### GNU GPL Interactive Program Startup Message Example

Source: https://docs.netgate.com/pfsense/en/latest/_downloads/5d018e4a05332527ae2d2fb10392f0ae/nss_ldap_GPLv2

An example of a short notice to be displayed by interactive programs when they start in interactive mode. This message informs users about the program's copyright, the absence of warranty, and directs them to commands for more details on the free software conditions.

```Text
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### Example Output: Loaded QAT Drivers

Source: https://docs.netgate.com/tnsr/en/19.08/setup/setup-qat

This snippet provides an example of the expected output when checking QAT driver status, confirming that various QAT-related kernel modules are loaded and operational.

```text
qat_dh895xccvf         13281  0
qat_dh895xcc           13510  0
intel_qat             141755  2 qat_dh895xccvf,qat_dh895xcc
dh_generic             13286  1 intel_qat
rsa_generic            18819  1 intel_qat
authenc                17776  1 intel_qat
```

--------------------------------

### Select Terminal Type for pfSense Installation

Source: https://docs.netgate.com/platforms/rcc-ve-8860/pfsense

This console output prompts the user to select the appropriate terminal type during the pfSense installation process. It lists common options such as ansi, vt100, xterm, and cons25w, guiding the user to choose the best fit for their system's console output.

```Console
Please choose the appropriate terminal type for your system.
Common console types are:
   ansi     Standard ANSI terminal
   vt100    VT100 or compatible terminal
   xterm    xterm terminal emulator (or compatible)
   cons25w  cons25w terminal
```
Tokens:
Raw