Dell Servers Chassis API

openapi: 3.1.0
info:
  title: Dell Servers Dell iDRAC Redfish REST Accounts Chassis API
  description: Integrated Dell Remote Access Controller (iDRAC) RESTful API built upon the DMTF Redfish standard for out-of-band server lifecycle management of Dell PowerEdge servers. Provides programmatic access to server inventory, health monitoring, configuration, firmware updates, power control, virtual media, and BIOS management through a standards-based REST interface.
  version: '5.0'
  contact:
    name: Dell Technologies Support
    url: https://www.dell.com/support
  termsOfService: https://i.dell.com/sites/csdocuments/Legal_Docs/en/us/api-terms-of-use_en.pdf
servers:
- url: https://{idrac-ip}/redfish/v1
  description: iDRAC Redfish Service Root
  variables:
    idrac-ip:
      description: IP address or hostname of the iDRAC interface
      default: 192.168.1.100
security:
- basicAuth: []
tags:
- name: Chassis
  description: Physical enclosure resources including power supplies, thermal sensors, and physical component inventory
paths:
  /Chassis:
    get:
      operationId: listChassis
      summary: Dell Servers List chassis resources
      description: Retrieves the collection of chassis resources representing the physical enclosure of the server including power supplies, fans, thermal sensors, and physical component inventory.
      tags:
      - Chassis
      responses:
        '200':
          description: Collection of chassis resources
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCollection'
        '401':
          description: Unauthorized - invalid or missing credentials
  /Chassis/{ChassisId}:
    get:
      operationId: getChassis
      summary: Dell Servers Get a chassis resource
      description: Retrieves a specific chassis resource with detailed information about the physical enclosure, including model, serial number, part number, asset tag, indicator LED state, and links to power and thermal resources.
      tags:
      - Chassis
      parameters:
      - $ref: '#/components/parameters/ChassisId'
      responses:
        '200':
          description: Chassis resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Chassis'
        '401':
          description: Unauthorized - invalid or missing credentials
        '404':
          description: Chassis resource not found
  /Chassis/{ChassisId}/Power:
    get:
      operationId: getChassisPower
      summary: Dell Servers Get chassis power information
      description: Retrieves power supply information, power consumption metrics, and power control settings for the specified chassis including current wattage, power capacity, and power supply redundancy status.
      tags:
      - Chassis
      parameters:
      - $ref: '#/components/parameters/ChassisId'
      responses:
        '200':
          description: Chassis power resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Power'
        '401':
          description: Unauthorized - invalid or missing credentials
  /Chassis/{ChassisId}/Thermal:
    get:
      operationId: getChassisThermal
      summary: Dell Servers Get chassis thermal information
      description: Retrieves thermal sensor readings, fan speeds, and temperature thresholds for the specified chassis. Includes inlet and exhaust temperatures, CPU temperatures, and fan status with redundancy information.
      tags:
      - Chassis
      parameters:
      - $ref: '#/components/parameters/ChassisId'
      responses:
        '200':
          description: Chassis thermal resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Thermal'
        '401':
          description: Unauthorized - invalid or missing credentials
components:
  schemas:
    Thermal:
      type: object
      description: Thermal sensor readings and fan status for a chassis
      properties:
        '@odata.id':
          type: string
          description: OData resource identifier
        Temperatures:
          type: array
          description: Temperature sensor readings
          items:
            type: object
            properties:
              Name:
                type: string
                description: Sensor name
              ReadingCelsius:
                type: number
                description: Current temperature reading in Celsius
              UpperThresholdCritical:
                type: number
                description: Critical upper temperature threshold
              UpperThresholdFatal:
                type: number
                description: Fatal upper temperature threshold
              LowerThresholdCritical:
                type: number
                description: Critical lower temperature threshold
              Status:
                $ref: '#/components/schemas/Status'
        Fans:
          type: array
          description: Fan inventory and status
          items:
            type: object
            properties:
              Name:
                type: string
                description: Fan name
              Reading:
                type: integer
                description: Current fan speed reading in RPM
              ReadingUnits:
                type: string
                description: Units for the fan reading
                enum:
                - RPM
                - Percent
              Status:
                $ref: '#/components/schemas/Status'
    ResourceCollection:
      type: object
      description: Redfish resource collection
      properties:
        '@odata.id':
          type: string
          description: OData resource identifier
        '@odata.type':
          type: string
          description: OData resource type
        Name:
          type: string
          description: Collection name
        Members@odata.count:
          type: integer
          description: Number of members in the collection
        Members:
          type: array
          description: Array of resource links
          items:
            $ref: '#/components/schemas/ResourceLink'
    ResourceLink:
      type: object
      description: Link to a Redfish resource
      properties:
        '@odata.id':
          type: string
          description: OData resource URI
    Power:
      type: object
      description: Power supply and power consumption information for a chassis
      properties:
        '@odata.id':
          type: string
          description: OData resource identifier
        PowerControl:
          type: array
          description: Power control and consumption readings
          items:
            type: object
            properties:
              Name:
                type: string
                description: Power control name
              PowerConsumedWatts:
                type: number
                description: Current power consumption in watts
              PowerCapacityWatts:
                type: number
                description: Total power capacity in watts
              PowerMetrics:
                type: object
                description: Power consumption metrics over time
                properties:
                  IntervalInMin:
                    type: integer
                    description: Metric sampling interval in minutes
                  MinConsumedWatts:
                    type: number
                    description: Minimum power consumed during interval
                  MaxConsumedWatts:
                    type: number
                    description: Maximum power consumed during interval
                  AverageConsumedWatts:
                    type: number
                    description: Average power consumed during interval
        PowerSupplies:
          type: array
          description: Power supply inventory and status
          items:
            type: object
            properties:
              Name:
                type: string
                description: Power supply name
              PowerCapacityWatts:
                type: number
                description: Power supply rated capacity in watts
              LineInputVoltage:
                type: number
                description: Input voltage in volts
              Model:
                type: string
                description: Power supply model
              SerialNumber:
                type: string
                description: Power supply serial number
              Status:
                $ref: '#/components/schemas/Status'
    Chassis:
      type: object
      description: Chassis resource representing the physical enclosure of a Dell PowerEdge server including power, thermal, and physical component information
      properties:
        '@odata.id':
          type: string
          description: OData resource identifier
        Id:
          type: string
          description: Chassis resource identifier
        Name:
          type: string
          description: Chassis name
        ChassisType:
          type: string
          description: Type of physical form factor
          enum:
          - Rack
          - Blade
          - Enclosure
          - StandAlone
          - RackMount
          - Card
          - Cartridge
          - Row
          - Pod
          - Expansion
          - Sidecar
        Manufacturer:
          type: string
          description: Chassis manufacturer
        Model:
          type: string
          description: Chassis model
        SerialNumber:
          type: string
          description: Chassis serial number
        PartNumber:
          type: string
          description: Chassis part number
        SKU:
          type: string
          description: Chassis SKU or service tag
        AssetTag:
          type: string
          description: User-assigned asset tag
        IndicatorLED:
          type: string
          description: State of the chassis indicator LED
          enum:
          - Lit
          - Blinking
          - 'Off'
        Status:
          $ref: '#/components/schemas/Status'
        PowerState:
          type: string
          description: Current power state
          enum:
          - 'On'
          - 'Off'
          - PoweringOn
          - PoweringOff
    Status:
      type: object
      description: Redfish status object indicating resource health
      properties:
        Health:
          type: string
          description: Overall health state
          enum:
          - OK
          - Warning
          - Critical
        HealthRollup:
          type: string
          description: Rolled-up health state from subordinate resources
          enum:
          - OK
          - Warning
          - Critical
        State:
          type: string
          description: Operational state
          enum:
          - Enabled
          - Disabled
          - StandbyOffline
          - StandbySpare
          - InTest
          - Starting
          - Absent
          - UnavailableOffline
          - Deferring
          - Quiesced
          - Updating
  parameters:
    ChassisId:
      name: ChassisId
      in: path
      required: true
      description: Identifier for the chassis resource, typically System.Embedded.1 for Dell PowerEdge servers
      schema:
        type: string
        default: System.Embedded.1
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using iDRAC username and password credentials. All API requests require authentication except for the Redfish service root at /redfish/v1.
    sessionAuth:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Session-based authentication using a token obtained from the Sessions resource POST operation. The token is passed in the X-Auth-Token header.
externalDocs:
  description: iDRAC Redfish API Documentation
  url: https://developer.dell.com/apis/2978/versions/5.xx/docs/1.0Intro.md