GET /patterns/<id>

Use the GET method to retrieve information about a specific server pattern or category pattern.

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/patterns/<id>

where <id> is the unique ID that was assigned when the server pattern was created. To obtain the pattern ID, use the GET /patterns method.

Query parameters

None

Response codes

Code Description
200 OK
500 Internal server error

Response body

Attributes Type Description
identifier String Always set to "id"
label String Always set to "label"
items Array Information about the pattern
  description String Description of the 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 pattern has been deployed.
  • false. The pattern has not been deployed.
  formFactor String Form factor of the pattern. This can be one of the following values.
  • 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 pattern
  nodeType String Type of server to which the pattern applies. This value is always "sysx."
  referencedBy Array List of patterns that reference this pattern. For server patterns, this attribute is always empty.
  type String Type of pattern. This can be one of the following values.
  • Server
  • Management
  • SystemInfo
  • DevicesAndIOPorts
  • ExtendedIMM
  • ExtendedUEFI
  • ExtendedPort
  • FibreChannel
  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 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.

Response example

The following example illustrates a server pattern:

{
    "identifier": "id",
    "items": [{
        "description": "",
        "formFactor": "f",
        "id": "46",
        "inUse": true,
        "name": "asdfasdf",
        "nodeType": "sysx",
        "referencedBy": [],
        "type": "Server",
        "uri": "/config/template/46",
        "userDefined": true
    }],
    "label": "name"
}
The following example illustrates a system information category pattern:
{
    "identifier": "id",
    "items": [{
        "description": "",
        "id": "46",
        "inUse": false,
        "name": "sysInfo",
        "referencedBy": [],
        "type": "SystemInfo",
        "uri": "/config/template/46",
        "useCount": 2,
        "userDefined": true
    }],
    "label": "name",
}