Ansible Collection - oxlorg.nftables

---

Functional Tests:

• Status: |
• Logs: API | Daily Archive | Short | Full

Internal CI: Tester Role | Jobs API

---

Usage

See: Docs

Alternative Link

You want a simple Ansible GUI? Check-out our Ansible WebUI

---

Contribute

Feel free to contribute to this project using pull-requests, issues and discussions!

See also: Contributing

---

Advertisement

• You want a simple Ansible GUI?

  Check-out this Ansible WebUI

---

Modules

not implemented => development => testing => unstable (practical testing) => stable

Function	Module	Usage	State
Listing	oxlorg.nftables.list	Docs	testing
Rules	oxlorg.nftables.rule	Docs, NFTables Docs	development
1-to-1 Rules	oxlorg.nftables.rule_raw	Docs, NFTables Docs	testing
Chains	oxlorg.nftables.chain	Docs, NFTables Docs	testing
Tables	oxlorg.nftables.table	Docs, NFTables Docs	testing
Variables	oxlorg.nftables.var	Docs, NFTables Docs	not implemented
Sets	oxlorg.nftables.set	Docs, NFTables Docs	not implemented
Limits	oxlorg.nftables.limit	Docs, NFTables Docs	not implemented
Counters	oxlorg.nftables.counter	Docs, NFTables Docs	not implemented

---

Requirements

First - install nftables!

For the python library to work the installed NFTables version needs to be >= 0.9.3

sudo apt install nftables

# check the installed version
sudo apt policy nftables

The ansible-modules of this collection use the python3-nftables module to interact with nftables.

You can either install it using your package manager (apt in the example) or using pip (unofficial version provided by OXL) on the target system.

# package manager
sudo apt install python3-nftables

# pip => make sure it is installed for the root user or use a virtualenv
sudo pip install oxl-libnftables

You might want to install it using Ansible:

- name: Installing NFTables
  ansible.builtin.package:
    name: ['nftables']  # or ['nftables', 'python3-nftables']

- name: Installing NFTables python-module
  ansible.builtin.pip:
    name: 'oxl-libnftables'

- name: Enabling and starting NFTables
  ansible.builtin.service:
    name: 'nftables.service'
    state: started
    enabled: true

Then - install the collection itself: (on the controller)

# unstable/latest version:
ansible-galaxy collection install oxlorg.nftables
## OR
ansible-galaxy collection install git+https://github.com/O-X-L/ansible-collection-nftables.git

# install to specific director for easier development
cd $PLAYBOOK_DIR
ansible-galaxy collection install git+https://github.com/O-X-L/ansible-collection-nftables.git -p ./collections