GET /resourceGroups/criteriaProperties

Use this method to return inventory properties that you can use to specify criteria for dynamic resource groups.

Note: This API requires Lenovo XClarity Administrator v2.0.0 or later

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/resourceGroups/criteriaProperties

Query parameters

None

Request body

None

Response codes

Code Description Comments
200 OK The request completed successfully.
400 Bad Request A 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.
403 Forbidden The 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.
409 Conflict There is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
input Object  
  type String Input type. This can be one of the following values.
  • enum

  • number

  • text

  values Array of objects  
    label String  
    value String  
label Object  
operators Array of objects  
  label String Operator label.
  value String Operator type. This can be one of the following values.
  • equals (for strings, numbers, and enumerations)

  • contains (for strings)

  • greater than (for numbers)

  • less than (for numbers)

property String The inventory property. This can be one of the following value:
  • addinCardName. (String). Add-in card name.
  • contact. (String) Device
  • description. (String) Description
  • fqdn. (String) Fully qualified domain name
  • hostname. (String) Device host name
  • ipv4Addresses. (String) IPv4 addresses
    Note: For IPv4 addresses, you can specify a single address or a range of addresses, separated by dash or using an asterisk as wildcard (for example, 192.0.2.5 – 192.0.2.46 or 192.0.2.*).
  • ipv6Addresses. (String) IPv6 addresses
  • location. (String). Location of the device
  • machineType. (String) Device machine type
  • model. (String) Device model
  • overallHealthState. (String) Status of the device with the highest severity.
  • processorCores. (Integer) Number of processor cores.
  • productName. (String) Device product name
  • rack. (String) Rack where the device is located
  • room. (String). Room where the device is located
  • userDefinedName. (String) Device name that is defined by the user
The following example is returned if the request is successful.
[{
   "input": {
      "type": "text",
      "values": null
   },
   "label": "Add-in card name",
   "operators": [
      {"label": "contains", "value": "contains"},
      {"label": "equals", "value": "equals"}
   ],
   "property": "addinCardName"
},

{
   "input": {
      "type": "text",
      "values": null
   },
   "label": "Contact",
   "operators": [
      {"label": "contains", "value": "contains"},
      {"label": "equals", "value": "equals"}
   ],
   "property": "contact"
},
{
   "input": {
      "type": "text",
      "values": null
   },
   "label": "Description",
   "operators": [
      {"label": "contains", "value": "contains"},
      {"label": "equals", "value": "equals"}
   ],
   "property": "description"
},
{
   "input": {
      "type": "text",
      "values": null
   },
   "label": "Fully-qualified domain name",
   "operators": [
      {"label": "contains", "value": "contains"},
      {"label": "equals", "value": "equals"}
   ],
   "property": "fqdn"
},
{
   "input": {
      "type": "text",
      "values": null
   },
   "label": "Hostname",
   "operators": [
      {"label": "contains", "value": "contains"},
      {"label": "equals", "value": "equals"}
   ],
   "property": "hostname"
},
{
   "label": "IPv4 address",
   "input": {
      "type": "text",
      "values": null
   },
   "operators": [
      {"label": "contains", "value": "contains"},
      {"label": "equals", "value": "equals"}
   ],
   "property": "ipv4Addresses"
},
{
   "input": {
      "type": "text",
      "values": null
   },
   "label": "IPv6 address",
   "operators": [
      {"label": "contains", "value": "contains"},
      {"label": "equals", "value": "equals"}
   ],
   "property": "ipv6Addresses"
},
{
   "input": {
      "type": "text",
      "values": null
   },
   "label": "Location",
   "operators": [
      {"label": "contains", "value": "contains"},
      {"label": "equals", "value": "equals"}
   ],
   "property": "location"
},
{
   "input": {
      "type": "text",
      "values": null
   },
   "label": "Machine type",
   "operators": [
      {"label": "contains", "value": "contains"},
      {"label": "equals", "value": "equals"}
   ],
   "property": "machineType"
},
{
   "input": {
      "type": "text",
      "values": null
   },
   "label": "Model",
   "operators": [
      {"label": "contains", "value": "contains"},
      {"label": "equals", "value": "equals"}
   ],
   "property": "model"
},
{
   "input": {
      "type": "enum",
      "values": [
         {"label": "Normal", "value": "Normal"},
         {"label": "Non-Critical", "value": "Non-Critical"},
         {"label": "Warning", "value": "Warning"},
         {"label": "Minor-Failure", "value": "Minor-Failure"},
         {"label": "Major-Failure", "value": "Major-Failure"},
         {"label": "Non-Recoverable", "value": "Non-Recoverable"},
         {"label": "Critical", "value": "Critical"},
         {"label": "Unknown", "value": "Unknown"}
      ]
   },
   "label": "Overall Health State",
   "operators": [{"label": "equals", "value": "equals"}],
   "property": "overallHealthState"
},
{
   "input": {
      "type": "number",
      "values": null
   },
   "label": "Processor cores",
   "operators": [
      {"label": "equals", "value": "equals"},
      {"label": "greater than", "value": "greater than"},
      {"label": "less than", "value": "less than"}
   ],
   "property": "processorCores"
},
{
   "input": {
      "type": "text",
      "values": null
   },
   "label": "Product name",
   "operators": [
      {"label": "contains", "value": "contains"},
      {"label": "equals", "value": "equals"}
   ],
   "property": "productName"
},
{
   "input": {
      "type": "text",
      "values": null
   },
   "label": "Rack",
   "operators": [
      {"label": "contains", "value": "contains"},
      {"label": "equals", "value": "equals"}
   ],
   "property": "rack"
},
{
   "input": {
      "type": "text",
      "values": null
   },
   "label": "Room",
   "operators": [
      {"label": "contains", "value": "contains"},
      {"label": "equals", "value": "equals"}
   ],
   "property": "room"
},
{
   "input": {
      "type": "text",
      "values": null
   },
   "label": "User-defined name",
   "operators": [
      {"label": "contains", "value": "contains"},
      {"label": "equals", "value": "equals"}
   ],
   "property": "userDefinedName"
}]