Skip to main content
Contact Us

OpenManage Enterprise 3.10 RESTful API Guide

PDF

POST method for TroubleshootService.TestApplianceConnection

Description
Perform an appliance connection test to determine it's reachability status.
Privilege
DEVICE_CONFIGURATION
HTTP response codes
200
Request body payload
Attribute Description
ConnectionType The type of connection test to be performed:
  • 1: Test all
  • 2: Selection test
Connections List of connections ID's that will be verified. For a list of all IDs on the appliance, run /api/TroubleshootService/ApplianceConnections.
Timeout The timeout to be used during a appliance connection check (in seconds).
Retries The number of retries to consider during an appliance connection check.
Example request body to test all connections 
{
    "ConnectionType": 1,   
    "Timeout": 10,
    "Retries": 3
}
Example request body to test an individual connection(s): 
{
    "ConnectionType": 2,
    "Connections": [1, 2],
   "Timeout": 10,
    "Retries": 3
}

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\