PowerNetbox

The comprehensive PowerShell module for the Netbox REST API with 100% coverage. Fully compatible with Netbox 4.4.8.

---

Acknowledgements

This project is a fork of the original NetboxPS created by Ben Claussen.

We extend our sincere thanks to Ben and all original contributors for building the foundation of this module. Their work made PowerNetbox possible.

Original Author	Ben Claussen
Original Repository	benclaussen/NetboxPS
License	MIT (preserved from original)

---

Features

• 100% API Coverage - Full support for all Netbox 4.x API endpoints
• Cross-Platform - Works on Windows, Linux, and macOS
• 488+ Functions - Complete CRUD operations for all resources
• Pipeline Support - Full PowerShell pipeline integration
• Secure - Token-based authentication with TLS 1.2/1.3
• Well Tested - 613 unit tests for quality assurance

Supported Modules

Module	Endpoints	Functions	Status
DCIM	45	180	✅ Full
IPAM	18	72	✅ Full
Virtualization	5	20	✅ Full
Circuits	11	44	✅ Full
Tenancy	5	20	✅ Full
VPN	10	40	✅ Full
Wireless	3	12	✅ Full
Extras	12	45	✅ Full
Core	5	8	✅ Full
Users	4	16	✅ Full

Installation

From PowerShell Gallery (Recommended)

# Install for current user
Install-Module -Name PowerNetbox -Scope CurrentUser

# Install system-wide (requires admin/root)
Install-Module -Name PowerNetbox -Scope AllUsers

Platform-Specific Instructions

Windows

# PowerShell 5.1 (Windows PowerShell)
Install-Module -Name PowerNetbox -Scope CurrentUser

# PowerShell 7+ (recommended)
pwsh -Command "Install-Module -Name PowerNetbox -Scope CurrentUser"

macOS

# Install PowerShell 7 via Homebrew
brew install powershell/tap/powershell

# Install PowerNetbox
pwsh -Command "Install-Module -Name PowerNetbox -Scope CurrentUser"

Linux (Ubuntu/Debian)

# Install PowerShell 7
sudo apt-get update
sudo apt-get install -y wget apt-transport-https software-properties-common
wget -q "https://packages.microsoft.com/config/ubuntu/$(lsb_release -rs)/packages-microsoft-prod.deb"
sudo dpkg -i packages-microsoft-prod.deb
sudo apt-get update
sudo apt-get install -y powershell

# Install PowerNetbox
pwsh -Command "Install-Module -Name PowerNetbox -Scope CurrentUser"

Manual Installation

# Clone the repository
git clone https://github.com/ctrl-alt-automate/PowerNetbox.git
cd PowerNetbox

# Build the module
./deploy.ps1 -Environment prod -SkipVersion

# Import the module
Import-Module ./PowerNetbox/PowerNetbox.psd1

Quick Start

Connect to Netbox

# Import the module
Import-Module PowerNetbox

# Connect with API token
$credential = Get-Credential -UserName 'api' -Message 'Enter your Netbox API token'
Connect-NBAPI -Hostname 'netbox.example.com' -Credential $credential

# Or connect with self-signed certificate
Connect-NBAPI -Hostname 'netbox.local' -Credential $credential -SkipCertificateCheck

Basic Examples

# Get all devices
Get-NBDCIMDevice

# Get a specific device by name
Get-NBDCIMDevice -Name 'server01'

# Create a new IP address
New-NBIPAMAddress -Address '10.0.0.1/24' -Description 'Web Server'

# Update a device
Set-NBDCIMDevice -Id 1 -Description 'Updated description'

# Delete a device (with confirmation)
Remove-NBDCIMDevice -Id 1

# Pipeline support
Get-NBDCIMDevice -Name 'server*' | Set-NBDCIMDevice -Status 'active'

Advanced Examples

# Create a VM with interface and IP
$vm = New-NBVirtualMachine -Name 'web-server-01' -Cluster 1 -Status 'active'
$interface = New-NBVirtualMachineInterface -Name 'eth0' -Virtual_Machine $vm.id
$ip = New-NBIPAMAddress -Address '192.168.1.100/24'
Set-NBIPAMAddress -Id $ip.id -Assigned_Object_Type 'virtualization.vminterface' -Assigned_Object_Id $interface.id

# Bulk operations with pipeline
Import-Csv devices.csv | ForEach-Object {
    New-NBDCIMDevice -Name $_.Name -Device_Type $_.Type -Site $_.Site
}

# Query with filters
Get-NBIPAMAddress -Status 'active' -Tenant 1 -Limit 100

Migrating from NetboxPS / NetboxPSv4

If you're migrating from the original NetboxPS or NetboxPSv4 module:

# Remove old module
Remove-Module NetboxPS, NetboxPSv4 -Force -ErrorAction SilentlyContinue
Uninstall-Module NetboxPS, NetboxPSv4 -Force -ErrorAction SilentlyContinue

# Install PowerNetbox
Install-Module -Name PowerNetbox -Scope CurrentUser

# Import new module
Import-Module PowerNetbox

All function names remain the same (Get-NBDCIMDevice, New-NBIPAMAddress, etc.), so your existing scripts should work without modification.

Documentation

• CLAUDE.md - Detailed development guide and API reference
• Netbox API Docs - Official Netbox API documentation

Requirements

Platform	Minimum Version
PowerShell Desktop	5.1
PowerShell Core	7.0+
Netbox	2.8+ (tested with 4.4.8)

Platform Support

OS	PowerShell 5.1	PowerShell 7+
Windows 10/11	✅	✅
Windows Server	✅	✅
macOS	N/A	✅
Linux	N/A	✅

Contributing

We welcome contributions! Please follow these guidelines:

1. Fork the repository
2. Create a feature branch from dev
3. Follow PowerShell Practice and Style Guidelines
4. Submit a pull request against the dev branch

See CLAUDE.md for detailed development instructions.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Original copyright (c) 2018 Ben Claussen. Fork maintained by ctrl-alt-automate.

Changelog

v4.4.8 (Current) - PowerNetbox Release

• Version now tracks Netbox releases (4.4.8 = Netbox 4.4.8)
• Rebranded from NetboxPSv4 to PowerNetbox
• 100% API coverage for Netbox 4.4.8
• 488+ public functions across all modules
• 613 unit tests for quality assurance
• Cross-platform support - Windows, Linux, macOS
• All function names unchanged for backwards compatibility
• Improved documentation and development guide

v4.4.7 - NetboxPSv4 Final

• Full Netbox 4.4.7 compatibility
• New modules: VPN, Wireless, Core, Users
• Cross-platform support
• Removed Windows-only dependencies

Previous Versions

See the original NetboxPS repository for earlier version history.