Secure Connect Gateway REST API Guide

Secure connect gateway automates technical support for your Dell EMC server, storage, and networking devices. When a hardware issue is detected on a system, depending on the service plan, secure connect gateway may automatically create a support request with Dell technical support. When a hardware issue is detected, secure connect gateway automatically collects the system state information that is required for troubleshooting the issue. The collected telemetry helps technical support to provide you a proactive and personalized support experience. To experience these automated capabilities, you must add all the devices in secure connect gateway.

The following table describes the parameters that are used to manage devices:

Table 1. ParametersThe following table describes the parameters that are used to manage devices.

Parameter	Description
assetFamily	Family or generation of the device, for example, 12th generation PowerEdge servers
assetId	ID of the device that must be added or deleted
assetSubType	Sub type of a device, for example, Linux server, Windows server
assetType	Device type, for example, server, virtual machine
credAccountId	Unique key to identify a credential account
credProfileId	Unique key to identify a credential profile
discoveryOptions configureSNMP deepDiscovery enableMonitoring	Tasks that must be performed while discovering the devices, such as, configuring SNMP settings, perform deep discovery, and enable or disable monitoring for the device.
friendlyName	Optional name that is assigned to the device
groupId	ID of the device group to which the device is assigned. If the value is null, the device is assigned to the Default group.
hostAddress	IP address of the device
hostName	Hostname of the device
index	Page number
JOBID	ID that must be used to check the progress of the job
JOBNAME	Name of the job
limit	Total number of devices expected in the response
maintenanceMode	Current state of the maintenance mode enablement for the device
manufacturer	Manufacturer of the device
model	Device model
offset	Starting index of the result
serialNumber	Serial number of the device
serviceTag	Service Tag of the device
sortBy	Criteria used to sort the devices. Possible values are: assetId friendlyName model status
state	Current state of the device. Possible values are: ACTIVE STAGING
STATUS	Status of the job
status	Connectivity status of the device. Possible values are: SUCCESS FAILED WARNING
version	Firmware version installed on the device