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
Platform → List
AI-generatedOverview
This node interacts with the NetBox API to list platform resources within the DCIM domain. It is useful for retrieving information about hardware platforms managed in NetBox, such as device platforms, including filtering and pagination options.
Use Case Examples
- Retrieve a list of all platforms in the DCIM domain.
- Fetch up to 50 platforms with specific filters like manufacturer name or platform ID.
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 | Determines whether to return all results or limit the number of results. |
| Limit | Maximum number of platform results to return when 'Return All' is false. |
| Filters | Collection of filters to narrow down the list of platforms, such as platform ID, name, slug, description, manufacturer ID, manufacturer name, NAPALM driver, and tag. |
Output
JSON
id- Unique identifier of the platform.name- Name of the platform.slug- Slug identifier for the platform.description- Description of the platform.manufacturer_id- Identifier of the manufacturer associated with the platform.manufacturer- Name or slug of the manufacturer.napalm_driver- NAPALM driver name associated with the platform.tag- Tags associated with the platform.
Dependencies
- NetBox API
- an API key credential for authentication
Troubleshooting
- Common issues include API authentication failures, incorrect domain or resource names, and invalid filter parameters.
- Error messages may indicate network issues, permission errors, or invalid input parameters. Ensure the API key is valid and the domain/resource names match NetBox API specifications.
Links
- NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and parameters.