xref: /openbmc/bmcweb/redfish-core/schema/dmtf/json-schema/PhysicalContext.json (revision dd5c81e9e330c20f534496174472efb6fe2c112e)

{
    "$id": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "LogicalContext": {
            "enum": [
                "Capacity",
                "Environment",
                "Network",
                "Performance",
                "Security",
                "Storage"
            ],
            "enumDescriptions": {
                "Capacity": "Capacity-related logical context.",
                "Environment": "Environment-related logical context.",
                "Network": "Network-related logical context.",
                "Performance": "Performance-related logical context.",
                "Security": "Security-related logical context.",
                "Storage": "Storage-related logical context."
            },
            "type": "string",
            "versionAdded": "2022.1"
        },
        "PhysicalContext": {
            "enum": [
                "Room",
                "Intake",
                "Exhaust",
                "LiquidInlet",
                "LiquidOutlet",
                "Front",
                "Back",
                "Upper",
                "Lower",
                "CPU",
                "CPUSubsystem",
                "GPU",
                "GPUSubsystem",
                "FPGA",
                "Accelerator",
                "ASIC",
                "Backplane",
                "SystemBoard",
                "PowerSupply",
                "PowerSubsystem",
                "VoltageRegulator",
                "Rectifier",
                "StorageDevice",
                "StorageSubsystem",
                "NetworkingDevice",
                "ExpansionSubsystem",
                "ComputeBay",
                "StorageBay",
                "NetworkBay",
                "ExpansionBay",
                "PowerSupplyBay",
                "Memory",
                "MemorySubsystem",
                "Chassis",
                "Fan",
                "CoolingSubsystem",
                "Motor",
                "Transformer",
                "ACUtilityInput",
                "ACStaticBypassInput",
                "ACMaintenanceBypassInput",
                "DCBus",
                "ACOutput",
                "ACInput",
                "PowerOutlet",
                "TrustedModule",
                "Board",
                "Transceiver",
                "Battery",
                "Pump",
                "Filter",
                "Reservoir",
                "Switch",
                "Manager"
            ],
            "enumDescriptions": {
                "ACInput": "An AC electrical input or input-related circuit.",
                "ACMaintenanceBypassInput": "An AC electrical maintenance bypass input.",
                "ACOutput": "An AC electrical output or output-related circuit.",
                "ACStaticBypassInput": "An AC electrical static bypass input.",
                "ACUtilityInput": "An AC electrical utility input.",
                "ASIC": "An ASIC device, such as a networking chip or chipset component.",
                "Accelerator": "An accelerator.",
                "Back": "The back of the chassis.",
                "Backplane": "A backplane within the chassis.",
                "Battery": "A battery.",
                "Board": "A circuit board.",
                "CPU": "A processor (CPU).",
                "CPUSubsystem": "The entire processor (CPU) subsystem.",
                "Chassis": "The entire chassis.",
                "ComputeBay": "A compute bay.",
                "CoolingSubsystem": "The entire cooling, or air and liquid, subsystem.",
                "DCBus": "A DC electrical bus.",
                "Exhaust": "The air exhaust point or points or region of the chassis.",
                "ExpansionBay": "An expansion bay.",
                "ExpansionSubsystem": "A group of expansion bays.",
                "FPGA": "An FPGA.",
                "Fan": "A fan.",
                "Filter": "A filter.",
                "Front": "The front of the chassis.",
                "GPU": "A graphics processor (GPU).",
                "GPUSubsystem": "The entire graphics processor (GPU) subsystem.",
                "Intake": "The air intake point or points or region of the chassis.",
                "LiquidInlet": "The liquid inlet point of the chassis.",
                "LiquidOutlet": "The liquid outlet point of the chassis.",
                "Lower": "The lower portion of the chassis.",
                "Manager": "A management controller, such as a BMC (baseboard management controller).",
                "Memory": "A memory device.",
                "MemorySubsystem": "The entire memory subsystem.",
                "Motor": "A motor.",
                "NetworkBay": "A networking bay.",
                "NetworkingDevice": "A networking device.",
                "PowerOutlet": "An electrical outlet.",
                "PowerSubsystem": "The entire power subsystem.",
                "PowerSupply": "A power supply.",
                "PowerSupplyBay": "A power supply bay.",
                "Pump": "A pump.",
                "Rectifier": "A rectifier device.",
                "Reservoir": "A reservoir.",
                "Room": "The room.",
                "StorageBay": "A storage bay.",
                "StorageDevice": "A storage device.",
                "StorageSubsystem": "A storage subsystem.",
                "Switch": "A switch device.",
                "SystemBoard": "The system board (PCB).",
                "Transceiver": "A transceiver.",
                "Transformer": "A transformer.",
                "TrustedModule": "A trusted module.",
                "Upper": "The upper portion of the chassis.",
                "VoltageRegulator": "A voltage regulator device."
            },
            "enumLongDescriptions": {
                "ACOutput": "This value shall indicate an electrical output or an output-related circuit, such as a branch output, which is not terminated as a power outlet.",
                "ACUtilityInput": "This value shall indicate an electrical input, where the source is an electrical utility as opposed to a backup or locally-generated power source.  This value is intended to differentiate multiple electrical inputs between utility, maintenance bypass, or static bypass values.  For general purpose usage, the value of `ACInput` is preferred.",
                "Board": "This value shall indicate a circuit board that is not the primary or system board within a context that cannot be described by other defined values.",
                "ExpansionBay": "This value shall indicate a location that provides for the expansion of functionality of a system, such as a PCIe slot that can accept an option card.",
                "ExpansionSubsystem": "This value shall indicate a group of expansion bays and the devices installed in those bays.",
                "NetworkBay": "This value shall indicate a location that provides for the expansion of networking functionality of a system, by the addition of networking devices.",
                "PowerOutlet": "This value shall indicate an electrical outlet or receptacle.",
                "PowerSupplyBay": "This value shall indicate a location that provides for the installation of a power supply or similar devices.",
                "StorageBay": "This value shall indicate a location that provides for the expansion of storage functionality of a system, by the addition of storage devices.",
                "StorageSubsystem": "This value shall indicate a storage subsystem, which may consist of one or more storage controllers, storage devices, or related components.",
                "Transceiver": "This value shall indicate a transceiver attached to a device."
            },
            "enumVersionAdded": {
                "ACInput": "2018.3",
                "ACMaintenanceBypassInput": "2018.3",
                "ACOutput": "2018.3",
                "ACStaticBypassInput": "2018.3",
                "ACUtilityInput": "2018.3",
                "ASIC": "2017.3",
                "Accelerator": "2018.3",
                "Battery": "2021.2",
                "Board": "2021.1",
                "CPUSubsystem": "2018.3",
                "Chassis": "2017.2",
                "CoolingSubsystem": "2018.3",
                "DCBus": "2018.3",
                "ExpansionSubsystem": "2024.3",
                "FPGA": "2018.3",
                "Fan": "2017.2",
                "Filter": "2024.2",
                "GPUSubsystem": "2018.3",
                "LiquidInlet": "2017.3",
                "LiquidOutlet": "2017.3",
                "Manager": "2024.2",
                "Memory": "2017.1",
                "MemorySubsystem": "2018.3",
                "Motor": "2018.3",
                "PowerOutlet": "2024.3",
                "PowerSubsystem": "2019.1",
                "Pump": "2021.3",
                "Rectifier": "2019.1",
                "Reservoir": "2024.2",
                "StorageSubsystem": "2024.3",
                "Switch": "2024.2",
                "Transceiver": "2021.1",
                "Transformer": "2018.3",
                "TrustedModule": "2020.4"
            },
            "type": "string"
        },
        "PhysicalSubContext": {
            "enum": [
                "Input",
                "Output"
            ],
            "enumDescriptions": {
                "Input": "The input.",
                "Output": "The output."
            },
            "type": "string",
            "versionAdded": "2018.3"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "1.0",
    "title": "#PhysicalContext"
}