Merge pull request #127 from PranavDarshan/main

Extend Capabilities of Redfish Emulator: Reset Support, Config Updates, Virtual Media, and RAID Volume Management

Author: mraineri

README.md

@@ -338,8 +338,11 @@ These dynamic resources are available in the [Redfish Interface Emulator reposit
 | ./Systems/{id}/Memory | memory.py  
 | ./Systems/{id}/Processors/{id} | processor.py   
 | ./Systems/{id}/SimpleStorage/{id} | simple_storage.py  
+| ./Systems/{id}/Bios | Bios_api.py   
+| ./Systems/{id}/Bios/Settings | BiosSettings_api.py  
 | ./Managers/{id} | Manager_api.py   
-
+| ./Managers/{id}/VirtualMedia | VirtualMedia_api.py
+| ./Managers/{id}/VirtualMedia/{id} | VirtualMedia_api.py
 
 ## SNIA API Emulator
 
@@ -360,7 +363,7 @@ These dynamic resources are available in the [SNIA API Emulator repository](http
 | ./Chassis/{id}/NetworkAdapters/{id}/NetworkDeviceFunctions/{id} | networkdevicefunctions_api.py  
 | ./Chassis/{id}/NetworkAdapters/{id}/Ports/{id} | nwports_api\.py
 | ./Systems/{id} | ComputerSystem_api.py   
-| ./Systems/{id}/Storage/{id}/Volumes/{id} | volumes_api  
+| ./Systems/{id}/Storage/{id}/Volumes/{id} | Volume_api.py  
 | ./Systems/{id}/Storage/{id}/StoragePools/{id} | storagepools_api.py  
 | ./Systems/{id}/Memory/{id} | memory.py
 | ./Systems/{id}/Memory/{id}/MemoryDomains/{id} | memory_domains_api.py

api_emulator/redfish/BiosSettings_api.py

@@ -0,0 +1,81 @@
+import g
+import sys, traceback
+import logging
+import copy
+from flask import Flask, request, make_response
+from flask_restful import reqparse, Api, Resource
+
+# Import BIOS settings template function
+from .templates.bios_settings import get_Bios_Settings_instance
+
+# Dictionary to store BIOS settings for multiple systems
+bios_setting = {}  
+INTERNAL_ERROR = 500
+
+ALLOWED_BIOS_ATTRIBUTES = {
+    "AdminPhone": str,
+    "BootMode": str,
+    "EmbeddedSata": str,
+    "NicBoot1": str,
+    "NicBoot2": str,
+    "PowerProfile": str,
+    "ProcCoreDisable": int,
+    "ProcHyperthreading": ["Enabled", "Disabled"],
+    "ProcTurboMode": ["Enabled", "Disabled"],
+    "UsbControl": str
+}
+
+# BIOS Settings Singleton API
+class BiosSettingsAPI(Resource):
+
+    def __init__(self, **kwargs):
+        logging.info('BiosSettingsAPI init called')
+        self.rb = kwargs.get('rb', '')  # Get the Redfish base URL
+
+    # HTTP GET - Retrieve BIOS settings for a specific system
+    def get(self, ident):
+        logging.info(f'BiosSettingsAPI GET called for system {ident}')
+        try:
+            global bios_setting
+            # Check if the system already exists, if not, create it
+            if ident not in bios_setting:
+                bios_setting[ident] = get_Bios_Settings_instance({'rb': self.rb, 'id': ident})
+            
+            return bios_setting[ident], 200
+        except Exception:
+            traceback.print_exc()
+            return {"error": "Internal server error"}, INTERNAL_ERROR
+
+    # HTTP PATCH - Update BIOS settings for a specific system
+    def patch(self, ident):
+        logging.info(f'BiosSettingsAPI PATCH called for system {ident}')
+        try:
+            global bios_setting
+            if not request.json:
+                return "Invalid input, expected JSON", 400
+
+            # Ensure the system exists
+            if ident not in bios_setting:
+                bios_setting[ident] = get_Bios_Settings_instance({'rb': self.rb, 'id': ident})
+
+            # Update only the specified attributes
+            for key, value in request.json.items():
+                if key not in ALLOWED_BIOS_ATTRIBUTES:
+                    return {"error": f"Invalid BIOS attribute: {key}"}, 400
+                allowed_type = ALLOWED_BIOS_ATTRIBUTES[key]
+
+                if isinstance(allowed_type, list):
+                    if value not in allowed_type:
+                        return {"error": f"Invalid value for {key}. Must be one of {allowed_type}"}, 400
+                elif not isinstance(value, allowed_type):
+                    return {"error": f"Invalid type for {key}. Expected {allowed_type.__name__}"}, 400
+                bios_setting[ident]['Attributes'][key] = value
+            return bios_setting[ident], 200
+        except Exception:
+            traceback.print_exc()
+            return INTERNAL_ERROR
+        
+def get_bios_settings(ident):
+    if ident not in bios_setting:
+        bios_setting[ident] = get_Bios_Settings_instance({'rb': '/redfish/v1/', 'id': ident})
+    return bios_setting[ident]

api_emulator/redfish/Bios_api.py

@@ -0,0 +1,86 @@
+import g
+import sys, traceback
+import logging
+import copy
+from flask import Flask, request, make_response
+from flask_restful import reqparse, Api, Resource
+
+# Resource and SubResource imports
+from .templates.Bios import get_Bios_instance
+
+bios_config = {}
+INTERNAL_ERROR = 500
+
+# BIOS Singleton API
+class BiosAPI(Resource):
+    def __init__(self, **kwargs):
+        logging.info('BiosAPI init called')
+        self.rb = kwargs.get('rb', '')  # Get the Redfish base URL
+
+    # HTTP GET
+    def get(self, ident):  # Add 'ident' to capture the system ID from the URL
+        logging.info(f'BiosAPI GET called for system {ident}')
+        try:
+            global bios_config
+            # Pass the extracted 'ident' (system ID) to get_Bios_instance
+            if ident not in bios_config:
+                bios_config[ident] = get_Bios_instance({'rb': self.rb, 'id': ident})  
+            return bios_config[ident], 200
+        except Exception:
+            traceback.print_exc()
+            return INTERNAL_ERROR
+        
+def get_bios_config(ident):
+    """
+    Returns the current bios_config
+    """
+    try:
+        global bios_config
+        # Pass the extracted 'ident' (system ID) to get_Bios_instance
+        if ident not in bios_config:
+            bios_config = get_Bios_instance({'rb': '/redfish/v1/', 'id': ident})  
+        return bios_config[ident]
+    except Exception:
+        traceback.print_exc()
+    return bios_config
+
+def set_bios_config(ident, data):
+    """
+    Sets bios_config[ident] by calling get_Bios_instance.
+    You can call this from any other module.
+    """
+    try:
+        global bios_config
+        if ident not in bios_config:
+            bios_config[ident] = get_Bios_instance({'rb': "/redfish/v1/", 'id': ident})
+        
+        for key, value in data['Attributes'].items():
+                bios_config[ident]['Attributes'][key] = value
+                
+    except Exception as e:
+        logging.error(f"Error setting BIOS config: {e}")
+        traceback.print_exc()
+
+class BiosResetDefaultAPI(Resource):
+    def __init__(self, **kwargs):
+        logging.info('BiosResetDefaultAPI init called')
+        logging.info('ResetBiosToDefaultsPending set to true')
+        self.rb = kwargs.get('rb', '')  # Get the Redfish base URL
+
+    def post(self, ident):
+        """ 
+        Sets the ResetBiosToDefaultsPending to true and 
+        waits for a computer reset to reset back to defaults
+        """
+        try:
+            global bios_config
+            # Pass the extracted 'ident' (system ID) to get_Bios_instance
+            if ident not in bios_config:
+                bios_config[ident] = get_Bios_instance({'rb': self.rb, 'id': ident})
+
+            # bios_config[ident]["ResetBiosToDefaultsPending"] is a string
+            bios_config[ident]["ResetBiosToDefaultsPending"] = "true"  
+            return bios_config[ident], 200
+        except Exception:
+            traceback.print_exc()
+            return INTERNAL_ERROR

api_emulator/redfish/Chassis_api.py

@@ -16,7 +16,9 @@
 import copy
 from flask import Flask, request, make_response, render_template
 from flask_restful import reqparse, Api, Resource
-
+from .ResetActionInfo_api import ResetActionInfo_API
+from .ResetAction_api import ResetAction_API
+from api_emulator.redfish.ComputerSystem.ResetActionInfo_template import get_ResetActionInfo_instance
 # Resource and SubResource imports
 from .templates.Chassis import get_Chassis_instance
 from .thermal_api import ThermalAPI, CreateThermal
@@ -71,6 +73,7 @@ def put(self, ident):
     # PATCH commands can then be used to update the new instance.
     def post(self, ident):
         logging.info('ChassisAPI POST called')
+        return 'POST is not a supported command for ChassisAPI', 405
         try:
             global config
             global wildcards
@@ -89,6 +92,7 @@ def post(self, ident):
     # HTTP PATCH
     def patch(self, ident):
         logging.info('ChassisAPI PATCH called')
+        return 'PATCH is not a supported command for ChassisAPI', 405
         raw_dict = request.get_json(force=True)
         try:
             # Update specific portions of the identified object
@@ -103,6 +107,7 @@ def patch(self, ident):
     # HTTP DELETE
     def delete(self, ident):
         logging.info('ChassisAPI DELETE called')
+        return 'DELETE is not a supported command for ChassisAPI', 405
         try:
             # Find the entry with the correct value for Id
             resp = 404
@@ -156,6 +161,7 @@ def verify(self, config):
     # TODO: 'id' should be obtained from the request data.
     def post(self):
         logging.info('ChassisCollectionAPI POST called')
+        return 'POST is not a supported command for ChassisCollectionAPI', 405
         try:
             config = request.get_json(force=True)
             ok, msg = self.verify(config)
@@ -213,3 +219,65 @@ def put(self, ident):
             resp = INTERNAL_ERROR
         logging.info('CreateChassis init exit')
         return resp
+
+class ChassisResetAPI(Resource):
+    def __init__(self, **kwargs):
+        logging.info('ChassisResetAPI init called')
+        global wildcards  
+        wildcards = kwargs  
+
+
+    def post(self, ident):
+        logging.info(f'ChassisResetAPI POST called for {ident}')
+        try:
+            global wildcards 
+
+            if ident not in members:
+                logging.error(f"Chassis {ident} not found in members.")
+                return {"error": f"Chassis {ident} not found"}, 404
+
+
+
+            req = request.get_json()
+            if not req or "ResetType" not in req:
+                return {"error": "Missing ResetType"}, 400
+
+            wildcards['id'] = ident
+            wildcards['rb'] = "/redfish/v1/"
+            reset_info = get_ResetActionInfo_instance(wildcards)
+            valid_reset_types = reset_info["Parameters"][0]["AllowableValues"]
+
+            reset_type = req["ResetType"]
+            if reset_type not in valid_reset_types:
+                return {"error": f"Invalid ResetType: {reset_type}"}, 400
+
+            power_state_map = {
+                "On": "On",
+                "ForceOn": "On",
+                "ForceOff": "Off",
+                "GracefulShutdown": "Off",
+                "GracefulRestart": "On",
+                "ForceRestart": "On",
+                "Nmi": "Interrupt sent"
+            }
+
+            # Ensure PowerState exists
+            if "PowerState" not in members[ident]:
+                logging.warning(f"'PowerState' key missing in {ident}, initializing it.")
+                members[ident]["PowerState"] = "Unknown"
+
+            # Update PowerState
+            if(reset_type!="PushPowerButton"):
+                members[ident]["PowerState"] = power_state_map.get(reset_type, "Unknown")
+            else:
+                members[ident]["PowerState"]="On" if members[ident]["PowerState"]=="Off" else "Off"
+            # Prepare response
+            response = copy.deepcopy(reset_info)
+            response["Parameters"][0]["Value"] = reset_type 
+            response["Message"] = f"{ident} reset with {reset_type}"
+            response["PowerState"] = members[ident]["PowerState"]
+            return response
+        except Exception as e:
+            logging.error(f"Error in Reset API: {e}")
+            traceback.print_exc()
+            return "Internal Server Error", INTERNAL_ERROR

api_emulator/redfish/ComputerSystem/ResetActionInfo_template.py

@@ -8,7 +8,6 @@
 {
 	"@Redfish.Copyright": "Copyright 2014-2016 DMTF. All rights reserved.",
 	"@odata.context": "{rb}$metadata#ActionInfo.ActionInfo",
-	"@odata.id": "{rb}Systems/{sys_id}/ResetActionInfo",
 	"@odata.type": "#ActionInfo.v1_0_0.ActionInfo",
 	"Parameters": [{
 		"Name": "ResetType",
@@ -31,6 +30,6 @@ def get_ResetActionInfo_instance(wildcards):
     c = copy.deepcopy(_TEMPLATE)
     print (wildcards)
     c['@odata.context']=c['@odata.context'].format(**wildcards)
-    c['@odata.id']=c['@odata.id'].format(**wildcards)
+    
 
     return c