NetBox icon

NetBox

Consume NetBox API

Actions243

Site → Get Devices

AI-generated

Overview

This node interacts with the NetBox API to retrieve devices associated with a specific site within the DCIM domain. It is useful for network administrators or IT professionals who need to programmatically access device information for a given site in their infrastructure management system. For example, it can be used to fetch all devices installed at a particular data center site to monitor or audit hardware inventory.

Use Case Examples

  1. Retrieve all devices for a site with a given Site ID in the DCIM domain.
  2. Fetch a limited number of devices for a site to display in a dashboard or report.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for data center infrastructure management.
Site ID The unique identifier of the site for which devices are to be retrieved.
Return All Boolean flag to determine whether to return all devices or limit the number of results.
Limit Maximum number of device results to return if 'Return All' is false.

Output

JSON

  • devices - Array of device objects retrieved from the specified site in NetBox.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the Site ID is valid and exists in the NetBox instance to avoid 'not found' errors.
  • Check API credentials and permissions if authentication errors occur.
  • If no devices are returned, verify that the site actually has devices assigned in NetBox.

Links

Discussion