Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

VLANs & Networks → Delete Layer2 VLAN

AI-generated

Overview

This node operation deletes a specified Layer 2 VLAN from the Aruba Central Next Gen system. It is useful for network administrators who need to manage and clean up VLAN configurations by removing unused or obsolete VLANs. For example, if a VLAN is no longer needed in the network, this operation can be used to delete it by specifying its VLAN ID.

Use Case Examples

  1. Deleting VLAN ID 10 from the configuration domain to remove an unused VLAN.
  2. Automating VLAN cleanup in a network management workflow by deleting VLANs that are no longer active.

Properties

Name Meaning
Debug Mode Whether to enable detailed debug logs for troubleshooting.
Domain API domain to interact with, such as monitoring, configuration, interfaces, routing, network services, security, management, or system.
VLAN ID ID of the VLAN to delete (1-4094).

Output

JSON

  • vlanId - The ID of the VLAN that was deleted.
  • status - The status of the delete operation, indicating success or failure.
  • message - Additional information or error message related to the delete operation.

Dependencies

  • An API key credential for Aruba Central Next Gen OAuth2 authentication is required to authorize the API requests.

Troubleshooting

  • If the VLAN ID specified is out of the valid range (1-4094), the node will throw an error. Ensure the VLAN ID is within this range.
  • If the API domain is incorrect or the user lacks permissions for the specified domain, the operation will fail. Verify the domain and user permissions.
  • Enable Debug Mode to get detailed logs which can help identify issues with API requests or responses.
  • Common error messages include authentication failures, invalid VLAN ID, or network connectivity issues. Check credentials and network access to Aruba Central API.

Discussion