GET /patterns

Use the GET method to retrieve information about all server and category patterns that have been defined in the Lenovo XClarity Administrator.

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/patterns

Query parameters

None

Response codes

Code Description
200 OK. A list of patterns has been returned successfully.
500 Internal server error

Response body

Attributes Type Description
identifier String Always set to "id"
items Array of objects Information about the server pattern
  bmcOnly Boolean Indicates whether the server pattern contains only IMM settings, including "System Information," "Management Interface," and "Extended BMC" category patterns. This can be one of the following values.
  • true. The server pattern contains only IMM settings.
  • false. The server pattern contains non-IMM settings.
  description String Description of the server pattern that was defined by the user when the pattern was created
  id String Patterns unique ID that was generated on creation
  inUse Boolean Indicates whether pattern has been deployed to one or more servers. This can be one of the following values.
  • true. The server pattern has been deployed.
  • false. The server pattern has not been deployed.
  formFactor String Form factor of the server pattern. This can be one of the following values.
  • a. ThinkSystem SR635 or SR655 server
  • f. Flex System server
  • f4sc. 4 bay (2 node) scalable Flex system
  • f8sc. 8 bay (4 node) scalable Flex system
  • r. System x or NeXtScale server
  • rc. Scalable rack system
  name String Name of the server pattern
  nodeType String Type of server to which the pattern applies. This value is always "sysx."
  referencedBy Array of strings List of patterns that reference this pattern. For server patterns, this attribute is always empty.
  type String Type of pattern. This value is always "Server ."
  uri String URI that is used to make individual REST API calls to the referenced object
  userDefined Boolean Indicates whether the server pattern is user-defined or predefined. This can be one of the following values.
  • true. The server pattern is user-defined.
  • false. The server pattern is predefined.
label String Always set to "label"

Response example

{
   "identifier": "id",
   "items": [{
      "bmcOnly": false,
      "description": "",
      "id": "46",
      "inUse": true,
      "formFactor": "f",
      "name": "asdfasdf",
      "nodeType": "sysx",
      "referencedBy": [],
      "type": "Server",
      "uri": "/config/template/46",
      "userDefined": true
   }],
   "label": "name"
}