Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Enjoy members-only rewards and discounts
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Dell Financial Services Premier Sign In Partner Program Sign In
Contact Us

Your Dell.com Carts

Secure Connect Gateway REST API Guide

PDF

Telemetry collections

By default, secure connect gateway collects and sends device telemetry from all the devices, irrespective of their service contract at periodic intervals. It also collects telemetry automatically from a device when a support case is created for an issue with the device. You can also initiate a collection from one or more devices. The telemetry that is collected includes the following information:

  • Hardware and software inventory—installed devices, processors, memory, network devices, usage, and Service Tag
  • Software configuration for servers—operating system and installed applications
  • Configuration information—interfaces, VLAN, Data Center Bridging (DCB), spanning tree, and stacking
  • Identity information—system name, domain name, and IP address
  • Event data—Windows event logs, core dump, and debug logs

The following identity information is also collected as part of the telemetry:

  • Host name
  • IP address
  • Subnet mask
  • Default gateway
  • MAC address
  • DHCP server
  • DNS server
  • Processes
  • Environment variables
  • Registry
  • Logs
  • iSCSI data
  • Fibre Channel data—host World Wide Name (WWN) and port WWN

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

Table 1. ParametersThe following table describes the parameters that are used to manage telemetry collections.
Parameter Description
assetId Identifier of the device on which collection is initiated.
canDownload Specifies if the option to download the collection must be enabled.
canUpload Specifies if the option to upload a collection must be enabled.
canView Specifies if the option to view the collection must be enabled for the device.
caseNumber Support case number associated with the collection.
collectionAge Number of days since the collection was performed.
collectionDate Date on which the collection was completed.
collectionId Identifier that is assigned to the collection
collectionName Name of the collection
collectionPurpose Purpose for which the collection is performed. Possible values are:
  • technicalSupport
  • deployment
  • systemMaintenance
  • consulting
  • others
collectionStatus Status of the collection performed. Possible values are:
  • COLLECTION_INITIATED
  • COLLECTION_IN_PROGRESS
  • COLLECTION_COMPLETED
  • COLLECTION_COMPLETED_WITH_WARNINGS
  • COLLECTION_COMPLETED_PARTIALLY
  • COLLECTION_EXECUTION_FAILED
  • COLLECTION_CANCEL_INITIATED
  • COLLECTION_CANCEL_IN_PROGRESS
  • COLLECTION_CANCELLED
  • COLLECTION_ABORTED
collectionType Type of collection. Possible values are:
  • manual
  • periodic
  • alertBased
completedDevices Number of devices for which collection is completed.
DateAndTime Date and time when the log was created.
Description Log description
emailId Email address of the technician
endDate Date on which the collection was completed.
fileDetails Path of the collection that must be downloaded
hostname Hostname or IP address of the device on which the collection is performed.
index Page number
jobId Identifier that is assigned to the collection job
limit Total number of logs to be retrieved
offset Number of collections to be skipped
orderBy Value by which the logs must be sequenced.
progressPercentage Percentage of collection performed
projectId Project ID used during deployment
purpose Purpose for which the collection is performed.
RawSELData System event log data
reportPath Relative path of the collection report file
serviceTag Service Tag of the device on which the collection is performed.
Severity Severity of the log entry
sortBy Value by which the collections must be sorted. Possible values are:
  • collectionDate
  • purpose
  • caseNumber
  • uploadStatus
  • collectionName
startDate Date on which the collection was initiated.
total Total number of logs that matched the criteria
totalDevices Total number of devices on which the analytic collection must be performed.
uploadDate Date and time when the collection was uploaded to the backend.
uploadErrorCode Error code associated with the issue that occurred while uploading the collection
uploadRequired Specifies if the collection must be automatically uploaded to the backend after it is performed.
uploadStatus Upload status of the collection. Possible values are:
  • COLLECTION_UPLOAD_NOT_APPLICABLE
  • COLLECTION_UPLOAD_NOT_INITIATED
  • COLLECTION_UPLOAD_IN_PROGRESS
  • COLLECTION_UPLOAD_COMPLETED
  • COLLECTION_UPLOAD_FAILED

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: <>()\