n8n-nodes-arubacentral
Version:
n8n community node for Aruba Central API integration with comprehensive monitoring, configuration, and management capabilities
511 lines (410 loc) • 12.5 kB
Plain Text
List Troubleshooting Commands
get /troubleshooting/v1/commands
Get a list of troubleshooting commands for specific type of device.
Possible error_codes for the error responses are
0001 - General Error.
0004 - Validation Error. Invalid value for a query parameter.
Parameters
string
Specify one of "IAP" for swarm, "MAS" for MAS switches, "SWITCH" for aruba switches, "CONTROLLER" for controllers respectively.
Test this endpoint
Response Messages
400 Bad Request
401 Unauthorized
403 Forbidden
413 Request-size limit exceeded
417 Request-size limit exceeded
429 API Rate limit exceeded
500 Internal server error
Response Sample
{
"commands": [
{
"command": "string",
"summary": "string",
"category": "string",
"command_id": 0,
"arguments": [
{
"name": "string",
"description": "string"
}
]
}
]
}
Response Schema
List Troubleshooting CX Commands
get /troubleshooting/v1/cxcommands
Get a list of troubleshooting commands for CX device.
Possible error_codes for the error responses are
0001 - General Error.
0004 - Validation Error. Invalid value for a query parameter.
Parameters
string
Serial of CX Device
Test this endpoint
Response Messages
400 Bad Request
401 Unauthorized
403 Forbidden
413 Request-size limit exceeded
417 Request-size limit exceeded
429 API Rate limit exceeded
500 Internal server error
default Unexpected error
Response Sample
{
"commands": [
"string"
]
}
Response Schema
Clear Troubleshooting Session
delete /troubleshooting/v1/devices/{serial}
Clear troubleshooting session and output for specific troubleshooting session of device.
Possible error_codes for the error responses are
0001 - General Error.
Parameters
string
Serial of device
integer
Unique ID for each troubleshooting session
Test this endpoint
Response Messages
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not found
413 Request-size limit exceeded
417 Request-size limit exceeded
429 API Rate limit exceeded
500 Internal server error
default Unexpected error
Get Troubleshooting Output
get /troubleshooting/v1/devices/{serial}
Get a troubleshooting output for the troubleshooting session of specific device. Troubleshooting output has hold time of 5 minutes after which it will be expired.
Possible error_codes for the error responses are
0001 - General Error.
0004 - Validation Error. Invalid value for a query parameter.
Parameters
string
Serial of device
integer
Unique ID for each troubleshooting session
Test this endpoint
Response Messages
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not found
413 Request-size limit exceeded
417 Request-size limit exceeded
429 API Rate limit exceeded
500 Internal server error
default Unexpected error
Response Sample
{
"serial": "string",
"hostname": "string",
"output": "string",
"status": "string",
"message": "string"
}
Response Schema
Start Troubleshooting Session
post /troubleshooting/v1/devices/{serial}
Start troubleshooting session with list of commands for specific device. List of commands can have at most 10 commands. If there is any troubleshooting session running already for device then you cannot start new session.
Possible error_codes for the error responses are
0001 - General Error.
0002 - Validation Error. Out of Range value for a query parameter.
0007 - Validation Error. Invalid value for a parameter.
Parameters
string
Serial of device
Content type:
Troubleshoot
Initiate troubleshooting session for device
Test this endpoint
Response Messages
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not found
413 Request-size limit exceeded
417 Request-size limit exceeded
429 API Rate limit exceeded
500 Internal server error
default Unexpected error
Body Sample
{
"device_type": "string",
"commands": [
{
"command_id": 0,
"arguments": [
{
"name": "string",
"value": "string"
}
]
}
]
}
Body Schema
Response Sample
{
"serial": "string",
"status": "string",
"message": "string",
"session_id": 0
}
Response Schema
Start Troubleshooting Session For CX Device
post /troubleshooting/v1/cxdevices/{serial}
Start troubleshooting session with list of commands for cx device. List of commands can have at most 10 commands. If there is any troubleshooting session running already for device then you cannot start new session.
Possible error_codes for the error responses are
0001 - General Error.
0002 - Validation Error. Out of Range value for a query parameter.
0007 - Validation Error. Invalid value for a parameter.
Parameters
string
Serial of device
Content type:
Troubleshootcx
Initiate troubleshooting session for cx device
Test this endpoint
Response Messages
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not found
413 Request-size limit exceeded
417 Request-size limit exceeded
429 API Rate limit exceeded
500 Internal server error
default Unexpected error
Body Sample
{
"commands": [
"string"
]
}
Body Schema
Response Sample
{
"serial": "string",
"status": "string",
"message": "string",
"session_id": 0
}
Response Schema
Get Troubleshooting Session ID
get /troubleshooting/v1/devices/{serial}/session
Get troubleshooting session_id for the troubleshooting session of specific device.
Possible error_codes for the error responses are
0001 - General Error.
0004 - Validation Error. Invalid value for a query parameter.
Parameters
string
Serial of device
Test this endpoint
Response Messages
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not found
413 Request-size limit exceeded
417 Request-size limit exceeded
429 API Rate limit exceeded
500 Internal server error
default Unexpected error
Response Sample
{
"session_id": "string"
}
Response Schema
Get list of backups associated with the device serial with the given prefix
get /troubleshooting/v1/running-config-backup/serial/{serial}/prefix/{prefix}
Get list of backups associated with the device serial
Parameters
string
Serial of device
string
Name prefix for name of long term named storage. Must be 3 - 64 characters. Must start with a letter or number. Can contain the following special characters: '-', ',', '?', '!', '+', '&', '@', ':', ';', '(', ')', '_', '.', '*'
Test this endpoint
Response Messages
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not found
413 Request-size limit exceeded
417 Request-size limit exceeded
429 API Rate limit exceeded
500 Internal Server Error
default Unexpected error
Response Sample
{
"status": [
{
"prefix": "string",
"name": "string",
"timestamp": "string",
"serial": "string",
"status": "string"
}
]
}
Response Schema
Initiate Running Config Backup For A Single Device
post /troubleshooting/v1/running-config-backup/serial/{serial}/prefix/{prefix}
Initiate backup of running config for the switch with the given serial and store output against a name starting with the given prefix.
Parameters
string
Serial of device
string
Name prefix for name of long term named storage. Must be 3 - 64 characters. Must start with a letter or number. Can contain the following special characters: '-', ',', '?', '!', '+', '&', '@', ':', ';', '(', ')', '_', '.', '*'
Test this endpoint
Response Messages
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not found
413 Request-size limit exceeded
417 Request-size limit exceeded
429 API Rate limit exceeded
500 Internal Server Error
default Unexpected error
Response Sample
{
"accepted": [
{
"serial": "string",
"reason": "string",
"status": "string"
}
],
"rejected": [
{
"serial": "string",
"reason": "string",
"status": "string"
}
]
}
Response Schema
Initiate Running Config Backup For All Devices In A Group
post /troubleshooting/v1/running-config-backup/group_name/{group_name}/prefix/{prefix}
Initiate backup of running config for switches in the group store output against names starting with the given prefix.
Parameters
string
Group name of the group of interest
string
Name prefix for name of long term named storage. Must be 3 - 64 characters. Must start with a letter or number. Can contain the following special characters: '-', ',', '?', '!', '+', '&', '@', ':', ';', '(', ')', '_', '.', '*'
Test this endpoint
Response Messages
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not found
413 Request-size limit exceeded
417 Request-size limit exceeded
429 API Rate limit exceeded
500 Internal Server Error
default Unexpected error
Response Sample
{
"accepted": [
{
"serial": "string",
"reason": "string",
"status": "string"
}
],
"rejected": [
{
"serial": "string",
"reason": "string",
"status": "string"
}
]
}
Response Schema
Get list of backups associated with the device serial
get /troubleshooting/v1/running-config-backup/serial/{serial}
Get list of backups associated with the device serial
Parameters
string
Serial of device
Test this endpoint
Response Messages
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not found
413 Request-size limit exceeded
417 Request-size limit exceeded
429 API Rate limit exceeded
500 Internal Server Error
default Unexpected error
Response Sample
{
"status": [
{
"prefix": "string",
"name": "string",
"timestamp": "string",
"serial": "string",
"status": "string"
}
]
}
Response Schema
Fetch the backup stored against the given name
get /troubleshooting/v1/running-config-backup/name/{name}
Fetch the backup stored against the given name
Parameters
string
Name of the backup to fetch
Test this endpoint
Response Messages
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not found
413 Request-size limit exceeded
417 Request-size limit exceeded
429 API Rate limit exceeded
500 Internal Server Error
default Unexpected error
Response Sample
{
"name": "string",
"time": "string",
"serial": "string",
"output": "string"
}
Response Schema
Action command for enroll est certificate
post /tools/action_cmd/device/{serial}/enroll_est_cert
Send enroll est certificate command to switch
Possible error_codes for the error responses are:
0001 - General Error.
0004 - Validation Error. Invalid value for a query parameter.
Parameters
string
Serial of device
Content type:
EstCertEnrollBody
To enroll est certificate for the switch
Test this endpoint
Response Messages
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not found
413 Request-size limit exceeded
417 Request-size limit exceeded
429 API Rate limit exceeded
500 Internal Server Error
default Unexpected error