Skip to content

README.md

Latest commit

 

History

History
87 lines (66 loc) · 3.23 KB

README.md

File metadata and controls

87 lines (66 loc) · 3.23 KB

PowerNetbox Documentation

Welcome to the PowerNetbox documentation.

PowerNetbox is a comprehensive PowerShell module for the Netbox REST API with 100% coverage of all endpoints. Fully compatible with Netbox 4.3 - 4.5.

Quick Start

# Install from PSGallery
Install-Module -Name PowerNetbox

# Connect to Netbox
$cred = Get-Credential  # Enter 'api' as username, token as password
Connect-NBAPI -Hostname 'netbox.example.com' -Credential $cred

# Start using it
Get-NBDCIMDevice -Name 'server01'

Guides

Guide Description
Getting Started Installation and first steps
Common Workflows Real-world use cases and examples
Bulk Operations High-performance batch create/update/delete
Performance Optimization Tips for large-scale operations
Branching Netbox Branching plugin support

Examples by Module

Module Guide
DCIM DCIM Examples
IPAM IPAM Examples
GraphQL GraphQL Examples

Reference

Topic Description
Compatibility Netbox version support matrix
Function Naming Naming conventions and patterns
Troubleshooting Solutions to common issues

Contributing

Features

Feature Description
524 Functions Complete CRUD operations for all Netbox resources
100% API Coverage All Netbox 4.x modules supported
Cross-Platform Windows, Linux, and macOS
Pipeline Support Full PowerShell pipeline integration
Bulk Operations High-performance batch operations with automatic error recovery
Tab Completion Argument completers for common parameters
Verbose Logging Write-Verbose in all functions for debugging
Well Tested 1436 unit tests, 98 integration tests

Supported Modules

Module Functions Description
DCIM 180 Sites, devices, racks, cables, interfaces
IPAM 72 IP addresses, prefixes, VLANs, VRFs
Virtualization 20 VMs, clusters, VM interfaces
Circuits 44 Circuits, providers, terminations
Tenancy 20 Tenants, contacts
VPN 40 Tunnels, L2VPN, IPsec
Wireless 12 Wireless LANs and links
Extras 45 Tags, custom fields, webhooks
Core 8 Data sources, jobs
Users 24 Users, groups, permissions, owners
Branching* 16 Branch management (plugin)

* Requires netbox-branching plugin

Resources
⚡