Skip to main content

GET /discoverRequest/jobs/{job_id}

Use this method to monitor the status of a discovery request.

Authentication

Authentication with username and password is required.

Request URL

GET https://{management_server_IP}/discoverRequest/jobs/{job_id}

where {job_id} is the job ID that was returned by the POST /discoverRequest method.

Query parameters

None

Request body

None

Response codes

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
403ForbiddenThe orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
409ConflictThere is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body

AttributesTypeDescription
progressDoublePercentage complete of the discovery job. This can be one of the following values.
  • 0.0. Created.
  • > 0.0. In progress.
  • 100.0. Complete.
resultIntegerResult of the job. This can be one of the following values.
  • 0. Created.
  • 50. In progress.
  • 100. Complete.
chassisListArray of objectsInformation about each chassis that was discovered
 cmmDisplayNameStringChassis name that is provided by the CMM
 cmmsArray of objectsInformation about the CMMs in the chassis
  cmmDisplayNameStringName of the CMM
  firmwareArray of objectsInformation about the CMM firmware
   buildStringFirmware build
   dateStringFirmware date
   nameStringFirmware name
   typeStringFirmware type
  nameStringHostname of the CMM
  serialNumberStringSerial number of the CMM
  slotsArray of integersBay in the chassis where the CMM is installed
  typeStringResource type. This value is always CMM.
  uuidStringUUID of the CMM
 displayNameStringChassis name that is defined by the user
 fruNumberStringFRU part number for the chassis
 hostnameStringHostname of the chassis
 ipAddressesArray of stringsAll IPv4 and IPv6 addresses for the chassis
 machineTypeStringChassis machine type
 managementPortsArray of objectsList of management ports in the chassis
  enabledBooleanIndicates whether the port enabled. This can be one of the following values.
  • true. The port is enabled.
  • false. The port is disabled.
  portIntegerPort number
  protocolStringProtocol that is running on the port (for example, http, https, or snmpv3)
 modelStringChassis model
 nameStringChassis name
 securityDescriptorObjectInformation about the authentication enablement and support the associated stored credentials for a managed device
  managedAuthEnabledBooleanIndicates whether the device uses managed authentication. This can be one of the following values.
  • true. The device uses managed authentication.

  • false. The device uses local authentication.

  managedAuthSupportedBooleanIndicates whether the device supports the ability to choose whether managed authentication is to be used. This can be one of the following values.
  • true. This device supports managed authentication.

  • false. This device does not support managed authentication.

  roleGroupsArray of stringsList of role groups that are permitted to view and manage this device
  publicAccessStringIndicates whether the resource can be accessed by all role groups. This can be one of the following values.
  • true. The resource is can be access by all role group.

  • false. The resource is restricted to specific role groups.

  storedCredentialsObjectInformation about the stored credential that is associated with this device, if applicable
   descriptionStringDescription of the stored credential
   idStringID of the stored credential
  uriStringChassis URI
 serialNumberStringSerial number for the chassis
 statusArrayCurrent status of the chassis
  messageStringMessage
  nameStringName
 typeStringResource type. This value is always Chassis.
 uuidStringUUID for the chassis
rackswitchListArray of objectsList of all top-of-rack switches that were discovered
 displayNameStringName of the top-of-rack switch
 firmwareArrayA list of firmware on the top-of-rack switch
  buildStringBuild level
  dateStringDate
  versionStringBuild version
 fruNumberStringFRU number
 hostnameStringHostname of the top-of-rack switch
 ipAddressesArray of StringsAll IPv4 and IPv6 addresses for the top-of-rack switch
 machineTypeStringMachine type of the top-of-rack switch
 managementPortsArray of objectsList of management ports in the top-of-rack switch
  enabledBooleanIndicates if the port is enabled. This can be one of the following values.
  • true. The port is enabled.
  • false. The port is not enabled.
  portIntegerPort number
  protocolStringProtocol running on the port (for example, http, https, or snmpv3)
 modelStringModel of the top-of-rack switch
 nameStringName of the top-of-rack switch
 osStringOperating system. This can be one of the following values.
  • CNOS
  • ENOS
 securityDescriptorObjectInformation about the authentication enablement and support the associated stored credentials for a managed device
  managedAuthEnabledBooleanIndicates whether the device uses managed authentication. This can be one of the following values.
  • true. The device uses managed authentication.

  • false. The device uses local authentication.

  managedAuthSupportedBooleanIndicates whether the device supports the ability to choose whether managed authentication is to be used. This can be one of the following values.
  • true. This device supports the ability to choose managed authentication.

  • false. This device does not support the ability to choose managed authentication.

  roleGroupsArray of stringsList of role groups that are permitted to view and manage this device
  publicAccessStringIndicates whether the resource can be accessed by all role groups. This can be one of the following values.
  • true. The resource is can be access by all role group.

  • false. The resource is restricted to specific role groups.

  storedCredentialsObjectInformation about the stored credential that is associated with this device, if applicable
   descriptionStringDescription of the stored credential
   idStringID of the stored credential
  uriStringServer URI
 serialNumberStringSerial number for the top-of-rack switch
 statusObjectCurrent status
  manageableBooleanIndicates whether the top-of-rack switch is manageable. This can be one of the following values.
  • true. The switch is manageable.
  • false. The switch is not manageable.
  messageStringMessage
  nameStringName
 typeStringResource type. This value is always Rackswitch.
 uuidStringUUID of the top-of-rack switch
serverListArrayList of all rack and tower servers that were discovered
 displayNameStringName of the rack or tower server
 enclosureFormFactor (IMM, IMM2, XCC, or XCC2 only) Form factor of the chassis. This can be one of the following values.
  • dense-computing
  • edge-computing
  • rack-tower
 firmwareArray of objectsList of firmware on the rack or tower server
  buildStringBuild level
  dateStringDate
  versionStringBuild version
 fruNumberStringFRU number
 hostnameStringHostname of the rack or tower server
 ipAddressesArray of StringsAll IPv4 and IPv6 addresses for the rack or tower server
 machineTypeStringMachine type of the rack or tower server
 managementProcessorStringThe type of management controller. This can be one of the following values.
  • integrated-management-module
  • integrated-management-module2
  • lenovo-xclarity-controller
  • chassis-management-module
 managementPortsArray of objectsList of management ports in the rack or tower server
  enabledBooleanIndicates if the port is enabled. One of the following values can be returned:
  • true. The port is enabled.
  • false. The port is not enabled.
  portIntegerPort number
  protocolStringProtocol running on the port (for example, http, https, or snmpv3)
 modelStringModel of the rack or tower server
 nameStringName of the rack or tower server
 securityDescriptorObjectInformation about the authentication enablement and support the associated stored credentials for a managed device
  managedAuthEnabledBooleanIndicates whether the device uses managed authentication. This can be one of the following values.
  • true. The device uses managed authentication.

  • false. The device uses local authentication.

  managedAuthSupportedBooleanIndicates whether the device supports the ability to choose whether managed authentication is to be used. This can be one of the following values.
  • true. This device supports the ability to choose managed authentication.

  • false. This device does not support the ability to choose managed authentication.

  roleGroupsArray of stringsList of role groups that are permitted to view and manage this device
  publicAccessStringIndicates whether the resource can be accessed by all role groups. This can be one of the following values.
  • true. The resource is can be access by all role group.

  • false. The resource is restricted to specific role groups.

  storedCredentialsObjectInformation about the stored credential that is associated with this device, if applicable
   descriptionStringDescription of the stored credential
   idStringID of the stored credential
  uriStringServer URI
 serialNumberStringSerial number for the rack or tower server
 statusObjectCurrent status
  manageableBooleanIndicates whether the rack or tower server is manageable. One of the following values can be returned.
  • true. The port is enabled.
  • false. The port is not enabled.
  messageStringMessage
  nameStringName
 subTypeString 
 typeStringServer type. This can be one of the following values.
  • Edge Server. ThinkSystem SE server

  • Rack-Tower Server. Converged, NeXtScale, System x or ThinkSystem SD, SR, or ST server

  • Lenovo ThinkServer. ThinkServer server

 uuidStringUUID of the rack and tower server
storageListArray of objectsInformation about each storage device that was discovered
 displayNameStringName of the storage device
 hostnameStringHostname of the storage device
 ipAddressesArray of stringsAll IPv4 and IPv6 addresses for the storage device
 firmwareArray of objectsList of firmware on the storage device
  buildStringBuild level
  dateStringDate
  versionStringBuild version
 fruNumberStringFRU number
 machineTypeStringMachine type of the storage device
 managementPortsArray of objectsList of management ports in the storage device
  enabledBooleanIndicates if the port is enabled. One of the following values can be returned.
  • true. The port is enabled.
  • false. The port is not enabled.
  portIntegerPort number
  protocolStringProtocol running on the port (for example, http, https, or snmpv3)
 modelStringModel of the storage device
 nameStringName of the storage device
 serialNumberStringSerial number for the storage device
 statusObjectCurrent status
  manageableBooleanIndicates whether the storage device is manageable. This can be one of the following values.
  • true. The storage device is manageable.
  • false. The storage device is not manageable.
  nameStringName
 typeStringResource type. This can be one of the following values.
  • Lenovo Storage
  • IBM Tape
 uuidStringUUID of the storage device
 wwnnStringWWNN of the storage device
xhmcListArrayInformation about each XClarity Administrator management server that was discovered
 hostnameStringHostname of the XClarity Administrator management server
 ipAddressesArray of stringsAll IPv4 and IPv6 addresses for the management server
 managementPortsArray of objectsList of management ports in the top-of-rack switch
  enabledBooleanIndicates if the port is enabled. This can be one of the following values.
  • true. The port is enabled.
  • false. The port is not enabled.
  portIntegerPort number
  protocolStringProtocol running on the port (for example, http, https, or snmpv3)
 nameStringName of the management server
 softwareArray of objectsInformation about the XClarity Administrator version
  versionStringVersion of XClarity Administrator that is installed
 statusObjectCurrent status
  manageableBooleanIndicates whether the management server is manageable. This can be one of the following values.
  • true. The management server is manageable.
  • false. The management server is not manageable.
  manager-uuidStringUUID of the management server
 typeStringResource type This value is always Domain Manager.
 uuidStringUUID of the management server
The following example is returned if the request is successful for a chassis.
{
"progress": 100,
"result": 100,
"chassisList": [{
"cmmDisplayName": "chassis-2",
"cmms": [{
"cmmDisplayName": "chassis-2",
"firmware": [{
"build": "1AON18B",
"date": "2017-10-24",
"name": "CMM Firmware",
"type": "CMM Firmware"
}],
"name": "chassis-2",
"serialNumber": "Y011BG78J093",
"slots": [1],
"type": "CMM",
"uuid": "3d316351852111e78e4fbed8acb88dcf"
}],
"displayName": "chassis-2",
"fruNumber": "81Y2893",
"hostname": "chassis-2",
"ipAddresses": ["10.240.60.50", "fe80::2e0:ecff:fe43:2c8b", "fe80::2e0:ecff:fe43:2c8c",
"fd55:faaf:e1ab:210f:2e0:ecff:fe43:2c8b"],
"machineType": "7893",
"managementPorts": [{
"enabled": false,
"port": 80,
"protocol": "http"
},
...,
{
"enabled": true,
"port": 161,
"protocol": "snmpv3"
}],
"model": "92X",
"name": "chassis-2",
"securityDescriptor": {
"managedAuthEnabled": false,
"managedAuthSupported": false,
"publicAccess": false,
"roleGroups": [],
"uri": "chassis/5422200a92d34460b5c34c86f1d9ca9c"
},
"serialNumber": "100B2AA",
"status": {
"message": "Unmanaged",
"name": "UNMANAGED"
},
"type": "Chassis",
"uuid": "5422200a92d34460b5c34c86f1d9ca9c"
}],
"rackswitchList": [],
"serverList": [],
"storageList": [],
"xhmcList": []
}]
The following example is returned if the request is successful for a ThinkServer server.
[{
"progress": 100.0,
"result": 100,
"chassisList": [],
"rackswitchList": [],
"serverList": [{
"displayName": "n6",
"enclosureFormFactor": "rack-tower",
"firmware": [{
"build": "TCOO24A",
"date": "2016/08/29",
"version": "3.50"
},
{
"build": "TBE126Q",
"date": "2016/11/18",
"version": "2.21"
}],
"fruNumber": "01KN187 ",
"hostname": "cximmnode6",
"ipAddresses": ["10.240.62.156", "fdea:14a7:304b:40::3:6",
"fd55:faaf:e1ab:210f:a94:efff:fe38:f5a1", "fe80::a94:efff:fe38:f5a1"],
"machineType": "8869",
"managementProcessor": "integrated-management-module2",
"managementPorts": [{
"enabled": true,
"port": 5988,
"protocol": "cimxml-http"
},
...,
{
"enabled": true,
"port": 623,
"protocol": "rmcp"
}],
"model": "ACA",
"name": "n6",
"securityDescriptor": {
"managedAuthEnabled": true,
"managedAuthSupported": true,
"publicAccess": false,
"roleGroups": [],
"uri": "nodes/0d5d0374dd3511e6b1e20894ef38f59c"
},
"serialNumber": "J1192GG",
"server-type": "Rack-Tower Server",
"status": {
"manageable": true,
"message": "Unmanaged",
"name": "UNMANAGED"
},
"subType": "",
"type": "Rack-Tower Server",
"uuid": "0d5d0374dd3511e6b1e20894ef38f59c"
}],
"storageList": [],
"xhmcList": []
}]
The following example is returned if the request is successful for a rack switch.
[{
"progress": 100.0,
"result": 100,
"chassisList": [],
"rackswitchList": [{
"displayName": "lci-medium-10g-sw01",
"firmware": [{
"date": null,
"build": "Level 1.0",
"version": "1.0"
}],
"fruNumber": null,
"hostname": "lci-medium-10g-sw01",
"ipAddresses": ["10.240.62.159", "fdea:14a7:304b:40:0:0:4:3"],
"machineType": "7159",
"managementPorts": [{
"enabled": false,
"port": 443,
"protocol": "https"
},
{
"enabled": true,
"port": 80,
"protocol": "http"
}],
"model": "HCD (G8272)",
"name": "lci-medium-10g-sw01",
"os": "ENOS",
"securityDescriptor": {
"managedAuthEnabled": false,
"managedAuthSupported": false,
"roleGroups": [],
"publicAccess": false,
"uri": "switches/5C2719BC02553v5E885460D41B2E217CF"
},
"serialNumber": "Y05JJ11192MY",
"status": {
"manageable": true,
"name": "UNMANAGED"
},
"type": "Rackswitch",
"uuid": "5C2719BC025535E885460D41B2E217CF",
}],
"serverList": [],
"storageList": [],
"xhmcList": []
}]