REST API Guide – SupportAssist Enterprise Dell Engineering team September 2019 Dell EMC Technical White Paper
Revisions Revisions Date Description August 2018 Initial release October 2018 Updates to the Filter Devices section January 2019 Updates to the Retrieve Devices section September 2019 Support for TLS 1.2 The information in this publication is provided “as is.” Dell Inc. makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose.
Contents Contents Revisions.............................................................................................................................................................................2 Introduction .........................................................................................................................................................................5 1 2 Key Integration Concepts ..............................................................................................
Contents 2.6.5 Filter devices .....................................................................................................................................................40 2.7 Maintenance mode ...........................................................................................................................................44 2.7.1 Device maintenance mode ...............................................................................................................................44 2.7.
Introduction Introduction SupportAssist Enterprise is an application that automates technical support for your Dell EMC server, storage, and networking devices. SupportAssist Enterprise monitors your devices and proactively detects hardware issues that may occur. When a hardware issue is detected, SupportAssist Enterprise automatically opens a support case with Technical Support and sends you an email notification.
SupportAssist Enterprise 1 Key Integration Concepts This section covers key integration concepts that are applicable to all the use cases that are addressed in the next section. 1.1 Client Integration Overview The REST client makes standard HTTP(S) requests to the REST API end-point. Each request is sent using a HTTP verb (for example, PUT, GET, POST, and DELETE) and includes a message body in JSON format. The response uses a standard HTTP status code.
SupportAssist Enterprise 1.5 Resource Operations The standard HTTP methods are used for performing create, retrieve, update, and delete operations on resources. The mapping of the HTTP methods to operational semantics is described in the following table. HTTP method Description GET Used to retrieve the resource representation. This method does not modify the resource across repeated invocations. The query parameters are appended to the URI to appropriately filter the resource instances.
SupportAssist Enterprise 1.8 Response Codes For synchronous operations, the server returns HTTP response codes 200 or 204 depending on the request. For long-running operations, the server returns a status code of 202 along with a HTTP response header (Location), corresponding to the URI of the temporary resource that can be used to monitor the operation. The following table includes a few examples of response codes. For an extensive list of response codes, see List of HTTP status codes.
SupportAssist Enterprise 1.9 Response Headers The following table includes an example of response headers. For an extensive list of response headers, see List of HTTP header fields. 9 Response Header Description Example Content-Type Specifies the format of content that is returned by the server. If there are multiple formats that could be accepted in the client request (using the Accept header), the server chooses the appropriate supported format.
SupportAssist Enterprise 2 SupportAssist Enterprise-Specific Resource Model The following sub-sections represent a subset of the use cases that SupportAssist Enterprise supports. REST API support and the operation support will be incrementally refined based on consumer feedback over multiple SupportAssist Enterprise releases. Note: REST API resource URIs are case sensitive. 2.1 Enable REST in SupportAssist Enterprise You can enable or disable REST API in SupportAssist Enterprise.
SupportAssist Enterprise Response format (success – response code 200): { "authenticationToken":"", "refreshToken":"" } Description of parameters returned in the response body Parameter Description autheticationToken Token used for authentication and authorization of the request. refreshToken Token required for generating the authentication token. Note: The generated authentication token expires automatically after 30 minutes.
SupportAssist Enterprise 2.3 Account Credentials An Account Credential consists of the credentials of a specific device type. The Account Credentials is used by SupportAssist Enterprise discover a device and to collect system information. Depending on the number of device types in your environment, you may have to create one or more Account Credentials.
SupportAssist Enterprise } } } } } } } } Description of parameters in the JSON schema 13 Parameter Description Additional Details name Name that you want to assign to the Account Credentials. This attribute is required. uiDeviceType Type of device for which you want to This attribute is required. create Account Credentials. SupportAssist Enterprise supports 9 different device types. For the possible values for this parameter, see the JSON schema.
SupportAssist Enterprise Parameters required in the JSON request body based on the device type Parameters required 14 Device Type uiDeviceType deviceSubT deviceFamilyT ypeEnum ypeEnum protocolType Windows Server Server / Hypervisor Windows null WMI Linux Server Server / Hypervisor Linux null SSH ESX Server Server / Hypervisor ESX null SSH, VMWare ESXi Server Server / Hypervisor EXSi null SSH, VMWare iDRAC iDRAC Null null WSMAN Chassis Chassis Null null SSH, Redfish Network
SupportAssist Enterprise Credentials required in the JSON request body based on the protocol type Credentials Protocols Type Username Password enablepassword communityString WMI Required Required null null SSH Required Required Optional# null WSMAN Required Required null null HTTPS Required Required null null REST Required Required null null VMWare Required Required null null SNMP Null Null null Required Note: Enable password is required only if the networking device
SupportAssist Enterprise "id": , "name": "", "uiDeviceType": "Server / Hypervisor", "deviceSubTypeEnum":"Windows", "deviceFamilyTypeEnum": null, "protocols": [ { "protocolType": "WMI", "credential": { "username": "", "password": "", "communityString": "", "enablePassword": null, } } ] } The following is an example of a JSON for creating a credential account for a Solution device type.
SupportAssist Enterprise Response format (success – response code 201): { "id": , "name": "", "uiDeviceType": "Solution", "deviceSubTypeEnum":" Webscale", "deviceFamilyTypeEnum": null, "protocols": ": [ { "protocolType": "SSH", "credential": { "username": "", "password": "", "communityString": "", "enablePassword": null } }, { "protocolType": "REST" "credential": { "username": "", "password": "", "communityString
SupportAssist Enterprise "credential": { "communityString": "public" } } ] } Response format (success – response code 201): { "id”: , "name”: "", "uiDeviceType”: "Networking", "deviceSubTypeEnum”: null, "deviceFamilyTypeEnum”: null, "protocols”: ": [ { "protocolType": "SSH", "credential": { "username": "", "password": "", "communityString": "", "enablePassword": null } }, { "protocolType": "SNMP" "credential": { "communityS
SupportAssist Enterprise Request body: { "name":"", "uiDeviceType":"Server / Hypervisor", "deviceSubTypeEnum":"WINDOWS", "protocols":[ { "protocolType":"WMI", "credential":{ "username":"", "password":"", "enablePassword":null, "communityString":"" } } ] } Response format (success – response code 201): { "id":"", "name":"", "uiDeviceType":"Server / Hypervisor", "deviceSubTypeEnum":"WINDOWS", "deviceFamilyTypeEnum":null, "protocols":[ { "protocol
SupportAssist Enterprise Response format (success – response code 200): [ { "id":"", "name":"win_server1", "uiDeviceType":"Server / Hypervisor", "deviceSubTypeEnum":"WINDOWS", "deviceFamilyTypeEnum":null, "protocols":[ { "protocolType":"WMI", "credential":{ "username":"localhost\Administrator", "password":"YWJjX3Bhc3N3b3Jk", "enablePassword":null, "communityString":"" } } ] }, { "id":"", "name":"linux_server", "uiDeviceType":"Server / Hypervisor", "deviceSubTypeEnum":"LINUX", "deviceFamilyTy
SupportAssist Enterprise "enablePassword":null, "communityString":"" } } ] } ] 2.3.4 Retrieve Specific Account Credentials The following resource URI is used to retrieve a specific Account Credentials: https:///SupportAssist/api/v1/CredentialAccount/ Method: GET Headers: Authorization: Bearer The following is an example of a JSON for retrieving a specific Account Credentials.
SupportAssist Enterprise The following is an example of a JSON for deleting an Account Credentials. Request body: none required Response format (success – response code 204): none Note: Deleting all credential accounts in a single operation is not supported.
SupportAssist Enterprise 2.4 Credential Profile A Credential Profile is a collection of Account Credentials of various device types. Credential Profiles enable you to assign a set of credentials to your devices, instead of entering the credentials for each device manually.
SupportAssist Enterprise Headers: Content-Type: application/json Authorization: Bearer The following is an example of a JSON for creating a Credential Profile with the Account Credentials of servers running Windows.
SupportAssist Enterprise Headers: Content-Type: application/json Authorization: Bearer The following is an example of a JSON for editing a Credential Profile.
SupportAssist Enterprise 2.4.
SupportAssist Enterprise 2.5 Retrieve Job status The following resource URI is used to retrieve the status of asynchronous operations: https:///SupportAssist/api/v1/OperationStatus/ Note: The following are the types of Asynchronous operations: “add device”, “edit device”, “restore device and groups”, “assign profile”, “execute discovery rule”, and “collection”.
SupportAssist Enterprise 2.6 Devices SupportAssist Enterprise 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, SupportAssist Enterprise may automatically create a support request with Dell EMC Technical Support. Information required by Technical Support is also automatically collected and sent to Dell EMC by SupportAssist Enterprise.
SupportAssist Enterprise }, } } } } Parameters required for adding devices 29 Parameter Description deviceAddress IP address or host name of the device. friendlyName A name that you want to assign to the device. uiDeviceType Device type defined in the GUI. For the possible values for this parameter, see the JSON schema. deviceSubType Device sub type. For the possible values for this parameter, see the JSON schema. deviceFamily Device family, required mostly for the software device type.
SupportAssist Enterprise Parameters required in the JSON request body based on the device type Parameters required Device Type uiDeviceType deviceSubT deviceFamilyT ypeEnum ypeEnum Windows Server Server / Hypervisor null null Linux Server Server / Hypervisor null null ESX Server Server / Hypervisor null null EXSi Server Server / Hypervisor null null iDRAC iDRAC null null Chassis Chassis null null Networking Networking null null Fluid FS Fluid File System (Fluid FS) null nul
SupportAssist Enterprise The following is an example of a JSON for adding a device.
SupportAssist Enterprise The following is an example of a JSON for editing the device details.
SupportAssist Enterprise 2.6.
SupportAssist Enterprise "type" : "string" }, "buildNumber" : { "type" : "string" }, "patchLevel" : { "type" : "string" } } }, "softwareInformation" : { "type" : "object", "id" : "SoftwareInformation", "properties" : { "softwareVersion" : { "type" : "string" }, "studioVersion" : { "type" : "string" }, "studioBuildVersion" : { "type" : "string" }, "softwareHostName" : { "type" : "string" }, "architecture" : { "type" : "string" }, "databaseInstanceName" : { "type" : "string" }, "databaseServerName" : { "type"
SupportAssist Enterprise "credentialAccountId" : { "type" : "string" }, "credentialProfileId" : { "type" : "string" }, "useCredentialType" : { "type" : "string" }, "associatedConsoleId" : { "type" : "string" }, "deviceActiveStatus" : { "type" : "string" }, "deviceGroupInformation" : { "type" : "object", "id" : "DeviceGroupInformation", "properties" : { "orId" : { "type" : "string" }, "myGroupId" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "operations"
SupportAssist Enterprise "connectivityStatus" : { "type" : "object", "id" : "InventoryValidationOperationStatus", "properties" : { "status" : { "type" : "string" }, "errorCode" : { "type" : "string" }, "errorDescrition" : { "type" : "string" } } }, "collectionDependencyStatus" : { "type" : "object", "$ref" : "InventoryValidationOperationStatus" }, "monitoringStatus" : { "type" : "object", "$ref" : "InventoryValidationOperationStatus" }, "rollupStatus" : { "type" : "object", "$ref" : "InventoryValidationOper
SupportAssist Enterprise "format" : "utc-millisec" } } }, "collectionProgressStatus" : { "type" : "object", "id" : "CollectionProgressStatus", "properties" : { "progressStatus" : { "type" : "string" }, "progressValue" : { "type" : "integer" }, "collectionType" : { "type" : "string" }, "collectionId" : { "type" : "string" }, "shCanBut" : { "type" : "string" }, "multiDeviceColInProgress" : { "type" : "string" } } }, "deviceDiscoveredOn" : { "type" : "integer", "format" : "utc-millisec" } } } Parameters in the
SupportAssist Enterprise Parameter Description omsaVersion Version of OMSA installed on the device. ismVersion Version iSM installed on the device. credentialAccountId Unique Identifier of the Credential Account associated with the device. credentialProfileId Unique Identifier of the Credential Profile associated with the device. useCredentialType Identifies whether Credential Account or Credential Profile is assigned to the device.
SupportAssist Enterprise Parameters in the operations object Parameter Description installOMSA Defines whether SupportAssist Enterprise should install OMSA after the device is added successfully. The possible values are true or false. configureSNMP Defines whether SNMP settings of the device should be configured after the device is added successfully. The possible values are true or false. clearSELogs System Event Log status. monitoring Device monitoring status.
SupportAssist Enterprise 2.6.5 Filter devices The following resource URI is used to filter the device match search criteria: https:///SupportAssist/api/v1/Device Method: POST Headers: Content-Type: application/json Authorization: Bearer Response format (success – response code 200): Parameters for filtering devices Parameter Description serviceTag Service Tag of the devices. Name Friendly name of the device. Address IP address or host name of device.
SupportAssist Enterprise Parameters in the pagination object Parameter Description Additional Details Offset Number of entities to be skipped. If the offset is 10 and limit is 20, then 11-20 entities would be retrieved. Limit Number of entities to be retrieved. Maximum values would be 40 if more than 40 given then SupportAssist Enterprise would default it to 40 Total Total number of entities that match the search criteria. The total value is reported by SupportAssist Enterprise.
SupportAssist Enterprise Response format (success – response code 200): [ { "id":"",", "friendlyName":"192.168.151.65", "address":"192.168.151.
SupportAssist Enterprise "errorCode":"SA-9000", "errorDescrition":"" }, "monitoringStatus":{ "status":"WARNING", "errorCode":"SA-9000", "errorDescrition":"" }, "rollupStatus":{ "status":"FAILED", "errorCode":null, "errorDescrition":null }, "startTime":null, "lastValidatedon":1527085920138 }, "prioritizedStatus":{ "operationType":"REDISCOVER_DEVICE", "status":"ERROR", "statusCode":null, "statusMessage":"Unable to add device", "statusMessageDetails":"SupportAssist Enterprise is unable to add the device 192.
SupportAssist Enterprise 2.7 Maintenance mode The maintenance mode feature suspends the alert processing and automatic case creation capability of SupportAssist Enterprise, thereby preventing the creation of support cases during an alert storm or a planned maintenance activity. If an alert storm is received from a monitored device, SupportAssist Enterprise automatically places the device in maintenance mode.
SupportAssist Enterprise Headers: Content-Type: application/json Authorization: Bearer Response format (success – response code 204): none The resource URI to enable global maintenance mode is as follows: https:///SupportAssist/api/v1/Global/MaintenanceMode/enable The resource URI to disable global maintenance mode is as follows: https:///SupportAssist/api/v1/Global/MaintenanceMode/disable 45 REST API Guide – SupportAssist Enterprise
SupportAssist Enterprise 2.8 Assign Credential Profile to devices Assigning Credential Profile to devices is an asynchronous operation. Therefore, after the Credential Profile is assigned, the job details are available. You can check the status of the job using the operation status API.
SupportAssist Enterprise 2.9 Collection A collection contains the system information collected by SupportAssist Enterprise from a device. The collection is used by Technical Support to troubleshoot and provide a resolution to issues. You can perform a single or multiple device collection. Note: To collect system information from multiple devices, the purpose parameter is mandatory The following is the JSON schema for performing a single or multiple device collection.
SupportAssist Enterprise Parameter Description Additional Details caseId The support request number provided by the Dell EMC Technical support agent. This parameter is optional. uploadRequired Defines whether SupportAssist Enterprise should upload the collection after it is complete. The possible values are “true” or “false”. This parameter is optional for a single device collection. emailId Email address of the Dell EMC Technical support agent.
SupportAssist Enterprise After completion of the job, the status would be as follows: { "operationId": """, "operationType": "RunDiagnostics", "status": "COMPLETED", "additionalInfo": [ { "status": "TROUBLESHOOTING_UPLOADED", "progressPercentage": "100", "id": "" } ] } 49 REST API Guide – SupportAssist Enterprise
SupportAssist Enterprise 2.10 Discovery Rule A device discovery rule enables you to discover and add devices that are present within one or more IP address ranges. Creating a device discovery rule helps you add multiple devices, and reduces the effort involved in adding each device individually. 2.10.
SupportAssist Enterprise } } } }, "isRecurring" : { "type" : "boolean" }, "recurrCronString" : { "type" : "string" }, "uiDeviceType" : { "type" : "array", "items" : { "type" : "string" } }, "uiDeviceSubType" : { "type" : "array", "items" : { "type" : "string" } }, "ruleId" : { "type" : "string" }, "lastRunDate" : { "type" : "integer", "format" : "utc-millisec" }, "typeSelected" : { "type" : "string", "enum" : [ "RANGE", "DEVICES" ] }, "devices" : { "type" : "string" }, "recurring" : { "type" : "boolean" } }
SupportAssist Enterprise Parameters in the JSON schema Parameter Description Additional details id Identifier for the discovery rule. This parameter is required to run the discovery rule. ruleName Name of the discovery rule. credProfileId Identifier for the credential profile. deepDiscoveryEnabled Specifies whether deep discovery is to be performed. 52 enableMonitoring Specifies whether monitoring is to be enabled for the discovered devices.
SupportAssist Enterprise Response format (success – response code 200): [{ "id": "", "ruleName": "rule-import-devices", "credProfileId": "", "deepDiscoveryEnabled": true, "enableMonitoring": true, "installAgent": true, "configureSNMP": true, "runStatus": "NEVEREXECUTED", "range": [], "isRecurring": true, "recurrCronString": "1||Sunday||0||AM||Monthly", "uiDeviceType": ["PowerVault", "Software"], "uiDeviceSubType": ["SCVMM"], "ruleId": "", "lastRunDate": null, "typeSe
SupportAssist Enterprise 2.10.
SupportAssist Enterprise 2.11 Retrieve cases You can retrieve up to 40 support cases. While retrieving cases you can also filter the results based on certain criteria. Multiple filters can be applied by using the AND operation.
SupportAssist Enterprise } } } } } } Pagination and filtering parameters Parameter Description Additional details offset Number of cases to be skipped. This parameter is required. limit Total number of cases to be retrieved. This parameter is optional; Pagination parameters The maximum limit is 40. total Total number of support cases that matched the criteria. This field will be reported by SupportAssist Enterprise in the filter response.
SupportAssist Enterprise Parameter Description serviceContract Service Contract. For the possible values, see the JSON schema. source Source of the support request. For the possible values, see the JSON schema. Additional details The following is the JSON schema for the case object.
SupportAssist Enterprise Parameters in the JSON schema Parameter Description id Identifier assigned to the support request. title Title assigned to the support request. status Status of the support request. For the possible values, see the JSON schema. source Source of the support request. For the possible values, see the JSON schema. saDeviceId Associated device identifier. deviceName Name that has been assigned to the device. deviceType Type of device.
SupportAssist Enterprise ] } The following is an example of a JSON for retrieving cases for both server and networking device types. { "pagination": { "offset": 0, "limit": 40 }, "filters": [ { "operator": "IN", "field":"devicetype", "values":["server", "networking"] } ] } The following is an example of a JSON for retrieving cases for server and chassis where the case source is Email or SupportAssist.
SupportAssist Enterprise Response format: In this example, the total number of cases that matched the search criteria are 52. { "data":[ { "id":"915195604", "title":"Hardware (Other)", "status":"Open", "source":"Others", "saDeviceId":"", "deviceName":"VRTX", "deviceType":"Chassis", "serviceTag":"CAIN008", "caseCreationDate":1515661047000, "entitlementType":"Basic Support", "entitlementDescription":"Your device is covered under a current Dell Basic Hardware service contract.
SupportAssist Enterprise 2.12 Backup devices and groups You can create a backup of the devices that you have added and the device groups that you have created in SupportAssist Enterprise. Backing up the devices and device groups enables you to restore the devices and device group later, if necessary. The following is the JSON schema for the response: For more information about DeviceDiscovery Object, see the Add Device section.
SupportAssist Enterprise }, "name":{ "type":"string" }, "description":{ "type":"string" }, "noOfAssetsMapped":{ "type":"integer" }, "uiCustomerProfiles":{ "type":"array", "items":{ "type":"object", "id":"CustomerProfile", "properties":{ "customerProfileId":{ "type":"string" }, "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "emailId":{ "type":"string" }, "telephone":{ "type":"string" }, "country":{ "type":"string" }, "alternateTelephone":{ "type":"string" }, "emailLanguage":{ "type":"string
SupportAssist Enterprise "dispatchDetailsEnabled":{ "type":"boolean" }, "tdIntegrationEnabled":{ "type":"boolean" }, "uiShippingAddressDetails":{ "type":"object", "id":"ShippingAddressDetails", "properties":{ "shippingAddressId":{ "type":"string" }, "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "phone":{ "type":"string" }, "email":{ "type":"string" }, "preferredContactTimeZone":{ "type":"string" }, "preferredContactTimeFrame":{ "type":"string" }, "technicianRequired":{ "type":"boolean" },
SupportAssist Enterprise "zip":{ "type":"string" }, "address3":{ "type":"string" } } } } } } } } } } } The following resource URI is used to retrieve the devices and device groups: https:///SupportAssist/api/v1/Device/Export Method: GET Headers: Authorization: Bearer Response format (success – response code 200): [ { "deviceAddress": "", "friendlyName": "iDRAC", "uiDeviceType": "iDRAC", "deviceSubType": "IDRAC", "deviceFamily": "POWEREDGE14G", "credentia
SupportAssist Enterprise "profileType": "Primary", "preferredContactTimeFrame": "8AM-8PM", "preferredContactTimeZone": "(UTC+9:00) Asia/Jayapura", "preferredContactMethod": "email", "alias": false, "dispatchDetailsEnabled": false, "tdIntegrationEnabled": false, "uiShippingAddressDetails": null } ], "uiShippingAddressDetails": { "shippingAddressId": "#62:1", "firstName": "Raj", "lastName": "C", "phone": "1234567890", "email": "Raj@dell.
SupportAssist Enterprise "emailId": "Raj@dell.
SupportAssist Enterprise 2.13 Restore devices and groups You can restore devices and device groups by using the JSON response that was received while backing up your devices and device groups.
SupportAssist Enterprise }, "description":{ "type":"string" }, "noOfAssetsMapped":{ "type":"integer" }, "uiCustomerProfiles":{ "type":"array", "items":{ "type":"object", "id":"CustomerProfile", "properties":{ "customerProfileId":{ "type":"string" }, "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "emailId":{ "type":"string" }, "telephone":{ "type":"string" }, "country":{ "type":"string" }, "alternateTelephone":{ "type":"string" }, "emailLanguage":{ "type":"string" }, "company":{ "type":"str
SupportAssist Enterprise "tdIntegrationEnabled":{ "type":"boolean" }, "uiShippingAddressDetails":{ "type":"object", "id":"ShippingAddressDetails", "properties":{ "shippingAddressId":{ "type":"string" }, "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "phone":{ "type":"string" }, "email":{ "type":"string" }, "preferredContactTimeZone":{ "type":"string" }, "preferredContactTimeFrame":{ "type":"string" }, "technicianRequired":{ "type":"boolean" }, "dispatchNotes":{ "type":"string" }, "state":{
SupportAssist Enterprise "address3":{ "type":"string" } } } } } } } } } } } The following resource URI is used to restore devices and device groups: https:///SupportAssist/api/v1/Device/Import Method: POST Headers: Content-Type: application/json Authorization: Bearer The following is an example of a JSON for restoring devices and the device groups. In this example, you must enter the credentialAccountId or credentialProfileId.
SupportAssist Enterprise "company": "One", "profileType": "Primary", "preferredContactTimeFrame": "8AM-8PM", "preferredContactTimeZone": "(UTC+9:00) Asia/Jayapura", "preferredContactMethod": "email", "alias": false, "dispatchDetailsEnabled": false, "tdIntegrationEnabled": false, "uiShippingAddressDetails": null } ], "uiShippingAddressDetails": { "shippingAddressId": "#62:1", "firstName": "Raj", "lastName": "C", "phone": "1234567890", "email": "Raj@dell.
SupportAssist Enterprise "lastName": "C", "emailId": "Raj@dell.
SupportAssist Enterprise "operationType": "ImportDevice", "status": "COMPLETED", "additionalInfo": [ { "errorCode": "SA-90100", "message": "Operation successful.", "additionalInfo": "" }, { "errorCode": "SA-90100", "message": "Operation successful.", "additionalInfo": "" }, { "errorCode": "SA-90100", "message": "Operation successful.", "additionalInfo": "" }, { "errorCode": "SA-90100", "message": "Operation successful.
SupportAssist Enterprise A Error code appendix Error code 74 Error message Possible Resolution SA-0001 SupportAssist Enterprise is unable to add the devices because an device count is more than 5000. Make sure that the device count in the csv file is less than 5000. SA-0002 SupportAssist Enterprise is unable to add the devices because the csv file is Empty. Make sure that both the system running SupportAssist Enterprise and the file is not Empty.
SupportAssist Enterprise Error code Error message Possible Resolution dell.com/serviceabilitytools. 2. Ensure that the user account has administrator/root privileges. 75 SA-0020 SupportAssist Enterprise is unable to add the device {0} because the device is already added. Ensure that the device is not added using another IP address or Service Tag. SA-0025 SupportAssist Enterprise is unable to add the device {0} because of an unknown error. Verify the following and then retry adding the device: 1.
SupportAssist Enterprise Error code Error message Possible Resolution Installing OMSA is required to generate alerts for hardware events that occur on the device. 76 SA-0080 SupportAssist Enterprise has detected that the Dell OpenManage Server Administrator (OMSA) services are not running on the device. For optimal SupportAssist Enterprise capability, it is recommended to restart the OMSA services.
SupportAssist Enterprise Error code 77 Error message Possible Resolution SA-0125 SupportAssist Enterprise is unable to add the device {0} because a response was not received within the predefined time limit. Retry the operation, if possible. For additional troubleshooting information, see the SupportAssist Enterprise User's Guide at dell.com/serviceabilitytools.
SupportAssist Enterprise Error code 78 Error message Possible Resolution SA-0175 The hostname/IP address {0} that you have Ensure that you add the device with the host entered is a Web-Scale Cluster VM IP name/IP address of Web-Scale Cluster. address. It is recommended that you add the device by using the host name/IP address {1} of the Web-Scale Cluster. SA-0165 SupportAssist Enterprise is unable to add the device {0} because an attempt to connect to the device was unsuccessful.
SupportAssist Enterprise Error code 79 Error message Possible Resolution attempt to connect to the device was unsuccessful. correct device credentials. 3.If the problem persists, contact your SupportAssist Enterprise administrator for assistance. SA-30130 SupportAssist Enterprise has placed the device {0} in the Staging group because a required verification could not be completed. Retry the operation, if possible.
SupportAssist Enterprise 80 Error code Error message SA-90120 Invalid device type {0}. SA-90121 Invalid entitlement type {0}. SA-90122 Invalid case source {0}. SA-90123 Invalid group name {0}. SA-90124 Invalid model {0}. SA-90125 Invalid os {0}. SA-90126 Invalid device source {0}. SA-90127 Invalid remote collector IP address or hostname or friendly name {0}. SA-90128 Allowed method(s) are {0}. SA-90129 Invalid device inventory validation status {0}.
SupportAssist Enterprise Error code 81 Error message Possible Resolution SA-90410 Unable to delete device either does not exist or device are busy with some other operation or it is not allowed to delete console device. SA-90411 Device id is invalid or empty. SA-90412 Invalid URL. SA-90413 Unable to perform operation as either device is busy or device does not support maintenance mode or device is not active. SA-90414 Profile id is invalid or empty.
SupportAssist Enterprise Error code Error message Possible Resolution persists, contact your SupportAssist Enterprise administrator for assistance. 82 3000_4 An unexpected error occurred during the installation of Dell OpenManage Server Administrator (OMSA) on {0}. Manually install the supported version of OMSA. To identify the supported version of OMSA, see the SupportAssist Enterprise Support Matrix at Dell.com/serviceabilitytools.
SupportAssist Enterprise Error code 83 Error message Possible Resolution 3000_12 An unexpected error occurred during the installation of Dell OpenManage Server Administrator (OMSA) on {0}. Manually install the supported version of OMSA. To identify the supported version of OMSA, see the SupportAssist Enterprise Support Matrix at Dell.com/serviceabilitytools. If the problem persists, contact your SupportAssist Enterprise administrator for assistance.
SupportAssist Enterprise Error code 84 Error message Possible Resolution 3000_18 A service required for the installation of Dell If the device is running Microsoft Windows, make OpenManage Server Administrator (OMSA) sure that the WMI service is running. If the is either not running or not enabled on {0}. device is running Linux, make sure that SSH is enabled. For more information, see the "Error code appendix" section in the SupportAssist Enterprise User's Guide at Dell.com/serviceabilitytools.
SupportAssist Enterprise Error code 85 Error message Possible Resolution 3000_25 An unexpected error occurred during the installation of Dell OpenManage Server Administrator (OMSA) on {0}. Manually install the supported version of OMSA. To identify the supported version of OMSA, see the SupportAssist Enterprise Support Matrix at Dell.com/serviceabilitytools. If the problem persists, contact your SupportAssist Enterprise administrator for assistance.
SupportAssist Enterprise Error code Error message Possible Resolution persists, contact your SupportAssist Enterprise administrator for assistance. 86 3000_33 An unexpected error occurred during the installation of Dell OpenManage Server Administrator (OMSA) on {0}. Manually install the supported version of OMSA. To identify the supported version of OMSA, see the SupportAssist Enterprise Support Matrix at Dell.com/serviceabilitytools.
SupportAssist Enterprise Error code Error message Possible Resolution persists, contact your SupportAssist Enterprise administrator for assistance. 87 3000_41 An unexpected error occurred during the installation of Dell OpenManage Server Administrator (OMSA) on {0}. Manually install the supported version of OMSA. To identify the supported version of OMSA, see the SupportAssist Enterprise Support Matrix at Dell.com/serviceabilitytools.
SupportAssist Enterprise Error code 88 Error message Possible Resolution 3000_48 An unexpected error occurred during the installation of Dell OpenManage Server Administrator (OMSA) on {0}. Make sure that the device is reachable and the configured device credentials have Administrator rights, and then manually install the supported version of OMSA. To identify the supported version of OMSA, see the SupportAssist Enterprise Support Matrix at Dell.com/serviceabilitytools.
SupportAssist Enterprise Error code Error message Possible Resolution persists, contact your SupportAssist Enterprise administrator for assistance. 89 3000_55 An unexpected error occurred during the installation of Dell OpenManage Server Administrator (OMSA) on {0}. Manually install the supported version of OMSA. To identify the supported version of OMSA, see the SupportAssist Enterprise Support Matrix at Dell.com/serviceabilitytools.
SupportAssist Enterprise Error code Error message Possible Resolution Enterprise Support Matrix at Dell.com/serviceabilitytools. If the problem persists, contact your SupportAssist Enterprise administrator for assistance. 90 3000_62 The time allowed for OMSA installation has expired. Manually install the supported version of OMSA. To identify the supported version of OMSA, see the SupportAssist Enterprise Support Matrix at Dell.com/serviceabilitytools.
SupportAssist Enterprise Error code 91 Error message Possible Resolution 6000_11 System Event Log could not be cleared from device {0} because of a technical error. Retry the operation, if possible or contact your SupportAssist Enterprise administrator for assistance. 6000_12 System Event Log could not be cleared from device {0} because of a technical error. Retry the operation, if possible or contact your SupportAssist Enterprise administrator for assistance.
SupportAssist Enterprise Error code 92 Error message Possible Resolution 6000_23 SupportAssist Enterprise is unable to collect system information from the device {0} because the credentials of the device are either incorrect or do not have the required privileges. Perform the following and retry the operation: 1. Make sure that SupportAssist Enterprise is updated with the correct user name and password of the device. 2. Make sure that the user account has administrative privileges on the device.
SupportAssist Enterprise Error code Error message Possible Resolution in the SupportAssist Enterprise User's Guide at Dell.com/serviceabilitytools. 93 5000_8 SNMP settings of the device could not be Manually configure the SNMP settings. For configured because of an unexpected error. instructions to manually configure the SNMP settings, see "Configuring the alert (SNMP trap) destination" in the SupportAssist Enterprise User's Guide at Dell.com/serviceabilitytools.
SupportAssist Enterprise B Frequently asked questions Question 1: How to add a device? To add a device: 1. Create a credential account. For details see, see Create Account Credentials. A credential account will be created and the details of the account will be present in the response body. 2. Note the credential account id from the response body and add a device. For details, see Add device. An operation id will be present in the response body. 3.
SupportAssist Enterprise • • • • • 95 PeerStorage(PS) / Equallogic Fluid File System (Fluid FS) Software Solution Virtual Machine REST API Guide – SupportAssist Enterprise
SupportAssist Enterprise C 96 Glossary Term Meaning REST Representational State Transfer RO Resource Oriented ROA Resource Oriented Architecture REST API Guide – SupportAssist Enterprise
