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

{
    "$id": "http://redfish.dmtf.org/schemas/v1/SwitchMetrics.v1_1_0.json",
    "$ref": "#/definitions/SwitchMetrics",
    "$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": {
                "#SwitchMetrics.ClearCurrentPeriod": {
                    "$ref": "#/definitions/ClearCurrentPeriod"
                },
                "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"
        },
        "ClearCurrentPeriod": {
            "additionalProperties": false,
            "description": "This action sets the `CurrentPeriod` property's values to 0.",
            "longDescription": "This action shall set the `CurrentPeriod` property's values to 0.",
            "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"
        },
        "CurrentPeriod": {
            "additionalProperties": false,
            "description": "The memory metrics since the last switch reset or `ClearCurrentPeriod` action for a switch.",
            "longDescription": "This type shall describe the memory metrics since the last reset or `ClearCurrentPeriod` action for a switch.",
            "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": {
                "CorrectableECCErrorCount": {
                    "description": "The number of correctable errors of memory since reset.",
                    "longDescription": "This property shall contain the number of correctable errors of memory since reset.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "UncorrectableECCErrorCount": {
                    "description": "The number of uncorrectable errors of memory since reset.",
                    "longDescription": "This property shall contain the number of uncorrectable errors of memory since reset.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                }
            },
            "type": "object"
        },
        "InternalMemoryMetrics": {
            "additionalProperties": false,
            "description": "The memory metrics for a switch.",
            "longDescription": "This property shall contain properties that describe the memory metrics for a switch.",
            "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": {
                "CurrentPeriod": {
                    "$ref": "#/definitions/CurrentPeriod",
                    "description": "The memory metrics since the last reset for this switch.",
                    "longDescription": "This property shall contain properties that describe the metrics for the current period of memory for this switch."
                },
                "LifeTime": {
                    "$ref": "#/definitions/LifeTime",
                    "description": "The memory metrics for the lifetime of this switch.",
                    "longDescription": "This property shall contain properties that describe the metrics for the lifetime of memory for this switch."
                }
            },
            "type": "object"
        },
        "LifeTime": {
            "additionalProperties": false,
            "description": "The memory metrics for the lifetime for a switch.",
            "longDescription": "This type shall describe the memory metrics since manufacturing for a switch.",
            "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": {
                "CorrectableECCErrorCount": {
                    "description": "The number of correctable errors for the lifetime of the memory.",
                    "longDescription": "This property shall contain the number of correctable errors for the lifetime of memory.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "UncorrectableECCErrorCount": {
                    "description": "The number of uncorrectable errors for the lifetime of the memory.",
                    "longDescription": "This property shall contain the number of uncorrectable errors for the lifetime of memory.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                }
            },
            "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"
        },
        "SwitchMetrics": {
            "additionalProperties": false,
            "description": "The `SwitchMetrics` schema contains usage and health statistics for a switch device.",
            "longDescription": "This resource shall represent the metrics for a switch device in 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."
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "InternalMemoryMetrics": {
                    "$ref": "#/definitions/InternalMemoryMetrics",
                    "description": "The memory metrics for a switch.",
                    "longDescription": "This property shall contain properties that describe the memory metrics for a switch."
                },
                "LifetimeStartDateTime": {
                    "description": "The date and time when the switch started accumulating data for the `LifeTime` property.",
                    "format": "date-time",
                    "longDescription": "This property shall contain the date and time when the switch started accumulating data for the `LifeTime` property.  This might contain the same value as the production date of the switch.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_1_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."
                },
                "PCIeErrors": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeErrors",
                    "description": "The PCIe errors associated with this switch.",
                    "longDescription": "This property shall contain the PCIe errors associated with this switch."
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2025.3",
    "title": "#SwitchMetrics.v1_1_0.SwitchMetrics"
}