components:
  schemas:
    PowerDistribution_v1_2_4_Actions:
      additionalProperties: false
      description: The available actions for this resource.
      properties:
        '#PowerDistribution.TransferControl':
          $ref: '#/components/schemas/PowerDistribution_v1_2_4_TransferControl'
        Oem:
          $ref: '#/components/schemas/PowerDistribution_v1_2_4_OemActions'
          description: The available OEM-specific actions for this resource.
          x-longDescription: This property shall contain the available OEM-specific
            actions for this resource.
      type: object
      x-longDescription: This type shall contain the available actions for this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    PowerDistribution_v1_2_4_Links:
      additionalProperties: false
      description: The links to other resources that are related to this resource.
      properties:
        Chassis:
          description: An array of links to the chassis that contain this equipment.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          readOnly: true
          type: array
          x-longDescription: This property shall contain an array of links to resources
            of type Chassis that represents the physical container associated with
            this resource.
        Chassis@odata.count:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_count
        Facility:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A link to the facility that contains this equipment.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource of type
            Facility that represents the facility that contains this equipment.
        ManagedBy:
          description: An array of links to the managers responsible for managing
            this equipment.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          readOnly: true
          type: array
          x-longDescription: This property shall contain an array of links to resources
            of type Manager that represent the managers that manage this equipment.
        ManagedBy@odata.count:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_count
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: The OEM extension property.
          x-longDescription: This property shall contain the OEM extensions.  All
            values for properties contained in this object shall conform to the Redfish
            Specification-described requirements.
      type: object
      x-longDescription: This Redfish Specification-described type shall contain links
        to resources that are related to but are not contained by, or subordinate
        to, this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    PowerDistribution_v1_2_4_OemActions:
      additionalProperties: true
      description: The available OEM-specific actions for this resource.
      properties: {}
      type: object
      x-longDescription: This type shall contain the available OEM-specific actions
        for this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    PowerDistribution_v1_2_4_PowerDistribution:
      additionalProperties: false
      description: This is the schema definition for a power distribution component
        or unit, such as a floor power distribution unit (PDU) or switchgear.
      properties:
        '@odata.context':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_context
        '@odata.etag':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_etag
        '@odata.id':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_id
        '@odata.type':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_type
        Actions:
          $ref: '#/components/schemas/PowerDistribution_v1_2_4_Actions'
          description: The available actions for this resource.
          x-longDescription: This property shall contain the available actions for
            this resource.
        AssetTag:
          description: The user-assigned asset tag for this equipment.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: This property shall contain the user-assigned asset tag,
            which is an identifying string that tracks the equipment for inventory
            purposes.  Modifying this property may modify the AssetTag in the containing
            Chassis resource.
        Branches:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A link to the branch circuits for this equipment.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource collection
            of type CircuitCollection that contains the branch circuits for this equipment.
        Description:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description
          nullable: true
          readOnly: true
        EquipmentType:
          $ref: '#/components/schemas/PowerDistribution_v1_2_4_PowerEquipmentType'
          description: The type of equipment this resource represents.
          readOnly: true
          x-longDescription: This property shall contain the type of equipment this
            resource represents.
        Feeders:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A link to the feeder circuits for this equipment.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource collection
            of type CircuitCollection that contains the feeder circuits for this equipment.
        FirmwareVersion:
          description: The firmware version of this equipment.
          readOnly: true
          type: string
          x-longDescription: This property shall contain a string describing the firmware
            version of this equipment as provided by the manufacturer.
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        Links:
          $ref: '#/components/schemas/PowerDistribution_v1_2_4_Links'
          description: The links to other resources that are related to this resource.
          x-longDescription: This property shall contain links to resources that are
            related to but are not contained by, or subordinate to, this resource.
        Location:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Location
          description: The location of the equipment.
          x-longDescription: This property shall contain location information of the
            associated equipment.
        Mains:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A link to the power input circuits for this equipment.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource collection
            of type CircuitCollection that contains the power input circuits for this
            equipment.
        MainsRedundancy:
          $ref: http://redfish.dmtf.org/schemas/v1/Redundancy.yaml#/components/schemas/Redundancy_RedundantGroup
          description: The redundancy information for the mains (input) circuits for
            this equipment.
          x-longDescription: This property shall contain redundancy information for
            the mains (input) circuits for this equipment.  The values of the RedundancyGroup
            array shall reference resources of type Circuit.
          x-versionAdded: v1_1_0
        Manufacturer:
          description: The manufacturer of this equipment.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the name of the organization
            responsible for producing the equipment.  This organization may be the
            entity from which the equipment is purchased, but this is not necessarily
            true.
        Metrics:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A link to the summary metrics for this equipment.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource of type
            PowerDistributionMetrics.
        Model:
          description: The product model number of this equipment.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the manufacturer-provided
            model information of this equipment.
        Name:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Name
          readOnly: true
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: The OEM extension property.
          x-longDescription: This property shall contain the OEM extensions.  All
            values for properties that this object contains shall conform to the Redfish
            Specification-described requirements.
        OutletGroups:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A link to the outlet groups for this equipment.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource collection
            of type OutletCollection that contains the outlet groups for this equipment.
        Outlets:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A link to the outlets for this equipment.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource collection
            of type OutletCollection that contains the outlets for this equipment.
        PartNumber:
          description: The part number for this equipment.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the manufacturer-provided
            part number for the equipment.
        PowerSupplies:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to the collection of power supplies for this equipment.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource collection
            of type PowerSupplyCollection.
          x-versionAdded: v1_1_0
        PowerSupplyRedundancy:
          description: The redundancy information for the set of power supplies for
            this equipment.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/Redundancy.yaml#/components/schemas/Redundancy_RedundantGroup
          type: array
          x-longDescription: This property shall contain redundancy information for
            the set of power supplies for this equipment.  The values of the RedundancyGroup
            array shall reference resources of type PowerSupply.
          x-versionAdded: v1_1_0
        ProductionDate:
          description: The production or manufacturing date of this equipment.
          format: date-time
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the date of production or
            manufacture for this equipment.
        Sensors:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A link to the collection of sensors located in the equipment
            and sub-components.
          readOnly: true
          x-longDescription: This property shall be a link to a resource collection
            of type SensorCollection that contains the sensors located in the equipment
            and sub-components.
        SerialNumber:
          description: The serial number for this equipment.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain a manufacturer-allocated
            number that identifies the equipment.
        Status:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Status
          description: The status and health of the resource and its subordinate or
            dependent resources.
          x-longDescription: This property shall contain any status or health properties
            of the resource.
        Subfeeds:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A link to the subfeed circuits for this equipment.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource collection
            of type CircuitCollection that contains the subfeed circuits for this
            equipment.
        TransferConfiguration:
          $ref: '#/components/schemas/PowerDistribution_v1_2_4_TransferConfiguration'
          description: The configuration settings for an automatic transfer switch.
          nullable: true
          x-longDescription: This property shall contain the configuration information
            regarding an automatic transfer switch function for this resource.
        TransferCriteria:
          $ref: '#/components/schemas/PowerDistribution_v1_2_4_TransferCriteria'
          description: The criteria used to initiate a transfer for an automatic transfer
            switch.
          nullable: true
          x-longDescription: This property shall contain the criteria for initiating
            a transfer within an automatic transfer switch function for this resource.
        UUID:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_UUID
          description: The UUID for this equipment.
          nullable: true
          readOnly: true
          x-longDescription: This property shall contain the UUID for the equipment.
        Version:
          description: The hardware version of this equipment.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the hardware version of this
            equipment as determined by the vendor or supplier.
      required:
      - EquipmentType
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      type: object
      x-longDescription: This resource shall be used to represent a power distribution
        component or unit for a Redfish implementation.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    PowerDistribution_v1_2_4_PowerEquipmentType:
      enum:
      - RackPDU
      - FloorPDU
      - ManualTransferSwitch
      - AutomaticTransferSwitch
      - Switchgear
      - PowerShelf
      - Bus
      type: string
      x-enumDescriptions:
        AutomaticTransferSwitch: An automatic power transfer switch.
        Bus: An electrical bus.
        FloorPDU: A power distribution unit providing feeder circuits for further
          power distribution.
        ManualTransferSwitch: A manual power transfer switch.
        PowerShelf: A power shelf.
        RackPDU: A power distribution unit providing outlets for a rack or similar
          quantity of devices.
        Switchgear: Electrical switchgear.
      x-enumVersionAdded:
        Bus: v1_2_0
        PowerShelf: v1_1_0
    PowerDistribution_v1_2_4_TransferConfiguration:
      additionalProperties: false
      description: The configuration settings for an automatic transfer switch.
      properties:
        ActiveMainsId:
          description: The mains circuit that is switched on and qualified to supply
            power to the output circuit.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: This property shall contain the mains circuit that is
            switched on and qualified to supply power to the output circuit.  The
            value shall be a string that matches the Id property value of a circuit
            contained in the collection referenced by the Mains property.
        AutoTransferEnabled:
          description: Indicates if the qualified alternate mains circuit is automatically
            switched on when the preferred mains circuit becomes unqualified and is
            automatically switched off.
          nullable: true
          readOnly: false
          type: boolean
          x-longDescription: This property shall indicate if the qualified alternate
            mains circuit is automatically switched on when the preferred mains circuit
            becomes unqualified and is automatically switched off.
        ClosedTransitionAllowed:
          description: Indicates if a make-before-break switching sequence of the
            mains circuits is permitted when they are both qualified and in synchronization.
          nullable: true
          readOnly: false
          type: boolean
          x-longDescription: This property shall indicate if a make-before-break switching
            sequence of the mains circuits is permitted when they are both qualified
            and in synchronization.
        ClosedTransitionTimeoutSeconds:
          description: The time in seconds to wait for a closed transition to occur.
          format: int64
          nullable: true
          readOnly: false
          type: integer
          x-longDescription: This property shall contain the time in seconds to wait
            for a closed transition to occur.
        PreferredMainsId:
          description: The preferred source for the mains circuit to this equipment.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: This property shall contain the preferred source for
            mains circuit to this equipment.  The value shall be a string that matches
            the Id property value of a circuit contained in the collection referenced
            by the Mains property.
        RetransferDelaySeconds:
          description: The time in seconds to delay the automatic transfer from the
            alternate mains circuit back to the preferred mains circuit.
          format: int64
          nullable: true
          readOnly: false
          type: integer
          x-longDescription: This property shall contain the time in seconds to delay
            the automatic transfer from the alternate mains circuit back to the preferred
            mains circuit.
        RetransferEnabled:
          description: Indicates if the automatic transfer is permitted from the alternate
            mains circuit back to the preferred mains circuit after the preferred
            mains circuit is qualified again and the Retransfer Delay time has expired.
          nullable: true
          readOnly: false
          type: boolean
          x-longDescription: This property shall indicate if the automatic transfer
            is permitted from the alternate mains circuit back to the preferred mains
            circuit after the preferred mains circuit is qualified again and the RetransferDelaySeconds
            time has expired.
        TransferDelaySeconds:
          description: The time in seconds to delay the automatic transfer from the
            preferred mains circuit to the alternate mains circuit when the preferred
            mains circuit is disqualified.
          format: int64
          nullable: true
          readOnly: false
          type: integer
          x-longDescription: This property shall contain the time in seconds to delay
            the automatic transfer from the preferred mains circuit to the alternate
            mains circuit when the preferred mains circuit is disqualified.  A value
            of zero shall mean it transfers as fast as possible.
        TransferInhibit:
          description: Indicates if any transfer is inhibited.
          nullable: true
          readOnly: false
          type: boolean
          x-longDescription: This property shall indicate if any transfer is inhibited.
      type: object
      x-longDescription: This type shall contain the configuration information regarding
        an automatic transfer switch function for this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    PowerDistribution_v1_2_4_TransferControl:
      additionalProperties: false
      description: This action transfers control to the alternative input circuit.
      properties:
        target:
          description: Link to invoke action
          format: uri-reference
          type: string
        title:
          description: Friendly action name
          type: string
      type: object
      x-longDescription: This action shall transfer power input from the existing
        mains circuit to the alternative mains circuit.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    PowerDistribution_v1_2_4_TransferControlRequestBody:
      additionalProperties: false
      description: This action transfers control to the alternative input circuit.
      properties: {}
      type: object
      x-longDescription: This action shall transfer power input from the existing
        mains circuit to the alternative mains circuit.
    PowerDistribution_v1_2_4_TransferCriteria:
      additionalProperties: false
      description: The criteria used to initiate a transfer for an automatic transfer
        switch.
      properties:
        OverNominalFrequencyHz:
          description: The frequency in hertz over the nominal value that satisfies
            a criterion for transfer.
          nullable: true
          readOnly: false
          type: number
          x-longDescription: This property shall contain the frequency in hertz over
            the nominal value that satisfies a criterion for transfer.
          x-units: Hz
        OverVoltageRMSPercentage:
          description: The positive percentage of voltage RMS over the nominal value
            that satisfies a criterion for transfer.
          minimum: 0
          nullable: true
          readOnly: false
          type: number
          x-longDescription: This property shall contain the positive percentage of
            voltage RMS over the nominal value that satisfies a criterion for transfer.
          x-units: '%'
        TransferSensitivity:
          $ref: '#/components/schemas/PowerDistribution_v1_2_4_TransferSensitivityType'
          description: The sensitivity to voltage waveform quality to satisfy the
            criterion for initiating a transfer.
          nullable: true
          readOnly: false
          x-longDescription: This property shall contain the setting that adjusts
            the analytical sensitivity of the detection of the quality of voltage
            waveform that satisfies a criterion for transfer.
        UnderNominalFrequencyHz:
          description: The frequency in hertz under the nominal value that satisfies
            a criterion for transfer.
          nullable: true
          readOnly: false
          type: number
          x-longDescription: This property shall contain the frequency in hertz under
            the nominal value that satisfies a criterion for transfer.
          x-units: Hz
        UnderVoltageRMSPercentage:
          description: The negative percentage of voltage RMS under the nominal value
            that satisfies a criterion for transfer.
          maximum: 0
          nullable: true
          readOnly: false
          type: number
          x-longDescription: This property shall contain the negative percentage of
            voltage RMS under the nominal value that satisfies a criterion for transfer.
          x-units: '%'
      type: object
      x-longDescription: This type shall contain the criteria for initiating a transfer
        within an automatic transfer switch function for this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    PowerDistribution_v1_2_4_TransferSensitivityType:
      enum:
      - High
      - Medium
      - Low
      type: string
      x-enumDescriptions:
        High: High sensitivity for initiating a transfer.
        Low: Low sensitivity for initiating a transfer.
        Medium: Medium sensitivity for initiating a transfer.
title: '#PowerDistribution.v1_2_4.PowerDistribution'
x-copyright: Copyright 2014-2023 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright
x-owningEntity: DMTF
x-release: '2021.3'
