redfish-python-sdk 1.0.0__py3-none-any.whl

redfish_sdk/models/processor.py

@@ -0,0 +1,50 @@
+"""
+Processor (CPU) component models.
+
+"""
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from pydantic import BaseModel, ConfigDict
+
+from .check import Field
+from .common import Entity, Link, Status
+from .oem import Oem
+
+
+class ProcessorId(BaseModel):
+    """CPU identification fields."""
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    effective_family: Optional[str] = Field(None, alias="EffectiveFamily")
+    effective_model: Optional[str] = Field(None, alias="EffectiveModel")
+    identification_registers: Optional[str] = Field(None, alias="IdentificationRegisters")
+    microcode_info: Optional[str] = Field(None, alias="MicrocodeInfo")
+    step: Optional[str] = Field(None, alias="Step")
+    vendor_id: Optional[str] = Field(None, alias="VendorId")
+
+
+class Processor(Entity):
+    """
+    Represents a CPU/processor resource.
+    Endpoint: /redfish/v1/Systems/{systemId}/Processors/{processorId}
+
+    """
+    instruction_set: Optional[str] = Field(None, alias="InstructionSet")
+    manufacturer: Optional[str] = Field(None, alias="Manufacturer", validate="required,type=str")
+    max_speed_mhz: Optional[int] = Field(None, alias="MaxSpeedMHz", validate="type=int,gt=0")
+    model: Optional[str] = Field(None, alias="Model", validate="required,type=str")
+    operating_speed_mhz: Optional[int] = Field(None, alias="OperatingSpeedMHz")
+    processor_architecture: Optional[str] = Field(None, alias="ProcessorArchitecture")
+    processor_id: Optional[ProcessorId] = Field(None, alias="ProcessorId")
+    processor_type: Optional[str] = Field(None, alias="ProcessorType", validate="type=str")
+    socket: Optional[Any] = Field(None, alias="Socket")
+    total_cores: Optional[int] = Field(None, alias="TotalCores", validate="required,type=int,gt=0")
+    total_threads: Optional[int] = Field(None, alias="TotalThreads", validate="required,type=int,gt=0,gte_field=total_cores")
+    max_tdp_watts: Optional[int] = Field(None, alias="MaxTDPWatts")
+    tdp_watts: Optional[int] = Field(None, alias="TDPWatts")
+    serial_number: Optional[str] = Field(None, alias="SerialNumber")
+    status: Optional[Status] = Field(None, alias="Status", validate="status")
+    oem: Optional[Oem] = Field(None, alias="Oem")
+    environment_metrics: Optional[Link] = Field(None, alias="EnvironmentMetrics")

redfish_sdk/models/registry.py

@@ -0,0 +1,34 @@
+"""
+Registry models.
+
+"""
+from __future__ import annotations
+
+from typing import List, Optional
+
+from pydantic import Field
+
+from .common import Entity
+
+
+class Registry(Entity):
+    """
+    Represents a Redfish message registry.
+    Endpoint: /redfish/v1/Registries/{registryId}
+
+    Message registries contain descriptions of all possible messages the BMC may generate.
+    """
+    languages: Optional[List[str]] = Field(None, alias="Languages")
+    location: Optional[List[RegistryLocation]] = Field(None, alias="Location")
+    owning_entity: Optional[str] = Field(None, alias="OwningEntity")
+    registry_prefix: Optional[str] = Field(None, alias="RegistryPrefix")
+    registry_version: Optional[str] = Field(None, alias="RegistryVersion")
+
+
+class RegistryLocation(Entity):
+    """Location info for a registry file."""
+    archive_file: Optional[str] = Field(None, alias="ArchiveFile")
+    archive_uri: Optional[str] = Field(None, alias="ArchiveUri")
+    language: Optional[str] = Field(None, alias="Language")
+    publication_uri: Optional[str] = Field(None, alias="PublicationUri")
+    uri: Optional[str] = Field(None, alias="Uri")

redfish_sdk/models/resource_key.py

@@ -0,0 +1,70 @@
+"""
+Redfish resource key enumeration.
+
+Defines all known Redfish resource names as enum members,
+enabling IDE auto-completion and preventing typo errors.
+"""
+from enum import Enum
+
+
+class RedfishResource(str, Enum):
+    """
+    Redfish 资源标识枚举。
+
+    值（value）对应 Redfish JSON 中的字段名（即 @odata.id 的 key）。
+    按所属层级分组。
+
+    Usage::
+
+        from redfish_sdk import RedfishClient, RedfishResource
+
+        client = RedfishClient(host="10.0.0.1", username="admin", password="pwd")
+        processors_url = client.get_odata_id(RedfishResource.PROCESSORS)
+        # → "/redfish/v1/Systems/1/Processors"
+    """
+
+    # ── RootService 层 (/redfish/v1/) ──
+    SYSTEMS = "Systems"
+    CHASSIS = "Chassis"
+    MANAGERS = "Managers"
+    ACCOUNT_SERVICE = "AccountService"
+    SESSION_SERVICE = "SessionService"
+    EVENT_SERVICE = "EventService"
+    UPDATE_SERVICE = "UpdateService"
+    TASK_SERVICE = "TaskService"
+    CERTIFICATE_SERVICE = "CertificateService"
+    REGISTRIES = "Registries"
+    JSON_SCHEMAS = "JsonSchemas"
+    KEY_SERVICE = "KeyService"
+    COMPONENT_INTEGRITY = "ComponentIntegrity"
+
+    # ── System 层 (/redfish/v1/Systems/{id}) ──
+    PROCESSORS = "Processors"
+    MEMORY = "Memory"
+    STORAGE = "Storage"
+    BIOS = "Bios"
+    ETHERNET_INTERFACES = "EthernetInterfaces"
+    GRAPHICS_CONTROLLERS = "GraphicsControllers"
+    LOG_SERVICES = "LogServices"
+    NETWORK_INTERFACES = "NetworkInterfaces"
+    SECURE_BOOT = "SecureBoot"
+    SIMPLE_STORAGE = "SimpleStorage"
+    USB_CONTROLLERS = "USBControllers"
+    VIRTUAL_MEDIA = "VirtualMedia"
+    CERTIFICATES = "Certificates"
+    BOOT_OPTIONS = "BootOptions"
+
+    # ── Chassis 层 (/redfish/v1/Chassis/{id}) ──
+    THERMAL = "Thermal"
+    POWER = "Power"
+    DRIVES = "Drives"
+    NETWORK_ADAPTERS = "NetworkAdapters"
+    PCIE_DEVICES = "PCIeDevices"
+    SENSORS = "Sensors"
+
+    # ── Manager 层 (/redfish/v1/Managers/{id}) ──
+    NETWORK_PROTOCOL = "NetworkProtocol"
+    HOST_INTERFACES = "HostInterfaces"
+    SERIAL_INTERFACES = "SerialInterfaces"
+    DEDICATED_NETWORK_PORTS = "DedicatedNetworkPorts"
+    SECURITY_POLICY = "SecurityPolicy"

redfish_sdk/models/root.py

@@ -0,0 +1,50 @@
+"""
+Root service model.
+
+"""
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import Field
+
+from .common import Entity, Link
+from .oem import Oem
+
+
+class RootService(Entity):
+    """
+    The root Redfish service endpoint (/redfish/v1/).
+    Acts as the entry point and service index — contains links to all top-level resources.
+
+    """
+    redfish_version: Optional[str] = Field(None, alias="RedfishVersion")
+    vendor: Optional[str] = Field(None, alias="Vendor")
+    product: Optional[str] = Field(None, alias="Product")
+    uuid: Optional[str] = Field(None, alias="UUID")
+
+    # Top-level resource links
+    account_service: Optional[Link] = Field(None, alias="AccountService")
+    task_service: Optional[Link] = Field(None, alias="TaskService")
+    certificate_service: Optional[Link] = Field(None, alias="CertificateService")
+    chassis: Optional[Link] = Field(None, alias="Chassis")
+    component_integrity: Optional[Link] = Field(None, alias="ComponentIntegrity")
+    event_service: Optional[Link] = Field(None, alias="EventService")
+    session_service: Optional[Link] = Field(None, alias="SessionService")
+    tasks: Optional[Link] = Field(None, alias="Tasks")
+    systems: Optional[Link] = Field(None, alias="Systems")
+    update_service: Optional[Link] = Field(None, alias="UpdateService")
+    key_service: Optional[Link] = Field(None, alias="KeyService")
+    managers: Optional[Link] = Field(None, alias="Managers")
+    registries: Optional[Link] = Field(None, alias="Registries")
+    json_schemas: Optional[Link] = Field(None, alias="JsonSchemas")
+
+    # Links section (contains Sessions link)
+    links: Optional[RootLinks] = Field(None, alias="Links")
+
+    oem: Optional[Oem] = Field(None, alias="Oem")
+
+
+class RootLinks(Entity):
+    """Links section within RootService, contains the Sessions direct link."""
+    sessions: Optional[Link] = Field(None, alias="Sessions")

redfish_sdk/models/session.py

@@ -0,0 +1,42 @@
+"""
+Session service models.
+
+"""
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import Field
+
+from .common import Entity, Link, Status
+from .oem import Oem
+
+
+class SessionService(Entity):
+    """
+    The Session service manages client sessions.
+    Endpoint: /redfish/v1/SessionService
+    """
+    sessions: Optional[Link] = Field(None, alias="Sessions")
+    service_enabled: Optional[bool] = Field(None, alias="ServiceEnabled")
+    session_timeout: Optional[int] = Field(None, alias="SessionTimeout")
+    status: Optional[Status] = Field(None, alias="Status")
+
+
+class Session(Entity):
+    """
+    Represents a single active session between a client and the Redfish service.
+    Endpoint: /redfish/v1/SessionService/Sessions/{sessionId}
+
+    After creation, the response contains the X-Auth-Token in the response header
+    (not in the JSON body). The SDK automatically extracts and stores this token.
+
+    """
+    oem_session_type: Optional[str] = Field(None, alias="OemSessionType")
+    password: Optional[str] = Field(None, alias="Password")
+    session_type: Optional[str] = Field(None, alias="SessionType")
+    user_name: Optional[str] = Field(None, alias="UserName")
+    oem: Optional[Oem] = Field(None, alias="Oem")
+
+    # Populated by the SDK after session creation (from X-Auth-Token response header)
+    x_auth_token: Optional[str] = Field(None, exclude=True)

redfish_sdk/models/storage.py

@@ -0,0 +1,77 @@
+"""
+Storage component models.
+
+"""
+from __future__ import annotations
+
+from typing import List, Optional
+
+from pydantic import BaseModel, ConfigDict
+
+from .check import Field
+from .common import Entity, Link, Status
+
+
+class CacheSummary(BaseModel):
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    persistent_cache_size_mib: Optional[int] = Field(None, alias="PersistentCacheSizeMiB")
+    total_cache_size_mib: Optional[int] = Field(None, alias="TotalCacheSizeMiB")
+    status: Optional[Status] = Field(None, alias="Status")
+
+
+class Identifier(BaseModel):
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    durable_name: Optional[str] = Field(None, alias="DurableName")
+    durable_name_format: Optional[str] = Field(None, alias="DurableNameFormat")
+
+
+class StorageController(BaseModel):
+    """Embedded storage controller info within a Storage resource."""
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    odata_id: Optional[str] = Field(None, alias="@odata.id")
+    cache_summary: Optional[CacheSummary] = Field(None, alias="CacheSummary")
+    firmware_version: Optional[str] = Field(None, alias="FirmwareVersion")
+    identifiers: Optional[List[Identifier]] = Field(None, alias="Identifiers")
+    manufacturer: Optional[str] = Field(None, alias="Manufacturer")
+    member_id: Optional[str] = Field(None, alias="MemberId")
+    model: Optional[str] = Field(None, alias="Model")
+    name: Optional[str] = Field(None, alias="Name")
+    part_number: Optional[str] = Field(None, alias="PartNumber")
+    serial_number: Optional[str] = Field(None, alias="SerialNumber")
+    speed_gbps: Optional[int] = Field(None, alias="SpeedGbps")
+    status: Optional[Status] = Field(None, alias="Status")
+    supported_controller_protocols: Optional[List[str]] = Field(
+        None, alias="SupportedControllerProtocols"
+    )
+    supported_device_protocols: Optional[List[str]] = Field(
+        None, alias="SupportedDeviceProtocols"
+    )
+
+
+class Storage(Entity):
+    """
+    Represents a storage controller.
+    Endpoint: /redfish/v1/Systems/{systemId}/Storage/{storageId}
+
+    """
+    drives: Optional[List[Link]] = Field(None, alias="Drives", validate="list")
+    storage_controllers: Optional[List[StorageController]] = Field(
+        None, alias="StorageControllers", validate="list"
+    )
+    volumes: Optional[Link] = Field(None, alias="Volumes")
+    status: Optional[Status] = Field(None, alias="Status", validate="status")
+
+
+class Volume(Entity):
+    """
+    Represents a storage volume.
+    Endpoint: /redfish/v1/Systems/{systemId}/Storage/{storageId}/Volumes/{volumeId}
+    """
+    volume_type: Optional[str] = Field(None, alias="VolumeType")
+    capacity_bytes: Optional[int] = Field(None, alias="CapacityBytes")
+    status: Optional[Status] = Field(None, alias="Status")
+    raid_type: Optional[str] = Field(None, alias="RAIDType")
+    optimum_io_size_bytes: Optional[int] = Field(None, alias="OptimumIOSizeBytes")

redfish_sdk/models/systems.py

@@ -0,0 +1,194 @@
+"""
+Systems resource models.
+
+"""
+from __future__ import annotations
+
+from typing import Any, List, Optional
+
+from pydantic import BaseModel, ConfigDict
+
+from .check import Field
+from .common import Entity, Link, Status
+from .gpu import Gpu, GpuOEM  # noqa: F401
+from .memory import Memory, MemoryLocation  # noqa: F401
+from .oem import Oem
+
+# ---------------------------------------------------------------------------
+# Re-export component models for backward compatibility
+# ---------------------------------------------------------------------------
+from .processor import Processor, ProcessorId  # noqa: F401
+from .storage import (  # noqa: F401
+    CacheSummary,
+    Identifier,
+    Storage,
+    StorageController,
+    Volume,
+)
+
+# ---------------------------------------------------------------------------
+# Boot
+# ---------------------------------------------------------------------------
+
+class Boot(BaseModel):
+    """
+    Boot configuration for a system.
+    Controls boot source override (e.g., PXE, HDD, CD-ROM).
+    """
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    boot_options: Optional[Link] = Field(None, alias="BootOptions")
+    boot_source_override_enabled: Optional[str] = Field(None, alias="BootSourceOverrideEnabled")
+    boot_source_override_mode: Optional[str] = Field(None, alias="BootSourceOverrideMode")
+    boot_source_override_target: Optional[str] = Field(None, alias="BootSourceOverrideTarget")
+    uefi_target_boot_source_override: Optional[str] = Field(None, alias="UefiTargetBootSourceOverride")
+    allowable_values: Optional[List[str]] = Field(
+        None, alias="BootSourceOverrideTarget@Redfish.AllowableValues"
+    )
+
+
+class BootSetting(BaseModel):
+    """Request body for changing boot source via PATCH /redfish/v1/Systems/{id}."""
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    boot_source_override_enabled: Optional[str] = Field(None, alias="BootSourceOverrideEnabled")
+    boot_source_override_mode: Optional[str] = Field(None, alias="BootSourceOverrideMode")
+    boot_source_override_target: Optional[str] = Field(None, alias="BootSourceOverrideTarget")
+
+
+class SystemPatchSetting(BaseModel):
+    """PATCH request body for system-level settings (e.g., boot source)."""
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    boot: Optional[BootSetting] = Field(None, alias="Boot")
+
+
+# ---------------------------------------------------------------------------
+# BootOption
+# ---------------------------------------------------------------------------
+
+class BootOption(Entity):
+    """
+    A single boot option entry in the BootOptions collection.
+    Endpoint: /redfish/v1/Systems/{id}/BootOptions/{optionId}
+
+    Distinct from the legacy Boot/BootSourceOverrideTarget model: modern BMCs
+    expose a per-option resource that can be enabled/disabled individually.
+    """
+    boot_option_reference: Optional[str] = Field(None, alias="BootOptionReference")
+    boot_option_enabled: Optional[bool] = Field(None, alias="BootOptionEnabled")
+    uefi_device_path: Optional[str] = Field(None, alias="UefiDevicePath")
+    display_name: Optional[str] = Field(None, alias="DisplayName")
+    alias: Optional[str] = Field(None, alias="Alias")
+
+
+class BootOptionPatchSetting(BaseModel):
+    """PATCH request body for toggling a single BootOption.BootOptionEnabled."""
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    boot_option_enabled: Optional[bool] = Field(None, alias="BootOptionEnabled")
+
+
+# ---------------------------------------------------------------------------
+# Actions
+# ---------------------------------------------------------------------------
+
+class ResetAction(BaseModel):
+    """Describes the Reset action target and allowable values."""
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    target: Optional[str] = Field(None, alias="target")
+    reset_type_allowable_values: Optional[List[str]] = Field(
+        None, alias="ResetType@Redfish.AllowableValues"
+    )
+    action_info: Optional[str] = Field(None, alias="@Redfish.ActionInfo")
+
+
+class SystemActions(BaseModel):
+    """Actions available on a system resource (e.g., Reset)."""
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    computer_system_reset: Optional[ResetAction] = Field(
+        None, alias="#ComputerSystem.Reset"
+    )
+    reset_type_allowable_values: Optional[List[str]] = Field(
+        None, alias="ResetType@Redfish.AllowableValues"
+    )
+
+
+# ---------------------------------------------------------------------------
+# System Links
+# ---------------------------------------------------------------------------
+
+class SystemLinks(BaseModel):
+    """Links section within a System resource."""
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    chassis: Optional[List[Link]] = Field(None, alias="Chassis")
+    pcie_devices: Optional[List[Link]] = Field(None, alias="PCIeDevices")
+    managed_by: Optional[List[Link]] = Field(None, alias="ManagedBy")
+
+
+# ---------------------------------------------------------------------------
+# System
+# ---------------------------------------------------------------------------
+
+class System(Entity):
+    """
+    Represents a single computer system (physical server).
+    Endpoint: /redfish/v1/Systems/{systemId}
+
+    """
+    actions: Optional[SystemActions] = Field(None, alias="Actions")
+    asset_tag: Optional[str] = Field(None, alias="AssetTag")
+    bios_version: Optional[str] = Field(None, alias="BiosVersion", validate="type=str")
+    bios: Optional[Link] = Field(None, alias="Bios")
+    host_name: Optional[str] = Field(None, alias="HostName")
+    indicator_led: Optional[str] = Field(None, alias="IndicatorLED")
+    last_reset_time: Optional[str] = Field(None, alias="LastResetTime")
+    part_number: Optional[str] = Field(None, alias="PartNumber")
+    power_state: Optional[str] = Field(None, alias="PowerState", validate="required,oneof=On Off PoweringOn PoweringOff")
+    sub_model: Optional[str] = Field(None, alias="SubModel")
+    system_type: Optional[str] = Field(None, alias="SystemType", validate="type=str")
+    manufacturer: Optional[str] = Field(None, alias="Manufacturer", validate="required,type=str")
+    model: Optional[str] = Field(None, alias="Model", validate="required,type=str")
+    serial_number: Optional[str] = Field(None, alias="SerialNumber", validate="required,type=str")
+    sku: Optional[str] = Field(None, alias="SKU")
+    uuid: Optional[str] = Field(None, alias="UUID", validate="type=str")
+    power_restore_policy: Optional[str] = Field(None, alias="PowerRestorePolicy")
+
+    # Sub-resource links
+    certificates: Optional[Link] = Field(None, alias="Certificates")
+    ethernet_interfaces: Optional[Link] = Field(None, alias="EthernetInterfaces")
+    graphics_controllers: Optional[Link] = Field(None, alias="GraphicsControllers")
+    log_services: Optional[Link] = Field(None, alias="LogServices")
+    memory: Optional[Link] = Field(None, alias="Memory")
+    storage: Optional[Link] = Field(None, alias="Storage")
+    processors: Optional[Link] = Field(None, alias="Processors")
+    secure_boot: Optional[Link] = Field(None, alias="SecureBoot")
+    simple_storage: Optional[Link] = Field(None, alias="SimpleStorage")
+    usb_controllers: Optional[Link] = Field(None, alias="USBControllers")
+    virtual_media: Optional[Link] = Field(None, alias="VirtualMedia")
+    network_interfaces: Optional[Link] = Field(None, alias="NetworkInterfaces")
+
+    # PCIe devices (array of links)
+    pcie_devices: Optional[List[Link]] = Field(None, alias="PCIeDevices")
+    pcie_devices_count: Optional[int] = Field(None, alias="PCIeDevices@odata.count")
+
+    boot: Optional[Boot] = Field(None, alias="Boot")
+    links: Optional[SystemLinks] = Field(None, alias="Links")
+    status: Optional[Status] = Field(None, alias="Status", validate="status")
+    oem: Optional[Oem] = Field(None, alias="Oem")
+
+
+# ---------------------------------------------------------------------------
+# BIOS
+# ---------------------------------------------------------------------------
+
+class Bios(Entity):
+    """
+    BIOS settings resource.
+    Endpoint: /redfish/v1/Systems/{systemId}/Bios
+    """
+    bios_version: Optional[str] = Field(None, alias="BiosVersion")
+    attributes: Optional[Any] = Field(None, alias="Attributes")

redfish_sdk/models/task.py

@@ -0,0 +1,54 @@
+"""
+Task service models.
+
+"""
+from __future__ import annotations
+
+from typing import List, Optional
+
+from pydantic import Field
+
+from .common import Entity, Link, Status
+
+
+class TaskService(Entity):
+    """
+    The Task service manages asynchronous tasks.
+    Endpoint: /redfish/v1/TaskService
+    """
+    tasks: Optional[Link] = Field(None, alias="Tasks")
+    completion_task_over_write_policy: Optional[str] = Field(
+        None, alias="CompletionTaskOverWritePolicy"
+    )
+    date_time: Optional[str] = Field(None, alias="DateTime")
+    life_cycle_event_on_task_state_change: Optional[bool] = Field(
+        None, alias="LifeCycleEventOnTaskStateChange"
+    )
+    service_enabled: Optional[bool] = Field(None, alias="ServiceEnabled")
+    status: Optional[Status] = Field(None, alias="Status")
+
+
+class Message(Entity):
+    """A message associated with a task."""
+    message: Optional[str] = Field(None, alias="Message")
+    message_args: Optional[List[str]] = Field(None, alias="MessageArgs")
+    message_id: Optional[str] = Field(None, alias="MessageId")
+    resolution: Optional[str] = Field(None, alias="Resolution")
+    severity: Optional[str] = Field(None, alias="Severity")
+
+
+class Task(Entity):
+    """
+    Represents an asynchronous task.
+    Endpoint: /redfish/v1/TaskService/Tasks/{taskId}
+
+    Long-running operations (e.g., firmware update) return a Task resource.
+    """
+    end_time: Optional[str] = Field(None, alias="EndTime")
+    messages: Optional[List[Message]] = Field(None, alias="Messages")
+    percent_complete: Optional[int] = Field(None, alias="PercentComplete")
+    start_time: Optional[str] = Field(None, alias="StartTime")
+    task_monitor: Optional[str] = Field(None, alias="TaskMonitor")
+    task_state: Optional[str] = Field(None, alias="TaskState")
+    task_status: Optional[str] = Field(None, alias="TaskStatus")
+    status: Optional[Status] = Field(None, alias="Status")