GET /discoverRequest/jobs/<job_id>

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

Authentication

Authentication with user name 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

Code Description
200 OK
400 Bad request
403 Forbidden
404 Not found
409 Conflict
500 Internal server error

Response body

Attributes Type Description
progress Double Percentage complete of the discovery job. This can be one of the following values.
  • 0.0. Created.
  • > 0.0. In progress.
  • 100.0. Complete.
result Integer Result of the job. This can be one of the following values.
  • 0. Created.
  • 50. In progress.
  • 100. Complete.
chassisList Array of objects Information about each chassis that was discovered
  cmmDisplayName String Chassis name that is provided by the CMM
  cmms Array of objects Information about the CMMs in the chassis
    cmmDisplayName String Name of the CMM
    firmware Array of objects Information about the CMM firmware
      build String Firmware build
      date String Firmware date
      name String Firmware name
      type String Firmware type
    name String Hostname of the CMM
    serialNumber String Serial number of the CMM
    slots Array of integers Bay in the chassis where the CMM is installed
    type String Resource type. This value is always "CMM.".
    uuid String UUID of the CMM
  displayName String Chassis name that is defined by the user
  fruNumber String FRU part number for the chassis
  hostname String Hostname of the chassis
  ipAddresses Array of strings All IPv4 and IPv6 addresses for the chassis
  machineType String Chassis machine type
  managementPorts Array of objects List of management ports in the chassis
    enabled Boolean Indicates whether the port enabled. This can be one of the following values.
  • true. The port is enabled.
  • false. The port is disabled.
    port Integer Port number
    protocol String Protocol that is running on the port (for example, http, https, or snmpv3)
  model String Chassis model
  name String Chassis name
  securityDescriptor Object Information about the authentication enablement and support the associated stored credentials for a managed device
    managedAuthEnabled Boolean Indicates 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.

    managedAuthSupported Boolean Indicates 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

    roleGroups Array of strings List of role groups that are permitted to view and manage this device
    publicAccess String Indicates 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.

    storedCredentials Object Information about the stored credential that is associated with this device, if applicable
      description String Description of the stored credential
      id String ID of the stored credential
    uri String Chassis URI
  serialNumber String Serial number for the chassis
  status Array Ccurrent status of the chassis
    message String Message
    name String Name
  type String Resource type. This value is always "Chassis."
  uuid String UUID for the chassis
rackswitchList Array of objects List of all top-of-rack switches that were discovered
  displayName String Name of the top-of-rack switch
  firmware Array A list of firmware on the top-of-rack switch
    build String Build level
    date String Date
    version String Build version
  fruNumber String FRU number
  hostname String Hostname of the top-of-rack switch
  ipAddresses Array of Strings All IPv4 and IPv6 addresses for the top-of-rack switch
  machineType String Machine type of the top-of-rack switch
  managementPorts Array of objects List of management ports in the top-of-rack switch
    enabled Boolean Indicates if the port is enabled. This can be one of the following values.
  • true. The port is enabled.
  • false. The port is not enabled.
    port Integer Port number
    protocol String Protocol running on the port (for example, http, https, or snmpv3)
  model String Model of the top-of-rack switch
  name String Name of the top-of-rack switch
  os String Operating system. This can be one of the following values.
  • CNOS
  • ENOS
  securityDescriptor Object Information about the authentication enablement and support the associated stored credentials for a managed device
    managedAuthEnabled Boolean Indicates 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.

    managedAuthSupported Boolean Indicates 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.

    roleGroups Array of strings List of role groups that are permitted to view and manage this device
    publicAccess String Indicates 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.

    storedCredentials Object Information about the stored credential that is associated with this device, if applicable
      description String Description of the stored credential
      id String ID of the stored credential
    uri String Server URI
  serialNumber String Serial number for the top-of-rack switch
  status Object Current status
    manageable Boolean Indicates 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.
    message String Message
    name String Name
  type String Resource type. This value is always "Rackswitch."
  uuid String UUID of the top-of-rack switch
serverList Array List of all rack and tower servers that were discovered
  displayName String Name of the rack or tower server
  enclosureFormFactor   (IMM, IMM2, and XCC only) Form factor of the chassis. This can be one of the following values.
  • dense-computing

  • edge-computing

  • rack-tower

  firmware Array of objects List of firmware on the rack or tower server
    build String Build level
    date String Date
    version String Build version
  fruNumber String FRU number
  hostname String Hostname of the rack or tower server
  ipAddresses Array of Strings All IPv4 and IPv6 addresses for the rack or tower server
  machineType String Machine type of the rack or tower server
  managementProcessor String The type of management controller. This can be one of the following values.
  • integrated-management-module

  • integrated-management-module2

  • lenovo-xclarity-controller

  • chassis-management-module

  managementPorts Array of objects List of management ports in the rack or tower server
    enabled Boolean Indicates if the port is enabled. One of the following values can be returned:
  • true. The port is enabled.
  • false. The port is not enabled.
    port Integer Port number
    protocol String Protocol running on the port (for example, http, https, or snmpv3)
  model String Model of the rack or tower server
  name String Name of the rack or tower server
  securityDescriptor Object Information about the authentication enablement and support the associated stored credentials for a managed device
    managedAuthEnabled Boolean Indicates 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.

    managedAuthSupported Boolean Indicates 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.

    roleGroups Array of strings List of role groups that are permitted to view and manage this device
    publicAccess String Indicates 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.

    storedCredentials Object Information about the stored credential that is associated with this device, if applicable
      description String Description of the stored credential
      id String ID of the stored credential
    uri String Server URI
  serialNumber String Serial number for the rack or tower server
  status Object Current status
    manageable Boolean Indicates 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.
    message String Message
    name String Name
  subType String  
  type String Server 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

  uuid String UUID of the rack and tower server
storageList Array of objects Information about each storage device that was discovered
  displayName String Name of the storage device
  hostname String Hostname of the storage device
  ipAddresses Array of strings All IPv4 and IPv6 addresses for the storage device
  firmware Array of objects List of firmware on the storage device
    build String Build level
    date String Date
    version String Build version
  fruNumber String FRU number
  machineType String Machine type of the storage device
  managementPorts Array of objects List of management ports in the storage device
    enabled Boolean Indicates if the port is enabled. One of the following values can be returned.
  • true. The port is enabled.
  • false. The port is not enabled.
    port Integer Port number
    protocol String Protocol running on the port (for example, http, https, or snmpv3)
  model String Model of the storage device
  name String Name of the storage device
  serialNumber String Serial number for the storage device
  status Object Current status
    manageable Boolean Indicates 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.
    name String Name
  type String Resource type. This value is always "Lenovo Storage."
  uuid String UUID of the storage device
  wwnn String WWNN of the storage device
xhmcList Array Information about each XClarity Administrator management server that was discovered
  hostname String Hostname of the XClarity Administrator management server
  ipAddresses Array of strings All IPv4 and IPv6 addresses for the management server
  managementPorts Array of objects List of management ports in the top-of-rack switch
    enabled Boolean Indicates if the port is enabled. This can be one of the following values.
  • true. The port is enabled.
  • false. The port is not enabled.
    port Integer Port number
    protocol String Protocol running on the port (for example, http, https, or snmpv3)
  name String Name of the management server
  software Array of objects Information about the XClarity Administrator version
    version String Version of XClarity Administrator that is installed
  status Object Current status
    manageable Boolean Indicates 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-uuid String UUID of the management server
  type String Resource type This value is always "Domain Manager."
  uuid String UUID of the management server

Response example

The following example is returned when a chassis is successfully discovered.
{
   "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 when a ThinkServer server is successfully discovered.
[{
   "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 when a rack switch is successfully discovered.
[{
   "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": []
}]