Hudu icon

Hudu

Interact with Hudu REST API

Actions144

VLAN → Get

AI-generated

Overview

This node operation retrieves a specific VLAN (Virtual Local Area Network) from the Hudu system using either a numeric VLAN ID or a URL slug as the identifier. It is useful for network administrators or IT professionals who need to fetch detailed information about a particular VLAN for management, auditing, or integration purposes.

Use Case Examples

  1. Retrieve VLAN details by numeric ID to verify network configuration.
  2. Fetch VLAN information using a slug to integrate with other network management tools.

Properties

Name Meaning
Identifier Type Determines whether the VLAN is retrieved by its numeric ID or by its URL slug.
VLAN ID The unique identifier of the VLAN, which can be either the numeric ID or the slug depending on the Identifier Type selected.

Output

JSON

  • id - The unique numeric identifier of the VLAN.
  • slug - The URL slug identifier of the VLAN.
  • name - The name of the VLAN.
  • description - Description or details about the VLAN.
  • otherProperties - Additional VLAN properties returned by the Hudu API, which may include network settings, status, and metadata.

Dependencies

  • Requires Hudu API credentials for authentication to access VLAN data.

Troubleshooting

  • Ensure the VLAN ID or slug provided is correct and exists in the Hudu system to avoid 'not found' errors.
  • Verify that the Hudu API credentials are valid and have sufficient permissions to read VLAN information.
  • If the node throws an error about unknown resource, confirm that the resource parameter is set to 'vlans' and operation to 'get'.

Discussion