xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema/PowerDistribution.v1_5_0.json (revision 5ecf7b4e1bb6988dd3403fa80b723afbe2be30ae)

{
    "$id": "http://redfish.dmtf.org/schemas/v1/PowerDistribution.v1_5_0.json",
    "$ref": "#/definitions/PowerDistribution",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "Actions": {
            "additionalProperties": false,
            "description": "The available actions for this resource.",
            "longDescription": "This type shall contain the available actions for this resource.",
            "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.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "#PowerDistribution.ExportConfiguration": {
                    "$ref": "#/definitions/ExportConfiguration"
                },
                "#PowerDistribution.TransferControl": {
                    "$ref": "#/definitions/TransferControl"
                },
                "Oem": {
                    "$ref": "#/definitions/OemActions",
                    "description": "The available OEM-specific actions for this resource.",
                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
                }
            },
            "type": "object"
        },
        "Component": {
            "enum": [
                "All",
                "Manager",
                "ManagerAccounts",
                "PowerDistribution"
            ],
            "enumDescriptions": {
                "All": "Export all configuration data for this equipment including OEM components.",
                "Manager": "Export configuration data associated with the manager of the equipment.",
                "ManagerAccounts": "Export configuration data associated with the user accounts and external account services of the manager for this equipment.",
                "PowerDistribution": "Export configuration data associated with the power distribution unit functions and subsystems of this equipment."
            },
            "enumLongDescriptions": {
                "All": "The service shall export all available configuration data from the equipment including OEM components.",
                "Manager": "The service shall export configuration data associated with any managers of this equipment.",
                "ManagerAccounts": "The service shall export configuration data associated with any managers for the equipment.",
                "PowerDistribution": "The service shall export configuration data associated with the power distribution unit functions and subsystems of this equipment."
            },
            "type": "string"
        },
        "ExportConfiguration": {
            "additionalProperties": false,
            "description": "This action exports the configuration of the equipment in a vendor-specific format.",
            "longDescription": "This action shall export the specified configuration of the equipment in a vendor-specific format.  Upon successful completion of the action and any asynchronous processing, the `Location` header in the response shall contain a URI to a file that contains the configuration data.",
            "parameters": {
                "Components": {
                    "description": "The components of the equipment for which to export configuration data.",
                    "items": {
                        "$ref": "#/definitions/Component"
                    },
                    "longDescription": "This parameter shall contain an array of components of the equipment for which to export configuration data.",
                    "requiredParameter": true,
                    "type": "array"
                },
                "EncryptionPassphrase": {
                    "description": "The encryption passphrase for the exported file.",
                    "longDescription": "This parameter shall contain the encryption passphrase for the exported file.  If this parameter is specified and has a non-zero length, the service shall encrypt the exported file with the passphrase.  Otherwise, the service shall not encrypt the exported file.",
                    "type": "string"
                },
                "ExportType": {
                    "$ref": "#/definitions/ExportType",
                    "description": "The types of export to perform.",
                    "longDescription": "This parameter shall contain the type of export to perform.",
                    "requiredParameter": true
                },
                "OEMComponents": {
                    "description": "The OEM-specific components of the equipment for which to export configuration data.",
                    "items": {
                        "type": "string"
                    },
                    "longDescription": "This parameter shall contain an array of OEM-specific components of the equipment for which to export configuration data.",
                    "type": "array"
                },
                "Security": {
                    "$ref": "#/definitions/ExportSecurity",
                    "description": "The policy to apply when exporting secure information.",
                    "longDescription": "This parameter shall contain the policy to apply when exporting secure information."
                }
            },
            "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.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri-reference",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object",
            "versionAdded": "v1_5_0"
        },
        "ExportSecurity": {
            "enum": [
                "IncludeSensitiveData",
                "HashedDataOnly",
                "ExcludeSensitiveData"
            ],
            "enumDescriptions": {
                "ExcludeSensitiveData": "Export only non-sensitive data.",
                "HashedDataOnly": "Export hashed passwords, but exclude other sensitive data.",
                "IncludeSensitiveData": "Export all data regardless of the sensitivity."
            },
            "enumLongDescriptions": {
                "ExcludeSensitiveData": "The service shall export only non-sensitive data.",
                "HashedDataOnly": "The service shall export requested data including hashed passwords, but shall exclude other sensitive data.",
                "IncludeSensitiveData": "The service shall export all requested data regardless of the sensitivity."
            },
            "type": "string"
        },
        "ExportType": {
            "enum": [
                "Clone",
                "Replacement"
            ],
            "enumDescriptions": {
                "Clone": "Export configuration data for this equipment to duplicate the configuration on another instance of this equipment.",
                "Replacement": "Export all configuration data required to replace this equipment."
            },
            "enumLongDescriptions": {
                "Clone": "The service shall export configuration data for this equipment that allows for configuration to be duplicated on other equipment as defined by the vendor.  The service shall export only data which would not result in problems if applied to another instance of this equipment.  For example, identifiers such as MAC Addresses and UUIDs will be excluded under this option.  Consult the vendor documentation for this equipment for more information about which equipment is able to accept the resulting configuration data.",
                "Replacement": "The service shall export all configuration data required to replace this equipment.  Consult the vendor documentation for this equipment for more information about the hardware and software requirements for the replacement equipment."
            },
            "type": "string"
        },
        "Links": {
            "additionalProperties": false,
            "description": "The links to other resources that are related to this resource.",
            "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.",
            "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.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "Chassis": {
                    "description": "An array of links to the chassis that contain this equipment.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `Chassis` that represent the physical containers associated with this resource.",
                    "readonly": true,
                    "type": "array"
                },
                "Chassis@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "Facility": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Facility.json#/definitions/Facility",
                    "description": "A link to the facility that contains this equipment.",
                    "longDescription": "This property shall contain a link to a resource of type `Facility` that represents the facility that contains this equipment.",
                    "readonly": true
                },
                "ManagedBy": {
                    "description": "An array of links to the managers responsible for managing this equipment.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `Manager` that represent the managers that manage this equipment.",
                    "readonly": true,
                    "type": "array"
                },
                "ManagedBy@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "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"
        },
        "OemActions": {
            "additionalProperties": true,
            "description": "The available OEM-specific actions for this resource.",
            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
            "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.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {},
            "type": "object"
        },
        "PowerDistribution": {
            "additionalProperties": false,
            "description": "The `PowerDistribution` schema contains the definitions for a power distribution component or unit, such as a floor power distribution unit (PDU) or switchgear.",
            "longDescription": "This resource shall represent a power distribution component or unit for a Redfish implementation.",
            "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.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "@odata.context": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
                },
                "@odata.etag": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
                },
                "Actions": {
                    "$ref": "#/definitions/Actions",
                    "description": "The available actions for this resource.",
                    "longDescription": "This property shall contain the available actions for this resource."
                },
                "AssetTag": {
                    "description": "The user-assigned asset tag for this equipment.",
                    "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.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Branches": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/CircuitCollection.json#/definitions/CircuitCollection",
                    "description": "A link to the branch circuits for this equipment.",
                    "longDescription": "This property shall contain a link to a resource collection of type `CircuitCollection` that contains the branch circuits for this equipment.",
                    "readonly": true
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "EquipmentType": {
                    "$ref": "#/definitions/PowerEquipmentType",
                    "description": "The type of equipment this resource represents.",
                    "longDescription": "This property shall contain the type of equipment this resource represents.",
                    "readonly": true
                },
                "Feeders": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/CircuitCollection.json#/definitions/CircuitCollection",
                    "description": "A link to the feeder circuits for this equipment.",
                    "longDescription": "This property shall contain a link to a resource collection of type `CircuitCollection` that contains the feeder circuits for this equipment.",
                    "readonly": true
                },
                "FirmwareVersion": {
                    "description": "The firmware version of this equipment.",
                    "longDescription": "This property shall contain a string describing the firmware version of this equipment as provided by the manufacturer.",
                    "readonly": true,
                    "type": "string"
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "Links": {
                    "$ref": "#/definitions/Links",
                    "description": "The links to other resources that are related to this resource.",
                    "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.json#/definitions/Location",
                    "description": "The location of the equipment.",
                    "longDescription": "This property shall contain the location information of the associated equipment."
                },
                "Mains": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/CircuitCollection.json#/definitions/CircuitCollection",
                    "description": "A link to the power input circuits for this equipment.",
                    "longDescription": "This property shall contain a link to a resource collection of type `CircuitCollection` that contains the power input circuits for this equipment.",
                    "readonly": true
                },
                "MainsRedundancy": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/RedundantGroup",
                    "description": "The redundancy information for the mains (input) circuits for this equipment.",
                    "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`.",
                    "versionAdded": "v1_1_0"
                },
                "Manufacturer": {
                    "description": "The manufacturer of this equipment.",
                    "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.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Metrics": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/PowerDistributionMetrics.json#/definitions/PowerDistributionMetrics",
                    "description": "A link to the summary metrics for this equipment.",
                    "longDescription": "This property shall contain a link to a resource of type `PowerDistributionMetrics`.",
                    "readonly": true
                },
                "Model": {
                    "description": "The product model number of this equipment.",
                    "longDescription": "This property shall contain the manufacturer-provided model information of this equipment.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "MultipartImportConfigurationPushURI": {
                    "description": "The URI used to perform a Redfish Specification-defined multipart HTTP or HTTPS push import of a vendor-specific configuration file.",
                    "format": "uri-reference",
                    "longDescription": "This property shall contain a URI used to perform a multipart HTTP or HTTPS `POST` of a vendor-specific configuration file for the purpose of importing the configuration contained within the file as defined by the 'Import configuration data' clause of the Redfish Specification.  The value of this property should not contain a URI of a Redfish resource.  See the 'Redfish-defined URIs and relative reference rules' clause in the Redfish Specification.",
                    "readonly": true,
                    "type": "string",
                    "versionAdded": "v1_5_0"
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                    "readonly": true
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "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/OutletGroupCollection.json#/definitions/OutletGroupCollection",
                    "description": "A link to the outlet groups for this equipment.",
                    "longDescription": "This property shall contain a link to a resource collection of type `OutletCollection` that contains the outlet groups for this equipment.",
                    "readonly": true
                },
                "Outlets": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/OutletCollection.json#/definitions/OutletCollection",
                    "description": "A link to the outlets for this equipment.",
                    "longDescription": "This property shall contain a link to a resource collection of type `OutletCollection` that contains the outlets for this equipment.",
                    "readonly": true
                },
                "PartNumber": {
                    "description": "The part number for this equipment.",
                    "longDescription": "This property shall contain the manufacturer-provided part number for the equipment.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "PowerCapacityVA": {
                    "description": "The maximum power capacity, rated as apparent power, of this equipment, in volt-ampere units.",
                    "longDescription": "This property shall contain the maximum power capacity, rated as apparent power, of this equipment, in volt-ampere units.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "V.A",
                    "versionAdded": "v1_4_0"
                },
                "PowerSupplies": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/PowerSupplyCollection.json#/definitions/PowerSupplyCollection",
                    "deprecated": "This property has been deprecated in favor of the `PowerSupplies` link in the `Chassis` resource.",
                    "description": "The link to the collection of power supplies for this equipment.",
                    "longDescription": "This property shall contain a link to a resource collection of type `PowerSupplyCollection`.",
                    "readonly": true,
                    "versionAdded": "v1_1_0",
                    "versionDeprecated": "v1_3_0"
                },
                "PowerSupplyRedundancy": {
                    "deprecated": "This property has been deprecated in favor of the `PowerSupplyRedundancy` property in the `Chassis` resource.",
                    "description": "The redundancy information for the set of power supplies for this equipment.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/RedundantGroup"
                    },
                    "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`.",
                    "type": "array",
                    "versionAdded": "v1_1_0",
                    "versionDeprecated": "v1_3_0"
                },
                "ProductionDate": {
                    "description": "The production or manufacturing date of this equipment.",
                    "format": "date-time",
                    "longDescription": "This property shall contain the date of production or manufacture for this equipment.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Sensors": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/SensorCollection.json#/definitions/SensorCollection",
                    "deprecated": "This property has been deprecated in favor of the `Sensors` link in the `Chassis` resource.",
                    "description": "A link to the collection of sensors located in the equipment and sub-components.",
                    "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.",
                    "readonly": true,
                    "versionDeprecated": "v1_3_0"
                },
                "SerialNumber": {
                    "description": "The serial number for this equipment.",
                    "longDescription": "This property shall contain a manufacturer-allocated number that identifies the equipment.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Status": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
                    "description": "The status and health of the resource and its subordinate or dependent resources.",
                    "longDescription": "This property shall contain any status or health properties of the resource."
                },
                "Subfeeds": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/CircuitCollection.json#/definitions/CircuitCollection",
                    "description": "A link to the subfeed circuits for this equipment.",
                    "longDescription": "This property shall contain a link to a resource collection of type `CircuitCollection` that contains the subfeed circuits for this equipment.",
                    "readonly": true
                },
                "TransferConfiguration": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/TransferConfiguration"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The configuration settings for an automatic transfer switch.",
                    "longDescription": "This property shall contain the configuration information regarding an automatic transfer switch function for this resource."
                },
                "TransferCriteria": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/TransferCriteria"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The criteria used to initiate a transfer for an automatic transfer switch.",
                    "longDescription": "This property shall contain the criteria for initiating a transfer within an automatic transfer switch function for this resource."
                },
                "UUID": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/UUID"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The UUID for this equipment.",
                    "longDescription": "This property shall contain the UUID for the equipment.",
                    "readonly": true
                },
                "UserLabel": {
                    "description": "A user-assigned label.",
                    "longDescription": "This property shall contain a user-assigned label used to identify this resource.  If a value has not been assigned by a user, the value of this property shall be an empty string.",
                    "readonly": false,
                    "type": "string",
                    "versionAdded": "v1_3_0"
                },
                "Version": {
                    "description": "The hardware version of this equipment.",
                    "longDescription": "This property shall contain the hardware version of this equipment as determined by the vendor or supplier.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                }
            },
            "required": [
                "EquipmentType",
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "PowerEquipmentType": {
            "enum": [
                "RackPDU",
                "FloorPDU",
                "ManualTransferSwitch",
                "AutomaticTransferSwitch",
                "Switchgear",
                "PowerShelf",
                "Bus",
                "BatteryShelf"
            ],
            "enumDescriptions": {
                "AutomaticTransferSwitch": "An automatic power transfer switch.",
                "BatteryShelf": "A battery shelf or battery-backed unit (BBU).",
                "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."
            },
            "enumVersionAdded": {
                "BatteryShelf": "v1_3_0",
                "Bus": "v1_2_0",
                "PowerShelf": "v1_1_0"
            },
            "type": "string"
        },
        "TransferConfiguration": {
            "additionalProperties": false,
            "description": "The configuration settings for an automatic transfer switch.",
            "longDescription": "This type shall contain the configuration information regarding an automatic transfer switch function for this resource.",
            "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.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "ActiveMainsId": {
                    "description": "The mains circuit that is switched on and qualified to supply power to the output circuit.",
                    "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.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "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.",
                    "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.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "ClosedTransitionAllowed": {
                    "description": "Indicates if a make-before-break switching sequence of the mains circuits is permitted when they are both qualified and in synchronization.",
                    "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.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "ClosedTransitionTimeoutSeconds": {
                    "description": "The time in seconds to wait for a closed transition to occur.",
                    "longDescription": "This property shall contain the time in seconds to wait for a closed transition to occur.",
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "PreferredMainsId": {
                    "description": "The preferred source for the mains circuit to this equipment.",
                    "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.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "RetransferDelaySeconds": {
                    "description": "The time in seconds to delay the automatic transfer from the alternate mains circuit back to the preferred mains circuit.",
                    "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.",
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "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.",
                    "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.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "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.",
                    "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.",
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "TransferInhibit": {
                    "description": "Indicates if any transfer is inhibited.",
                    "longDescription": "This property shall indicate if any transfer is inhibited.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                }
            },
            "type": "object"
        },
        "TransferControl": {
            "additionalProperties": false,
            "description": "This action transfers control to the alternative input circuit.",
            "longDescription": "This action shall transfer power input from the existing mains circuit to the alternative mains circuit.",
            "parameters": {},
            "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.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri-reference",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "TransferCriteria": {
            "additionalProperties": false,
            "description": "The criteria used to initiate a transfer for an automatic transfer switch.",
            "longDescription": "This type shall contain the criteria for initiating a transfer within an automatic transfer switch function for this resource.",
            "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.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "OverNominalFrequencyHz": {
                    "description": "The frequency in hertz units over the nominal value that satisfies a criterion for transfer.",
                    "longDescription": "This property shall contain the frequency in hertz units over the nominal value that satisfies a criterion for transfer.",
                    "readonly": false,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "Hz"
                },
                "OverVoltageRMSPercentage": {
                    "description": "The positive percentage of voltage RMS over the nominal value that satisfies a criterion for transfer.",
                    "longDescription": "This property shall contain the positive percentage of voltage RMS over the nominal value that satisfies a criterion for transfer.",
                    "minimum": 0,
                    "readonly": false,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "%"
                },
                "TransferSensitivity": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/TransferSensitivityType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The sensitivity to voltage waveform quality to satisfy the criterion for initiating a transfer.",
                    "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.",
                    "readonly": false
                },
                "UnderNominalFrequencyHz": {
                    "description": "The frequency in hertz units under the nominal value that satisfies a criterion for transfer.",
                    "longDescription": "This property shall contain the frequency in hertz units under the nominal value that satisfies a criterion for transfer.",
                    "readonly": false,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "Hz"
                },
                "UnderVoltageRMSPercentage": {
                    "description": "The negative percentage of voltage RMS under the nominal value that satisfies a criterion for transfer.",
                    "longDescription": "This property shall contain the negative percentage of voltage RMS under the nominal value that satisfies a criterion for transfer.",
                    "maximum": 0,
                    "readonly": false,
                    "type": [
                        "number",
                        "null"
                    ],
                    "units": "%"
                }
            },
            "type": "object"
        },
        "TransferSensitivityType": {
            "enum": [
                "High",
                "Medium",
                "Low"
            ],
            "enumDescriptions": {
                "High": "High sensitivity for initiating a transfer.",
                "Low": "Low sensitivity for initiating a transfer.",
                "Medium": "Medium sensitivity for initiating a transfer."
            },
            "type": "string"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2025.3",
    "title": "#PowerDistribution.v1_5_0.PowerDistribution"
}