Jump to

• Request
• Response

Get all HardwareComponent objects that meet the filter criteria.

put

https://{host}:{port}/{basePath}/HardwareComponent/filter

get all HardwareComponent objects that meet the filter criteria.

Request

Header Parameters

• Auth-Token(required): string
  Auth-Token received from a successful login response.
• opc-request-id: string
  Unique identifier for the request

Supported Media Types

• application/x-www-form-urlencoded

Request Body - application/x-www-form-urlencoded ()

Root Schema : schema

Type: object

Show Source

• filter: object Filter

{
    "properties":{
        "filter":{
            "$ref":"#/components/schemas/Filter",
            "type":"object"
        }
    }
}

Nested Schema : Filter

Type: object

Show Source

• description(required): string
  Maximum Length: 1000
• faultIds: array faultIds
• filterConditions: array filterConditions
• generation: integer
• maxResults: integer
• name(required): string
  Maximum Length: 256
• objType: string
  Maximum Length: 64
• orderByList: array orderByList
• orderType: string
  Allowed Values: [ "ASCENDING", "DESCENDING" ]
• workState: string

{
    "properties":{
        "objType":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "maxResults":{
            "description":"",
            "type":"integer"
        },
        "orderByList":{
            "description":"",
            "type":"array"
        },
        "orderType":{
            "description":"",
            "enum":[
                "ASCENDING",
                "DESCENDING"
            ],
            "type":"string"
        },
        "filterConditions":{
            "description":"",
            "type":"array"
        },
        "description":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "generation":{
            "description":"",
            "type":"integer"
        },
        "name":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "workState":{
            "description":"",
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "description":""
}

Nested Schema : faultIds

Type: array

Nested Schema : filterConditions

Type: array

Nested Schema : orderByList

Type: array

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object HardwareComponent
  A hardware component represents any faultable hardware parts on a Rack.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/HardwareComponent"
    }
}

Nested Schema : HardwareComponent

Type: object

A hardware component represents any faultable hardware parts on a Rack.

Show Source

• certainty: integer
• chassisManufacturer: string
  Maximum Length: 64
• chassisModel: string
  Maximum Length: 64
• chassisPart: string
  Maximum Length: 64
• chassisSerial: string
  Maximum Length: 64
• componentId: string
  Maximum Length: 100
• description(required): string
  Maximum Length: 1000
• faultIds: array faultIds
• firmware: string
  Maximum Length: 64
• generation: integer
• location: string
  Maximum Length: 256
• manufacturer: string
  Maximum Length: 64
• model: string
  Maximum Length: 64
• name(required): string
  Maximum Length: 256
• nodeId: string
  Maximum Length: 64
• nodeImage: string
  Maximum Length: 64
• part: string
  Maximum Length: 64
• rackUnitId: object RackUnit
  A RackUnit represents all types of hardware that may be contained within a Rack.
• serial: string
  Maximum Length: 64
• status: string
  Maximum Length: 64
• workState: string

{
    "properties":{
        "nodeId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "nodeImage":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "serial":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "manufacturer":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "model":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "part":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "firmware":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "location":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "status":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "chassisSerial":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "chassisManufacturer":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "chassisModel":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "chassisPart":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "certainty":{
            "description":"",
            "type":"integer"
        },
        "componentId":{
            "description":"",
            "maxLength":100,
            "type":"string"
        },
        "rackUnitId":{
            "description":"",
            "$ref":"#/components/schemas/RackUnit"
        },
        "description":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "generation":{
            "description":"",
            "type":"integer"
        },
        "name":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "workState":{
            "description":"",
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "description":"A hardware component represents any faultable hardware parts on a Rack."
}

Nested Schema : faultIds

Type: array

Nested Schema : RackUnit

Type: object

A RackUnit represents all types of hardware that may be contained within a Rack.

Show Source

• coreCount: string
  Maximum Length: 64
• description(required): string
  Maximum Length: 1000
• faultIds: array faultIds
• firmwareVersion: string
  Maximum Length: 64
• generation: integer
• hardwareComponentIds: array hardwareComponentIds
• hostname: string
  Maximum Length: 64
• hwId: string
  Maximum Length: 64
• ilomHostname: string
  Maximum Length: 64
• ilomIp: string
  Maximum Length: 64
• ilomMac: string
  Maximum Length: 64
• ilomRunStateFault: string
  Allowed Values: [ "CRITICAL", "MAJOR", "MINOR", "WARNING" ]
• ilomState: string
  Maximum Length: 64
• ipAddress: string
  Maximum Length: 64
• macAddress: string
  Maximum Length: 64
• model: string
  Maximum Length: 64
• name(required): string
  Maximum Length: 256
• os: string
  Maximum Length: 64
• rackElevation: string
  Maximum Length: 64
• rackId: object Rack
  The Rack object represents a physical PCA Rack.
• runStateFault: string
  Allowed Values: [ "CRITICAL", "MAJOR", "MINOR", "WARNING" ]
• serialNumber: string
  Maximum Length: 64
• state: string
  Maximum Length: 64
• validationState: string
  Allowed Values: [ "VALIDATED", "ERROR", "UNKNOWN" ]
• vendor: string
  Maximum Length: 64
• workState: string

{
    "properties":{
        "hwId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "macAddress":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "ipAddress":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "ilomIp":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "ilomMac":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "ilomHostname":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "ilomState":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "hostname":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "model":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "os":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "vendor":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "firmwareVersion":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "serialNumber":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "state":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "rackElevation":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "validationState":{
            "description":"",
            "enum":[
                "VALIDATED",
                "ERROR",
                "UNKNOWN"
            ],
            "type":"string"
        },
        "runStateFault":{
            "description":"",
            "enum":[
                "CRITICAL",
                "MAJOR",
                "MINOR",
                "WARNING"
            ],
            "type":"string"
        },
        "ilomRunStateFault":{
            "description":"",
            "enum":[
                "CRITICAL",
                "MAJOR",
                "MINOR",
                "WARNING"
            ],
            "type":"string"
        },
        "coreCount":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "hardwareComponentIds":{
            "description":"",
            "type":"array"
        },
        "rackId":{
            "description":"",
            "$ref":"#/components/schemas/Rack"
        },
        "description":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "generation":{
            "description":"",
            "type":"integer"
        },
        "name":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "workState":{
            "description":"",
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "description":"A RackUnit represents all types of hardware that may be contained within a Rack."
}

Nested Schema : faultIds

Type: array

Nested Schema : hardwareComponentIds

Type: array

Nested Schema : Rack

Type: object

The Rack object represents a physical PCA Rack.

Show Source

• description(required): string
  Maximum Length: 1000
• faultIds: array faultIds
• generation: integer
• name(required): string
  Maximum Length: 256
• rackNumber: integer
• rackSerialNumber: string
  Maximum Length: 64
• rackType: string
  Maximum Length: 64
• rackUnitIds: array rackUnitIds
• validationState: string
  Allowed Values: [ "VALIDATED", "ERROR", "UNKNOWN" ]
• workState: string

{
    "properties":{
        "rackNumber":{
            "description":"",
            "type":"integer"
        },
        "rackSerialNumber":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "rackType":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "validationState":{
            "description":"",
            "enum":[
                "VALIDATED",
                "ERROR",
                "UNKNOWN"
            ],
            "type":"string"
        },
        "rackUnitIds":{
            "description":"",
            "type":"array"
        },
        "description":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "generation":{
            "description":"",
            "type":"integer"
        },
        "name":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "workState":{
            "description":"",
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "description":"The Rack object represents a physical PCA Rack."
}

Nested Schema : faultIds

Type: array

Nested Schema : rackUnitIds

Type: array

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top