GET /patterns

Use this method to return 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 Comments
200 OK The request completed successfully.
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.

For XClarity Administrator advanced functions, ensure that you have active licenses for each managed server that supports the advanced functions.

500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

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.
  containsM2 Boolean Indicates whether the server pattern contains M.2 drive settings. This can be one of the following values.
  • true. The server pattern contains M.2 drive settings.
  • false. The server pattern does not contain M.2 drive settings.
  description String Description of the server pattern that was defined by the user when the pattern was created
  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
  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.
  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.
  serverType String Server type

If the type is unknown, this value is NA.

  type String Type of pattern. This value is always Server .
  useCount Integer (Category patterns only) Number of server patterns that use this category pattern
  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
The following example is returned if the request is successful.
{
   "identifier": "id",
   "items": [{
      "bmcOnly": false,
      "containsM2": false,
      "description": "",
      "id": "46",
      "inUse": true,
      "formFactor": "f",
      "name": "asdfasdf",
      "nodeType": "sysx",
      "referencedBy": [],
      "serverType": "NA",
      "type": "Server",
      "uri": "/config/template/46",
      "userDefined": true
   }],
   "label": "name"
}