sushy.resources.system 包¶
子包¶
- sushy.resources.system.network 包
- 子模块
- sushy.resources.system.network.adapter 模块
ControllersListFieldNetworkAdapterNetworkAdapter.controllersNetworkAdapter.descriptionNetworkAdapter.identityNetworkAdapter.manufacturerNetworkAdapter.modelNetworkAdapter.nameNetworkAdapter.network_device_functionsNetworkAdapter.network_portsNetworkAdapter.part_numberNetworkAdapter.portsNetworkAdapter.serial_numberNetworkAdapter.status
NetworkAdapterCollection
- sushy.resources.system.network.constants 模块
- sushy.resources.system.network.device_function 模块
BootTargetsFieldEthernetFieldFibreChannelFieldISCSIBootFieldISCSIBootField.authentication_methodISCSIBootField.initiator_default_gatewayISCSIBootField.initiator_ip_addressISCSIBootField.initiator_netmaskISCSIBootField.ip_address_typeISCSIBootField.primary_dnsISCSIBootField.primary_lunISCSIBootField.primary_target_ip_addressISCSIBootField.primary_target_tcp_portISCSIBootField.primary_vlan_enabledISCSIBootField.primary_vlan_idISCSIBootField.secondary_dnsISCSIBootField.secondary_lunISCSIBootField.secondary_target_ip_addressISCSIBootField.secondary_target_tcp_portISCSIBootField.secondary_vlan_enabledISCSIBootField.secondary_vlan_id
NetworkDeviceFunctionNetworkDeviceFunction.assignable_physical_portsNetworkDeviceFunction.capabilitiesNetworkDeviceFunction.descriptionNetworkDeviceFunction.ethernetNetworkDeviceFunction.fibre_channelNetworkDeviceFunction.identityNetworkDeviceFunction.iscsi_bootNetworkDeviceFunction.max_virtual_functionsNetworkDeviceFunction.nameNetworkDeviceFunction.statusNetworkDeviceFunction.type
NetworkDeviceFunctionCollectionVLANField
- sushy.resources.system.network.port 模块
- 模块内容
- sushy.resources.system.storage 包
- 子模块
- sushy.resources.system.storage.constants 模块
- sushy.resources.system.storage.controller 模块
ControllerCollectionStorageControllerStorageController.controller_protocolsStorageController.device_protocolsStorageController.identifiersStorageController.identityStorageController.nameStorageController.pending_settingsStorageController.raid_typesStorageController.speed_gbpsStorageController.statusStorageController.supported_apply_timesStorageController.update()
- sushy.resources.system.storage.drive 模块
- sushy.resources.system.storage.storage 模块
StorageStorageCollectionStorageControllersListFieldStorageControllersListField.controller_protocolsStorageControllersListField.device_protocolsStorageControllersListField.identifiersStorageControllersListField.member_idStorageControllersListField.nameStorageControllersListField.raid_typesStorageControllersListField.speed_gbpsStorageControllersListField.status
- sushy.resources.system.storage.volume 模块
- 模块内容
子模块¶
sushy.resources.system.bios 模块¶
- class sushy.resources.system.bios.ActionsField(*args, **kwargs)¶
基类:
CompositeField- change_password = <sushy.resources.common.ActionField object>¶
- reset_bios = <sushy.resources.common.ActionField object>¶
- class sushy.resources.system.bios.Bios(connector, path, redfish_version=None, registries=None, root=None)¶
基类:
ResourceBase- property apply_time_settings¶
- attributes = <sushy.resources.base.Field object>¶
Vendor-specific key-value dict of effective BIOS attributes
Attributes cannot be updated directly. To update use
set_attribute()orset_attributes()
- change_password(new_password, old_password, password_name)¶
Change BIOS password
- description = <sushy.resources.base.Field object>¶
Human-readable description of the BIOS resource
- get_attribute_registry(language='en')¶
Get the Attribute Registry associated with this BIOS instance
- 参数:
language – RFC 5646 language code for Message Registries. Indicates language of registry to be used. Defaults to ‘en’.
- 返回值:
the BIOS Attribute Registry
- identity = <sushy.resources.base.Field object>¶
The Bios resource identity string
- maintenance_window = <sushy.resources.settings.MaintenanceWindowField object>¶
Indicates if a given resource has a maintenance window assignment for applying settings or operations
- name = <sushy.resources.base.Field object>¶
资源的名称
- property pending_attributes¶
Pending BIOS attributes
BIOS attributes that have been committed to the system, but for them to take effect system restart is necessary
- reset_bios()¶
Reset the BIOS attributes to default
- set_attribute(key, value, apply_time=None, maint_window_start_time=None, maint_window_duration=None)¶
Update an attribute
Attribute update is not immediate but requires system restart. Committed attributes can be checked at
pending_attributesproperty- 参数:
key – Attribute name
value – Attribute value
apply_time – When to update the attribute. Optional. An
sushy.ApplyTimevalue.maint_window_start_time – The start time of a maintenance window, datetime. Required when updating during maintenance window and default maintenance window not set by the system.
maint_window_duration – Duration of maintenance time since maintenance window start time in seconds. Required when updating during maintenance window and default maintenance window not set by the system.
- set_attributes(value, apply_time=None, maint_window_start_time=None, maint_window_duration=None)¶
Update many attributes at once
Attribute update is not immediate but requires system restart. Committed attributes can be checked at
pending_attributesproperty- 参数:
value – Key-value pairs for attribute name and value
apply_time – When to update the attributes. Optional. An
sushy.ApplyTimevalue.maint_window_start_time – The start time of a maintenance window, datetime. Required when updating during maintenance window and default maintenance window not set by the system.
maint_window_duration – Duration of maintenance time since maintenance window start time in seconds. Required when updating during maintenance window and default maintenance window not set by the system.
- property supported_apply_times¶
List of supported BIOS update apply times
- 返回值:
List of supported update apply time names
- property update_status¶
Status of the last attribute update
- 返回值:
sushy.resources.settings.SettingsUpdateobject containing status and any messages
sushy.resources.system.constants 模块¶
- class sushy.resources.system.constants.BootProgressStates(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
基础:
Enum启动系统进度指示器常量
- BUS = 'BusInitializationStarted'¶
总线初始化已开始。
- HARDWARE_COMPLETE = 'SystemHardwareInitializationComplete'¶
硬件初始化完成。
- MEMORY = 'MemoryInitializationStarted'¶
内存初始化已开始。
- NONE = 'None'¶
系统未启动。
- OEM = 'OEM'¶
OEM定义的启动进度状态。
- OS_BOOT_STARTED = 'OSBootStarted'¶
操作系统启动已开始。
- OS_RUNNING = 'OSRunning'¶
操作系统正在运行。
- PCI_RESOURCE_CONFIG = 'PCIResourceConfigStarted'¶
PCI资源初始化已开始。
- PRIMARY_PROCESSOR = 'PrimaryProcessorInitializationStarted'¶
主处理器初始化已开始。
- SECONDARY_PROCESSOR = 'SecondaryProcessorInitializationStarted'¶
辅助处理器已开始初始化。
- SETUP = 'SetupEntered'¶
系统处于设置实用程序中。
- class sushy.resources.system.constants.BootSource(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
基础:
Enum启动源目标常量
- BIOS_SETUP = 'BiosSetup'¶
启动到BIOS设置实用程序。
- CD = 'Cd'¶
从CD或DVD启动。
- DIAGS = 'Diags'¶
启动到制造商的诊断程序。
- FLOPPY = 'Floppy'¶
从软盘驱动器启动。
- HDD = 'Hdd'¶
从硬盘启动。
- NONE = 'None'¶
从正常的启动设备启动。
- PXE = 'Pxe'¶
从预启动执行环境 (PXE) 启动。
- REMOTE_DRIVE = 'RemoteDrive'¶
从远程驱动器启动,例如iSCSI目标。
- SD_CARD = 'SDCard'¶
从SD卡启动。
- UEFI_BOOT_NEXT = 'UefiBootNext'¶
启动到UEFI设备,该设备由BootNext属性指定。
- UEFI_HTTP = 'UefiHttp'¶
从UEFI HTTP网络位置启动。
- UEFI_SHELL = 'UefiShell'¶
启动到UEFI Shell。
- UEFI_TARGET = 'UefiTarget'¶
启动到UEFI设备,该设备由UefiTargetBootSourceOverride属性指定。
- USB = 'Usb'¶
从系统BIOS指定的USB设备启动。
- USB_CD = 'UsbCd'¶
从USB CD设备启动,由系统BIOS指定。
这不是标准值! 在SuperMicro X11和X12机器上,虚拟媒体被呈现为USB CD驱动器,而不是CD驱动器。两者都存在于启动设备列表中,但是只有选择UsbCd作为启动源才能成功从vMedia启动。如果选择CD,即使插入了vMedia,启动也会失败。
- UTILITIES = 'Utilities'¶
启动到制造商的实用程序或程序。
- class sushy.resources.system.constants.BootSourceOverrideEnabled(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
基础:
Enum启动源启用常量
- CONTINUOUS = 'Continuous'¶
系统将启动到BootSourceOverrideTarget属性中指定的目标,直到此属性被禁用为止。
- DISABLED = 'Disabled'¶
系统正常启动。
- ONCE = 'Once'¶
在下一次启动周期中,系统将启动一次到启动源覆盖目标。然后,BootSourceOverrideEnabled值将重置为禁用。
- class sushy.resources.system.constants.BootSourceOverrideMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
基础:
Enum启动源模式常量
- LEGACY = 'Legacy'¶
系统以非UEFI启动模式启动到启动源覆盖目标。
- UEFI = 'UEFI'¶
系统以UEFI启动模式启动到启动源覆盖目标。
- class sushy.resources.system.constants.InstructionSet(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
基础:
Enum处理器指令集常量
- ARM_A32 = 'ARM-A32'¶
ARM 32位。
- ARM_A64 = 'ARM-A64'¶
ARM 64位。
- IA_64 = 'IA-64'¶
Intel IA-64。
- MIPS32 = 'MIPS32'¶
MIPS 32位。
- MIPS64 = 'MIPS64'¶
MIPS 64位。
- OEM = 'OEM'¶
OEM定义。
- POWER_ISA = 'PowerISA'¶
PowerISA-64 或 PowerISA-32。
- X86 = 'x86'¶
x86 32位。
- X86_64 = 'x86-64'¶
x86 64位。
- class sushy.resources.system.constants.ProcessorArchitecture(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
基础:
Enum处理器架构常量
- ARM = 'ARM'¶
ARM。
- IA_64 = 'IA-64'¶
Intel Itanium。
- MIPS = 'MIPS'¶
MIPS。
- OEM = 'OEM'¶
OEM定义。
- POWER = 'Power'¶
Power。
- X86 = 'x86'¶
x86 或 x86-64。
- class sushy.resources.system.constants.ProcessorType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
基础:
Enum处理器类型常量
- ACCELERATOR = 'Accelerator'¶
加速器。
- CORE = 'Core'¶
处理器中的核心。
- CPU = 'CPU'¶
CPU。
- DSP = 'DSP'¶
DSP。
- FPGA = 'FPGA'¶
FPGA。
- GPU = 'GPU'¶
GPU。
- OEM = 'OEM'¶
OEM定义的处理单元。
- THREAD = 'Thread'¶
处理器中的线程。
- sushy.resources.system.constants.SYSTEM_POWER_STATE_OFF = PowerState.OFF¶
系统已关电,尽管某些组件可能继续供电,例如管理控制器
- sushy.resources.system.constants.SYSTEM_POWER_STATE_ON = PowerState.ON¶
系统已开电
- sushy.resources.system.constants.SYSTEM_POWER_STATE_POWERING_OFF = PowerState.POWERING_OFF¶
在开和关之间的一个临时状态。关电操作可能需要时间,因为操作系统正在关机过程中
- sushy.resources.system.constants.SYSTEM_POWER_STATE_POWERING_ON = PowerState.POWERING_ON¶
在关和开之间的一个临时状态。这个临时状态可能非常短
- class sushy.resources.system.constants.SecureBootCurrentBoot(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
基础:
Enum- DISABLED = 'Disabled'¶
UEFI 安全启动当前已禁用。
- ENABLED = 'Enabled'¶
UEFI 安全启动当前已启用。
- class sushy.resources.system.constants.SecureBootDatabaseId(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
基础:
Enum- ALLOWED_KEYS_DATABASE = 'db'¶
- DEFAULT_ALLOWED_KEYS_DATABASE = 'dbDefault'¶
- DEFAULT_DENIED_KEYS_DATABASE = 'dbxDefault'¶
- DEFAULT_KEY_EXCHANGE_KEYS = 'KEKDefault'¶
- DEFAULT_PLATFORM_KEY = 'PKDefault'¶
- DEFAULT_RECOVERY_KEYS_DATABASE = 'dbrDefault'¶
- DEFAULT_TIMESTAMP_DATABASE = 'dbtDefault'¶
- DENIED_KEYS_DATABASE = 'dbx'¶
- KEY_EXCHANGE_KEYS = 'KEK'¶
- PLATFORM_KEY = 'PK'¶
- RECOVERY_KEYS_DATABASE = 'dbr'¶
- TIMESTAMP_DATABASE = 'dbt'¶
- class sushy.resources.system.constants.SecureBootMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
基础:
Enum- AUDIT = 'AuditMode'¶
UEFI 安全启动当前处于审计模式。
- DEPLOYED = 'DeployedMode'¶
UEFI 安全启动当前处于部署模式。
- SETUP = 'SetupMode'¶
UEFI 安全启动当前处于设置模式。
- USER = 'UserMode'¶
UEFI 安全启动当前处于用户模式。
- class sushy.resources.system.constants.SecureBootResetKeysType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
基础:
Enum- DELETE_ALL_KEYS = 'DeleteAllKeys'¶
删除所有 UEFI 安全启动密钥数据库的内容,包括 PK 密钥数据库。这将使系统进入设置模式。
- DELETE_PK = 'DeletePK'¶
删除 PK UEFI 安全启动数据库的内容。这将使系统进入设置模式。
- RESET_ALL_KEYS_TO_DEFAULT = 'ResetAllKeysToDefault'¶
将所有 UEFI 安全启动密钥数据库的内容,包括 PK 密钥数据库,重置为默认值。
- class sushy.resources.system.constants.SystemType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
基础:
Enum系统类型常量
- COMPOSED = 'Composed'¶
通过绑定资源块构建的计算机系统。
- DPU = 'DPU'¶
执行数据处理单元功能的计算机系统,例如 SmartNIC。
- OS = 'OS'¶
操作系统实例。
- PHYSICAL = 'Physical'¶
一台计算机系统。
- PHYSICALLY_PARTITIONED = 'PhysicallyPartitioned'¶
计算机系统的硬件分区。
- VIRTUAL = 'Virtual'¶
在此系统上运行的虚拟机实例。
- VIRTUALLY_PARTITIONED = 'VirtuallyPartitioned'¶
计算机系统的虚拟或软件分区。
sushy.resources.system.ethernet_interface 模块¶
- class sushy.resources.system.ethernet_interface.EthernetInterface(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)¶
基类:
ResourceBase此类添加 EthernetInterface 资源
- description = <sushy.resources.base.Field object>¶
描述
- identity = <sushy.resources.base.Field object>¶
以太网接口身份字符串
- mac_address = <sushy.resources.base.Field object>¶
这是接口当前配置的 MAC 地址。
- name = <sushy.resources.base.Field object>¶
资源或数组元素的名称
- permanent_mac_address = <sushy.resources.base.Field object>¶
这是分配给此接口(端口)的永久 MAC 地址
- speed_mbps = <sushy.resources.base.Field object>¶
这是此接口的当前速度,单位为 Mbps。
- status = <sushy.resources.common.StatusField object>¶
描述此接口的状态和健康状况。
- class sushy.resources.system.ethernet_interface.EthernetInterfaceCollection(connector, path, redfish_version=None, registries=None, root=None)¶
-
- property summary¶
MAC 地址和接口状态摘要
此过滤器筛选出健康状态为“OK”的 MAC,这意味着返回状态为“已启用”和“已禁用”的 MAC。
- 返回值:
格式为 {‘aa:bb:cc:dd:ee:ff’: sushy.State.ENABLED, ‘aa:bb:aa:aa:aa:aa’: sushy.State.DISABLED} 的字典
sushy.resources.system.port 模块¶
- class sushy.resources.system.port.EthernetField(*args, **kwargs)¶
基类:
CompositeField- associated_mac_addresses = <sushy.resources.base.Field object>¶
关联的已配置 MAC 地址数组。
- flow_control_configuration = <sushy.resources.base.MappedField object>¶
本地配置的 802.3x 流量控制设置。
- flow_control_status = <sushy.resources.base.MappedField object>¶
与链路伙伴协商的 802.3x 流量控制行为
- lldp_receive = <sushy.resources.system.port.LLDPReceiveField object>¶
在此链接上接收到的 LLDP 数据。
- class sushy.resources.system.port.LLDPReceiveField(*args, **kwargs)¶
基类:
CompositeField- chassis_id = <sushy.resources.base.Field object>¶
从远程伙伴通过此链接接收到的机箱 ID。
- port_id = <sushy.resources.base.Field object>¶
标识端口的冒号分隔的十六进制字节字符串。
- class sushy.resources.system.port.Port(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)¶
基类:
ResourceBase这个类添加了 Port 资源
- current_speed_gbps = <sushy.resources.base.Field object>¶
网络端口当前的链路速度。
- description = <sushy.resources.base.Field object>¶
端口描述
- ethernet = <sushy.resources.system.port.EthernetField object>¶
端口的以太网特定属性。
- identity = <sushy.resources.base.Field object>¶
端口标识字符串
- link_status = <sushy.resources.base.MappedField object>¶
端口的链路状态。
- name = <sushy.resources.base.Field object>¶
端口名称
- port_id = <sushy.resources.base.Field object>¶
此端口的物理端口 ID 标签。
- status = <sushy.resources.common.StatusField object>¶
端口状态
- class sushy.resources.system.port.PortCollection(connector, path, redfish_version=None, registries=None, root=None)¶
sushy.resources.system.processor 模块¶
- class sushy.resources.system.processor.Processor(connector, identity, redfish_version=None, registries=None, root=None)¶
基类:
ResourceBase- identity = <sushy.resources.base.Field object>¶
处理器标识字符串
- instruction_set = <sushy.resources.base.MappedField object>¶
处理器的指令集
- manufacturer = <sushy.resources.base.Field object>¶
处理器制造商
- max_speed_mhz = <sushy.resources.base.Field object>¶
处理器以 MHz 为单位的最大时钟速度。
- model = <sushy.resources.base.Field object>¶
此设备的型号
- processor_architecture = <sushy.resources.base.MappedField object>¶
处理器的架构
- processor_id = <sushy.resources.system.processor.ProcessorIdField object>¶
处理器 ID
- processor_type = <sushy.resources.base.MappedField object>¶
处理器类型
- socket = <sushy.resources.base.Field object>¶
处理器插槽或位置
- status = <sushy.resources.common.StatusField object>¶
处理器状态
- property sub_processors¶
指向子处理器集合的引用
- total_cores = <sushy.resources.base.Field object>¶
此处理器中包含的总核心数
- total_threads = <sushy.resources.base.Field object>¶
此处理器支持的总执行线程数
- class sushy.resources.system.processor.ProcessorCollection(connector, path, redfish_version=None, registries=None, root=None)¶
-
- property summary¶
属性,用于提供处理器摘要信息
首次查询时计算一次。刷新时,此属性会重置。
- 返回值:
一个命名元组,包含有关逻辑 CPU 的处理器
count数量,以及它们的architecture。
- class sushy.resources.system.processor.ProcessorIdField(*args, **kwargs)¶
基类:
CompositeField- effective_family = <sushy.resources.base.Field object>¶
处理器的有效家族
- effective_model = <sushy.resources.base.Field object>¶
处理器的有效型号
- identification_registers = <sushy.resources.base.Field object>¶
处理器的标识寄存器
- microcode_info = <sushy.resources.base.Field object>¶
处理器的微代码信息
- step = <sushy.resources.base.Field object>¶
处理器的步进
- vendor_id = <sushy.resources.base.Field object>¶
处理器的供应商 ID
sushy.resources.system.secure_boot 模块¶
- class sushy.resources.system.secure_boot.ActionsField(*args, **kwargs)¶
基类:
CompositeField- reset_keys = <sushy.resources.system.secure_boot.ResetKeysActionField object>¶
重置 UEFI 安全启动密钥的操作。
- class sushy.resources.system.secure_boot.ResetKeysActionField(*args, **kwargs)¶
基础类:
ActionField- allowed_values = <sushy.resources.base.Field object>¶
- class sushy.resources.system.secure_boot.SecureBoot(connector, path, redfish_version=None, registries=None, root=None)¶
基类:
ResourceBase- current_boot = <sushy.resources.base.MappedField object>¶
当前启动周期中的 UEFI 安全启动状态。
- property databases¶
安全启动数据库的集合。
首次查询时设置。在刷新时,此属性标记为陈旧(未执行贪婪刷新)。此处实际发生子资源的刷新,如果陈旧的话。
- 引发:
如果缺少 ‘SecureBootDatabases/@odata.id’ 字段,则会引发 MissingAttributeError。
- 返回值:
SimpleStorageCollection 实例
- description = <sushy.resources.base.Field object>¶
Human-readable description of the BIOS resource
- enabled = <sushy.resources.base.Field object>¶
UEFI 安全启动是否在下次启动时生效。
此属性只能在 UEFI 启动模式下启用。
- get_allowed_reset_keys_values()¶
获取重置密钥的允许值。
- 返回值:
包含允许值的集合。
- identity = <sushy.resources.base.Field object>¶
The Bios resource identity string
- mode = <sushy.resources.base.MappedField object>¶
当前的 UEFI 安全启动模式。
- name = <sushy.resources.base.Field object>¶
资源的名称
- reset_keys(reset_type)¶
重置安全启动密钥。
- 参数:
reset_type – 重置类型,为 SECURE_BOOT_RESET_KEYS_* 常量之一。
- set_enabled(enabled)¶
启用/禁用安全启动。
- 参数:
enabled – 如果安全启动在下次启动时启用,则为 True。
sushy.resources.system.secure_boot_database 模块¶
- class sushy.resources.system.secure_boot_database.ActionsField(*args, **kwargs)¶
基类:
CompositeField- reset_keys = <sushy.resources.system.secure_boot_database.ResetKeysActionField object>¶
重置 UEFI 安全启动密钥的操作。
- class sushy.resources.system.secure_boot_database.ResetKeysActionField(*args, **kwargs)¶
基础类:
ActionField- allowed_values = <sushy.resources.base.Field object>¶
- class sushy.resources.system.secure_boot_database.SecureBootDatabase(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)¶
基类:
ResourceBase- database_id = <sushy.resources.base.MappedField object>¶
标准 UEFI 数据库类型。
- description = <sushy.resources.base.Field object>¶
系统描述
- get_allowed_reset_keys_values()¶
获取重置密钥的允许值。
- 返回值:
包含允许值的集合。
- identity = <sushy.resources.base.Field object>¶
安全启动数据库标识字符串
- name = <sushy.resources.base.Field object>¶
安全启动数据库名称
- reset_keys(reset_type)¶
重置安全启动密钥。
- 参数:
reset_type – 重置类型,为 SECURE_BOOT_RESET_KEYS_* 常量之一。
- class sushy.resources.system.secure_boot_database.SecureBootDatabaseCollection(connector, path, redfish_version=None, registries=None, root=None)¶
sushy.resources.system.simple_storage 模块¶
- class sushy.resources.system.simple_storage.DeviceListField(*args, **kwargs)¶
基础:
ListField与简单存储关联的存储设备/设备。
- capacity_bytes = <sushy.resources.base.Field object>¶
存储设备的大小。
- name = <sushy.resources.base.Field object>¶
存储设备的名称
- status = <sushy.resources.common.StatusField object>¶
描述存储设备的状况和健康状况。
- class sushy.resources.system.simple_storage.SimpleStorage(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)¶
基类:
ResourceBase此类表示一个简单的存储。
它表示存储控制器的属性及其直接连接的设备。存储设备可以是磁盘驱动器或光盘设备。
- devices = <sushy.resources.system.simple_storage.DeviceListField object>¶
与此资源关联的存储设备。
- identity = <sushy.resources.base.Field object>¶
SimpleStorage 标识字符串
- name = <sushy.resources.base.Field object>¶
资源的名称
- class sushy.resources.system.simple_storage.SimpleStorageCollection(connector, path, redfish_version=None, registries=None, root=None)¶
-
表示与系统关联的简单存储集合。
- property disks_sizes_bytes¶
SimpleStorage 集合资源中每个磁盘的大小(以字节为单位)。
在刷新它(或其父资源)之前,返回缓存的值。
- property max_size_bytes¶
所有启用磁盘资源中可用的最大大小(以字节为单位)。
在刷新它(或其父资源)之前,返回缓存的值。
sushy.resources.system.system 模块¶
- class sushy.resources.system.system.ActionsField(*args, **kwargs)¶
基类:
CompositeField- reset = <sushy.resources.common.ResetActionField object>¶
- class sushy.resources.system.system.BootField(*args, **kwargs)¶
基类:
CompositeField- allowed_values = <sushy.resources.base.Field object>¶
- enabled = <sushy.resources.base.MappedField object>¶
- http_boot_uri = <sushy.resources.base.Field object>¶
- mode = <sushy.resources.base.MappedField object>¶
- target = <sushy.resources.base.MappedField object>¶
- class sushy.resources.system.system.BootProgressField(*args, **kwargs)¶
基类:
CompositeField- last_boot_seconds_count = <sushy.resources.base.Field object>¶
上次启动达到 OSRunning 状态所用的秒数。
- last_state = <sushy.resources.base.MappedField object>¶
上次记录的启动进度状态。
- last_state_updated_at = <sushy.resources.base.Field object>¶
上次更新 last state 字段的日期时间值。
- oem_last_state = <sushy.resources.base.Field object>¶
OEM 上次状态时间,用于描述 OEM 特定的状态信息。
- class sushy.resources.system.system.MemorySummaryField(*args, **kwargs)¶
基类:
CompositeField- health = <sushy.resources.base.Field object>¶
内存的整体健康状态。
表示内存及其相关资源的健康状态。
- size_gib = <sushy.resources.base.Field object>¶
系统内存的大小,以 GiB 为单位。
表示操作系统可访问的总安装内存 (RAM),以 GiB 为单位。
- class sushy.resources.system.system.System(connector, identity, redfish_version=None, registries=None, root=None)¶
基类:
ResourceBase- asset_tag = <sushy.resources.base.Field object>¶
系统的资产标签
- property bios¶
引用 Bios 实例的属性
首次查询时设置。在刷新时,此属性标记为陈旧(未执行贪婪刷新)。此处实际发生子资源的刷新,如果陈旧的话。
- bios_version = <sushy.resources.base.Field object>¶
系统的 BIOS 版本
- boot = <sushy.resources.system.system.BootField object>¶
包含当前启动设备、频率和模式的字典
- boot_progress = <sushy.resources.system.system.BootProgressField object>¶
上次更新的启动进度指示器
- property chassis¶
此系统所在的机箱列表。
返回表示安装此系统的机箱或机柜的 Chassis 对象列表。
- 引发:
如果缺少 ‘@odata.id’ 字段,则会引发 MissingAttributeError。
- 返回值:
Chassis 实例列表
- description = <sushy.resources.base.Field object>¶
系统描述
- property ethernet_interfaces¶
引用 EthernetInterfaceCollection 实例的属性
首次查询时设置。在刷新时,此属性标记为陈旧(未执行贪婪刷新)。此处实际发生子资源的刷新,如果陈旧的话。
- get_allowed_reset_system_values()¶
获取重置系统的允许值。
- 返回值:
包含允许值的集合。
- get_allowed_system_boot_source_values()¶
获取更改启动源的允许值。
- 返回值:
包含允许值的集合。
- hostname = <sushy.resources.base.Field object>¶
系统的 hostname
- identity = <sushy.resources.base.Field object>¶
系统的身份字符串
- indicator_led = <sushy.resources.base.MappedField object>¶
指示 LED 是否亮着或熄灭
- maintenance_window = <sushy.resources.settings.MaintenanceWindowField object>¶
Indicates if a given resource has a maintenance window assignment for applying settings or operations
- property managers¶
此系统的管理器列表。
返回表示管理此系统的管理器的 Manager 对象列表。
- 引发:
如果缺少 ‘@odata.id’ 字段,则会引发 MissingAttributeError。
- 返回值:
Manager 实例列表
- manufacturer = <sushy.resources.base.Field object>¶
系统的制造商
- memory_summary = <sushy.resources.system.system.MemorySummaryField object>¶
系统内存的摘要信息
- model = <sushy.resources.base.Field object>¶
系统的型号
- name = <sushy.resources.base.Field object>¶
系统的名称
- part_number = <sushy.resources.base.Field object>¶
系统的零件编号
- power_state = <sushy.resources.base.MappedField object>¶
系统的电源状态
- property processors¶
引用 ProcessorCollection 实例的属性
首次查询时设置。在刷新时,此属性标记为陈旧(未执行贪婪刷新)。此处实际发生子资源的刷新,如果陈旧的话。
- reset_system(value)¶
重置系统。
- 参数:
value – 目标值。
- 引发:
如果目标值不允许,则会引发 InvalidParameterValueError。
- property secure_boot¶
引用 SecureBoot 实例的属性
首次查询时设置。在刷新时,此属性标记为陈旧(未执行贪婪刷新)。此处实际发生子资源的刷新,如果陈旧的话。
- serial_number = <sushy.resources.base.Field object>¶
系统的序列号
- set_indicator_led(state)¶
将指示 LED 设置为给定的状态。
- 参数:
state – 所需的 LED 状态,一个 IndicatorLED 值。
- 引发:
InvalidParameterValueError,如果传递的任何信息无效。
- set_system_boot_options(target=None, enabled=None, mode=None, http_boot_uri=None)¶
设置启动源和/或启动频率和/或启动模式。
设置系统下次重新启动时要使用的启动源和/或启动频率和/或启动模式。
- 参数:
target – 目标启动源,一个
sushy.BootSource值。可选。enabled – 覆盖启用时长,一个
sushy.BootSourceOverrideEnabled值。可选。mode – 启动模式,一个
sushy.BootSourceOverrideMode值。可选。http_boot_uri – 要传输到 BMC 的请求 HTTP 启动 URI。仅当 BootSourceOverrideTarget 设置为 UefiHTTP 时有效,在使用
target参数时。如果未提供值,并且目标设置为 UefiHTTP,则将一个空值发送到 BMC 以删除任何先前的设置,从而允许主机从 DHCP 加载配置。如果未显式设置,则在未启用 UefiHttp 启动时,任何值都将从 BMC 中删除。
- 引发:
InvalidParameterValueError,如果传递的任何信息无效。
- set_system_boot_source(target, enabled=BootSourceOverrideEnabled.ONCE, mode=None)¶
设置启动源和/或启动频率和/或启动模式。
设置系统下次重新启动时要使用的启动源和/或启动频率和/或启动模式。
此方法已被 set_system_boot_options 取代。
- 参数:
target – 目标启动源,一个
sushy.BootSource值。enabled – 频率,是为下一次设置还是持续设置,一个
sushy.BootSourceOverrideEnabled值。默认值为 ONCE。mode – 启动模式,一个
sushy.BootSourceOverrideMode值。
- 引发:
InvalidParameterValueError,如果传递的任何信息无效。
- property simple_storage¶
与系统关联的简单存储集合。
这将返回对 SimpleStorageCollection 实例的引用。SimpleStorage 代表存储控制器及其直接连接设备的属性。
首次查询时设置。在刷新时,此属性标记为陈旧(未执行贪婪刷新)。此处实际发生子资源的刷新,如果陈旧的话。
- 引发:
如果缺少 ‘SimpleStorage/@odata.id’ 字段,则会引发 MissingAttributeError。
- 返回值:
SimpleStorageCollection 实例
- sku = <sushy.resources.base.Field object>¶
系统的库存单位
- status = <sushy.resources.common.StatusField object>¶
系统状态
- property storage¶
与系统关联的存储子系统集合。
这将返回对 StorageCollection 实例的引用。存储子系统代表一组存储控制器(物理或虚拟)以及可以从该子系统访问的资源,例如驱动器和卷。
首次查询时设置。在刷新时,此属性标记为陈旧(未执行贪婪刷新)。此处实际发生子资源的刷新,如果陈旧的话。
- 引发:
如果缺少 ‘Storage/@odata.id’ 字段,则会引发 MissingAttributeError。
- 返回值:
StorageCollection 实例
- system_type = <sushy.resources.base.MappedField object>¶
系统类型
- uuid = <sushy.resources.base.Field object>¶
系统 UUID
- property virtual_media¶
引用 VirtualMedia 实例的属性
- 返回值:
一个 VirtualMediaCollection 实例。
- class sushy.resources.system.system.SystemCollection(connector, path, redfish_version=None, registries=None, root=None)¶