NetBox icon

NetBox

Consume NetBox API

Actions243

Module Bay → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific Module Bay within the DCIM domain. It is useful for users who need to fetch detailed data about module bays in their data center infrastructure management system, such as for inventory tracking or configuration management.

Use Case Examples

  1. Retrieve details of a Module Bay by providing its ID and the domain set to DCIM.
  2. Use the node to get information about a Module Bay to integrate with other automation workflows in network or data center management.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, e.g., DCIM, IPAM, Tenancy, etc.
Module Bay ID The unique identifier of the Module Bay to retrieve. Required when the domain is DCIM and resource is module-bays with operation get.

Output

JSON

  • id - The unique identifier of the Module Bay.
  • name - The name of the Module Bay.
  • description - Description or details about the Module Bay.
  • device - The device to which the Module Bay belongs.
  • position - The position of the Module Bay within the device.
  • status - The current status of the Module Bay.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Module Bay ID is correctly provided and exists in the NetBox instance.
  • Verify that the API key credential is valid and has sufficient permissions to access the DCIM domain and module bays.
  • Common error messages include authentication failures, resource not found errors, and network connectivity issues. Resolving these involves checking credentials, verifying resource IDs, and ensuring network access to the NetBox API endpoint.

Links

Discussion