Actions243
- Cable Actions
- Cable Termination Actions
- Connected Device Actions
- Console Port Actions
- Console Port Template Actions
- Console Server Port Actions
- Console Server Port Template Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Front Port Actions
- Front Port Template Actions
- Interface Actions
- Interface Template Actions
- Inventory Item Actions
- Inventory Item Role Actions
- Inventory Item Template Actions
- Location Actions
- MAC Address Actions
- Manufacturer Actions
- Module Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Module Type Profile Actions
- Platform Actions
- Power Feed Actions
- Power Outlet Actions
- Power Outlet Template Actions
- Power Panel Actions
- Power Port Actions
- Power Port Template Actions
- Rack Actions
- Rack Reservation Actions
- Rack Role Actions
- Rack Type Actions
- Rear Port Actions
- Rear Port Template Actions
- Region Actions
- Site Actions
- Site Group Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
- Virtual Link Actions
Site → List
AI-generatedOverview
This node interacts with the NetBox API to list sites within the DCIM domain. It allows users to retrieve a list of sites with optional filtering and pagination controls. This is useful for network administrators or IT professionals who want to programmatically access and manage site information stored in NetBox, such as retrieving all sites or filtering sites by attributes like name, status, region, or tenant.
Use Case Examples
- Retrieve all sites in the DCIM domain without any filters.
- List sites with a specific status, such as 'Active'.
- Limit the number of returned sites to a specified number for pagination purposes.
- Filter sites by region name or tenant ID to narrow down the results.
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. |
| Return All | Boolean flag to determine whether to return all results or limit the number of results. |
| Limit | Maximum number of results to return when 'Return All' is false. |
| Filters | Collection of optional filters to narrow down the list of sites, such as site ID, name, slug, facility, status, region, site group, tenant, latitude, longitude, search term, and tag. |
Output
JSON
id- Unique identifier of the site.name- Name of the site.slug- Slug identifier for the site.facility- Facility code of the site.status- Current status of the site.region_id- Identifier of the region the site belongs to.region- Name or slug of the region.group_id- Identifier of the site group.group- Name or slug of the site group.tenant_id- Identifier of the tenant associated with the site.tenant- Name or slug of the tenant.latitude- Latitude coordinate of the site.longitude- Longitude coordinate of the site.tag- Tags associated with the site.
Dependencies
- NetBox API
- API key credential for authentication
Troubleshooting
- Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
- Incorrect domain or resource selection may result in no data or errors. Verify the domain is set to 'dcim' and resource to 'sites' for this operation.
- Filters must be correctly formatted; invalid filter values may cause the API to reject the request.
- If 'Return All' is false and 'Limit' is set too low, the returned data may be incomplete. Adjust the limit or enable 'Return All' to retrieve all results.
Links
- NetBox API Documentation - Sites - Official documentation for the Sites resource in the DCIM domain of NetBox API.