Skip to content

Reference

PowerNetbox provides ~508 cmdlets organized by NetBox module. Each cmdlet has a dedicated page with synopsis, syntax, parameters, examples, and a "Since v..." badge indicating the release that introduced it.

Naming convention

All cmdlets follow [Verb]-NB[Module][Resource]:

Verb Action HTTP method Example
Get- Retrieve GET Get-NBDCIMDevice
New- Create POST New-NBIPAMAddress
Set- Update PATCH Set-NBVirtualMachine
Remove- Delete DELETE Remove-NBDCIMSite

The NB prefix avoids collisions with other modules. The [Module][Resource] segment mirrors NetBox's URL path: /api/dcim/devices/ <-> Get-NBDCIMDevice.

For deeper conventions (parameter naming, [Nullable[T]] clearing pattern, ValidateSet drift), see Architecture - Parameter conventions.

Most-used cmdlets to bookmark:

Common parameters

Most cmdlets share a small set of parameters (-Raw, -All, -PageSize, -Brief, -Fields, -Omit, and bulk-operation parameters). They're documented once at Common parameters and included on every cmdlet page via collapsible blocks.

All modules

Module Endpoints Cmdlets Highlights
DCIM 45 180 Devices, Sites, Cables, Interfaces, Racks
IPAM 18 72 IP Addresses, Prefixes, VLANs, VRFs
Virtualization 5 20 Virtual Machines, Clusters, Interfaces
Circuits 11 44 Providers, Circuits, Terminations
Tenancy 5 20 Tenants, Tenant Groups, Contacts
VPN 10 40 Tunnels, IKE, IPSec
Wireless 3 12 LANs, Links
Extras 12 45 Custom Fields, Tags, Webhooks, Saved Filters
Users 4 16 Users, Groups, Permissions, Tokens
Core 5 8 API Definition, Object Types, Branching