NetBox MCP Server - Read & Write Edition

Get objects from NetBox based on their type and filters Args: object_type: String representing the NetBox object type (e.g. "devices", "ip-addresses") filters: dict of filters to apply to the API call based on the NetBox API filtering options

Valid object_type values:

DCIM (Device and Infrastructure):

• cables

• console-ports

• console-server-ports

• devices

• device-bays

• device-roles

• device-types

• front-ports

• interfaces

• inventory-items

• locations

• manufacturers

• modules

• module-bays

• module-types

• platforms

• power-feeds

• power-outlets

• power-panels

• power-ports

• racks

• rack-reservations

• rack-roles

• regions

• sites

• site-groups

• virtual-chassis

IPAM (IP Address Management):

• asns

• asn-ranges

• aggregates

• fhrp-groups

• ip-addresses

• ip-ranges

• prefixes

• rirs

• roles

• route-targets

• services

• vlans

• vlan-groups

• vrfs

Circuits:

• circuits

• circuit-types

• circuit-terminations

• providers

• provider-networks

Virtualization:

• clusters

• cluster-groups

• cluster-types

• virtual-machines

• vm-interfaces

Tenancy:

• tenants

• tenant-groups

• contacts

• contact-groups

• contact-roles

VPN:

• ike-policies

• ike-proposals

• ipsec-policies

• ipsec-profiles

• ipsec-proposals

• l2vpns

• tunnels

• tunnel-groups

Wireless:

• wireless-lans

• wireless-lan-groups

• wireless-links

See NetBox API documentation for filtering options for each object type.

Get detailed information about a specific NetBox object by its ID.

Args: object_type: String representing the NetBox object type (e.g. "devices", "ip-addresses") object_id: The numeric ID of the object

Returns: Complete object details

Get object change records (changelogs) from NetBox based on filters.

Args: filters: dict of filters to apply to the API call based on the NetBox API filtering options

Returns: List of changelog objects matching the specified filters

Filtering options include:

• user_id: Filter by user ID who made the change

• user: Filter by username who made the change

• changed_object_type_id: Filter by ContentType ID of the changed object

• changed_object_id: Filter by ID of the changed object

• object_repr: Filter by object representation (usually contains object name)

• action: Filter by action type (created, updated, deleted)

• time_before: Filter for changes made before a given time (ISO 8601 format)

• time_after: Filter for changes made after a given time (ISO 8601 format)

• q: Search term to filter by object representation

Example: To find all changes made to a specific device with ID 123: {"changed_object_type_id": "dcim.device", "changed_object_id": 123}

To find all deletions in the last 24 hours: {"action": "delete", "time_after": "2023-01-01T00:00:00Z"}

Each changelog entry contains:

• id: The unique identifier of the changelog entry

• user: The user who made the change

• user_name: The username of the user who made the change

• request_id: The unique identifier of the request that made the change

• action: The type of action performed (created, updated, deleted)

• changed_object_type: The type of object that was changed

• changed_object_id: The ID of the object that was changed

• object_repr: String representation of the changed object

• object_data: The object's data after the change (null for deletions)

• object_data_v2: Enhanced data representation

• prechange_data: The object's data before the change (null for creations)

• postchange_data: The object's data after the change (null for deletions)

• time: The timestamp when the change was made

Create a new object in NetBox.

Args: object_type: String representing the NetBox object type (e.g. "devices", "ip-addresses") data: Dict containing the object data to create

Returns: The created object as a dict

Example: To create a new site: netbox_create_object("sites", { "name": "New Site", "slug": "new-site", "status": "active" })

To create a new device: netbox_create_object("devices", { "name": "new-device", "device_type": 1, # ID of device type "site": 1, # ID of site "role": 1, # ID of device role "status": "active" })

Update an existing object in NetBox.

Args: object_type: String representing the NetBox object type (e.g. "devices", "ip-addresses") object_id: The numeric ID of the object to update data: Dict containing the object data to update (only changed fields needed)

Returns: The updated object as a dict

Example: To update a site's description: netbox_update_object("sites", 1, {"description": "Updated description"})

To change a device's status: netbox_update_object("devices", 5, {"status": "offline"})

Delete an object from NetBox.

Args: object_type: String representing the NetBox object type (e.g. "devices", "ip-addresses") object_id: The numeric ID of the object to delete

Returns: True if deletion was successful

WARNING: This permanently deletes the object and cannot be undone!

Example: To delete a device: netbox_delete_object("devices", 5)

To delete an IP address: netbox_delete_object("ip-addresses", 123)

Create multiple objects in NetBox in a single request.

Args: object_type: String representing the NetBox object type (e.g. "devices", "ip-addresses") data: List of dicts containing the object data to create

Returns: List of created objects

Example: To create multiple sites: netbox_bulk_create_objects("sites", [ {"name": "Site A", "slug": "site-a", "status": "active"}, {"name": "Site B", "slug": "site-b", "status": "active"} ])

Update multiple objects in NetBox in a single request.

Args: object_type: String representing the NetBox object type (e.g. "devices", "ip-addresses") data: List of dicts containing the object data to update (must include "id" field)

Returns: List of updated objects

Example: To update multiple devices: netbox_bulk_update_objects("devices", [ {"id": 1, "status": "offline"}, {"id": 2, "status": "maintenance"} ])

Delete multiple objects from NetBox in a single request.

Args: object_type: String representing the NetBox object type (e.g. "devices", "ip-addresses")
object_ids: List of numeric IDs to delete

Returns: Success status

WARNING: This permanently deletes the objects and cannot be undone!

Example: To delete multiple devices: netbox_bulk_delete_objects("devices", [5, 6, 7])