sushy.oem.dell.resources.manager 包

子模块

sushy.oem.dell.resources.manager.constants 模块

class sushy.oem.dell.resources.manager.constants.ExportTarget(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

基础: Enum

导出系统配置操作常量

ALL = 'ALL'

导出整个系统配置

BIOS = 'BIOS'

导出 BIOS 相关配置

IDRAC = 'IDRAC'

导出 iDRAC 相关配置

NIC = 'NIC'

导出 NIC 相关配置

RAID = 'RAID'

导出 RAID 相关配置

class sushy.oem.dell.resources.manager.constants.ExportUse(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

基础: Enum

ExportSystemConfiguration 中的 ExportUse

CLONE = 'Clone'

适用于克隆“黄金”配置的克隆导出类型。

与默认导出类型相比,启用了更多属性,并调整了存储设置以帮助克隆过程。

DEFAULT = 'Default'

默认导出类型

注释掉了一些属性,并且需要在导入之前启用它们才能应用。

REPLACE = 'Replace'

适用于替换完整配置的替换导出类型。

与克隆导出类型相比,启用了大多数属性,并调整了存储设置以帮助替换过程。

class sushy.oem.dell.resources.manager.constants.IncludeInExport(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

基础: Enum

ExportSystemConfiguration 中的 IncludeInExport

DEFAULT = 'Default'

导出中包含的内容的默认设置。

不包括只读属性,并且根据导出用途,密码被标记为 **(对于默认设置)或设置为默认密码值(对于克隆和替换)。

PASSWORD_HASHES = 'IncludePasswordHashValues'

包含密码哈希值。

在使用克隆或替换时,包含密码哈希值,而不是默认密码。可用于在系统之间复制密码。

READ_ONLY = 'IncludeReadOnly'

包含只读属性。

除了默认选项包含的值外,还包括无法通过导入更改的只读属性,并且仅用于提供参考信息。

READ_ONLY_PASSWORD_HASHES = 'IncludeReadOnly,IncludePasswordHashValues'

包含只读属性和密码哈希值。

INCLUDE_EXPORT_READ_ONLY 和 INCLUDE_EXPORT_PASSWORD_HASHES 组合

class sushy.oem.dell.resources.manager.constants.ResetType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

基础: Enum

iDRAC 重置重置类型常量

FORCE = 'Force'

执行立即(非优雅)关机,然后重新启动

GRACEFUL = 'Graceful'

执行优雅关机,然后重新启动系统

class sushy.oem.dell.resources.manager.constants.ShutdownType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

基础: Enum

ImportSystemConfiguration ShutdownType 值

FORCED = 'Forced'

Import System Configuration 的强制关机

主机服务器将立即关机。应在安全关机主机时使用。

GRACEFUL = 'Graceful'

Import System Configuration 的优雅关机

将等待主机最多 5 分钟关机,然后超时。操作系统可能会拒绝或忽略优雅关机请求。

NO_REBOOT = 'NoReboot'

Import System Configuration 不重新启动

不执行关机。需要显式重新启动才能应用更改。

sushy.oem.dell.resources.manager.idrac_card_service 模块

class sushy.oem.dell.resources.manager.idrac_card_service.ActionsField(*args, **kwargs)

基类: CompositeField

get_kvm_session = <sushy.resources.common.ActionField object>
reset_idrac = <sushy.oem.dell.resources.manager.idrac_card_service.ForceActionField object>
class sushy.oem.dell.resources.manager.idrac_card_service.DelliDRACCardService(connector, identity, redfish_version=None, registries=None)

基类: ResourceBase

get_allowed_reset_idrac_values()

获取重置 idrac 的允许值。

返回值:

允许值集合。

get_kvm_session()

获取 KVM 会话的临时凭据

TempUsername 和 TempPassword 字段可用于以下 URL 模板:https://{host}/console?username={}&tempUsername={}&tempPassword={} 用户名是用于生成这些会话凭据的用户。

返回值:

包含 TempUsername 和 TempPassword 字段的字典。如果 API 没有返回任何凭据,但没有引发错误,则为 None。何时以及为什么会发生这种情况尚不清楚,但在 API 文档中指定。

identity = <sushy.resources.base.Field object>
reset_idrac()

重置 iDRAC。

class sushy.oem.dell.resources.manager.idrac_card_service.ForceActionField(*args, **kwargs)

基类: CompositeField

allowed_values = <sushy.resources.base.Field object>
target_uri = <sushy.resources.base.Field object>

sushy.oem.dell.resources.manager.job_collection 模块

class sushy.oem.dell.resources.manager.job_collection.DellJobCollection(connector, identity, redfish_version=None, registries=None)

基类: ResourceBase

get_unfinished_jobs()

获取未完成的任务。

返回值:

一个未完成的任务列表。

sushy.oem.dell.resources.manager.job_service 模块

class sushy.oem.dell.resources.manager.job_service.ActionsField(*args, **kwargs)

基类: CompositeField

delete_job_queue = <sushy.resources.common.ActionField object>
class sushy.oem.dell.resources.manager.job_service.DellJobService(connector, identity, redfish_version=None, registries=None)

基类: ResourceBase

delete_jobs(job_ids=['JID_CLEARALL'])

删除给定的任务,或所有任务。

参数:

job_ids – 要删除的任务 ID 列表。可以使用关键字 JID_CLEARALL 作为 job_id 来清除所有任务。

identity = <sushy.resources.base.Field object>

sushy.oem.dell.resources.manager.lifecycle_service 模块

class sushy.oem.dell.resources.manager.lifecycle_service.ActionsField(*args, **kwargs)

基类: CompositeField

remote_service_api_status = <sushy.resources.common.ActionField object>
class sushy.oem.dell.resources.manager.lifecycle_service.DellLCService(connector, identity, redfish_version=None, registries=None)

基类: ResourceBase

identity = <sushy.resources.base.Field object>
is_idrac_ready()

指示 iDRAC 是否已准备好接受命令。

返回值:

基于远程服务 API 状态响应的布尔值 True/False。

is_realtime_ready()

指示实时操作是否已准备好被接受。

返回值:

如果准备好接受实时操作,则为 True,否则为 False。

sushy.oem.dell.resources.manager.manager 模块

class sushy.oem.dell.resources.manager.manager.DellManagerActionsField(*args, **kwargs)

基类: CompositeField

export_system_configuration = <sushy.oem.dell.resources.manager.manager.ExportActionField object>
import_system_configuration = <sushy.oem.dell.resources.manager.manager.ImportActionField object>
class sushy.oem.dell.resources.manager.manager.DellManagerExtension(connector, path='', redfish_version=None, registries=None, reader=None, root=None)

基类: OEMResourceBase

ACTION_DATA = {'ImportBuffer': None, 'ShareParameters': {'Target': ['ALL']}}
IDRAC_CONFIG_CD = '<SystemConfiguration><Component FQDD="%s"><Attribute Name="ServerBoot.1#BootOnce">%s</Attribute><Attribute Name="ServerBoot.1#FirstBootDevice">VCD-DVD</Attribute></Component></SystemConfiguration>'
IDRAC_CONFIG_FLOPPY = '<SystemConfiguration><Component FQDD="%s"><Attribute Name="ServerBoot.1#BootOnce">%s</Attribute><Attribute Name="ServerBoot.1#FirstBootDevice">VFDD</Attribute></Component></SystemConfiguration>'
IDRAC_MEDIA_TYPES = {VirtualMediaType.CD: '<SystemConfiguration><Component FQDD="%s"><Attribute Name="ServerBoot.1#BootOnce">%s</Attribute><Attribute Name="ServerBoot.1#FirstBootDevice">VCD-DVD</Attribute></Component></SystemConfiguration>', VirtualMediaType.FLOPPY: '<SystemConfiguration><Component FQDD="%s"><Attribute Name="ServerBoot.1#BootOnce">%s</Attribute><Attribute Name="ServerBoot.1#FirstBootDevice">VFDD</Attribute></Component></SystemConfiguration>'}
RETRY_COUNT = 35
RETRY_DELAY = 15
property attributes
export_system_configuration(include_destructive_fields=True)

导出系统配置。

导出所有目标以进行克隆,并包含密码哈希和只读属性。

参数:

include_destructive_fields – 是否包含可能导致导入此配置到另一个系统时丢失 iDRAC 访问权限的设置,例如 iDRAC 静态 IP 地址。默认值为 True 以保持向后兼容。如果不确定,建议设置为 False。

返回值:

包含配置详细信息的响应对象。

引发:

InvalidParameterValueError 在目标无效时。

引发:

ExtensionError 在执行请求的操作失败时

property export_system_configuration_uri
get_allowed_export_target_values()

获取导出系统配置的允许目标值。

返回值:

允许值集合。

get_allowed_export_use_values()

获取导出系统配置的允许使用值。

返回值:

一组允许的使用值。

get_allowed_import_shutdown_type_values()

获取导入系统配置的允许关机类型。

返回值:

一组允许的关机类型值。

get_allowed_include_in_export_values()

获取导出系统配置的允许包含值。

返回值:

一组允许的包含值。

get_pxe_port_macs_bios(ethernet_interfaces_mac)

获取 BIOS 的 PXE 端口 MAC 地址列表。

参数:

ethernet_interfaces_mac – 以太网接口字典。

返回值:

PXE 端口 MAC 地址列表。

引发:

ExtensionError 在执行请求的操作失败时。

property idrac_card_service

对该管理器的 DelliDRACCardService 实例的引用。

import_system_configuration(import_buffer)

导入系统配置。

调用方需要单独处理系统重启。

参数:

import_buffer – 要导入的配置数据。

返回值:

任务监视器实例,用于监视任务完成情况

property import_system_configuration_uri
property job_collection

属性,用于引用该管理器的 DellJobService 实例。

property job_service

属性,用于引用该管理器的 DellJobService 实例。

property lifecycle_service

属性,用于引用该管理器的 DellLCService 实例。

reset_idrac(wait=True, ready_wait_time=60)

重置 iDRAC 并等待其准备就绪。

参数:
  • wait – 是否立即返回或等待 iDRAC 变为运行状态。

  • ready_wait_time – 在开始检查 iDRAC 状态之前等待的秒数。

set_virtual_boot_device(device, persistent=False, manager=None, system=None)

设置节点的启动设备。

Dell iDRAC Redfish 实现不支持通过标准 Redfish 方式设置虚拟介质的启动设备。但是,这仍然可以通过 OEM 扩展来实现。

参数:
  • device – 启动设备。值由供应商指定。

  • persistent – 是否设置为下次启动,或者使更改永久生效。默认值:False。

  • manager – OEM 扩展的管理器。可选。

  • system – OEM 扩展的系统。可选。

引发:

如果 Dell OEM 扩展无法使用,则会引发 InvalidParameterValue 异常。

引发:

ExtensionError 在执行请求的操作失败时。

class sushy.oem.dell.resources.manager.manager.ExportActionField(*args, **kwargs)

基类: ActionField

allowed_export_use_values = <sushy.resources.base.Field object>
allowed_include_in_export_values = <sushy.resources.base.Field object>
shared_parameters = <sushy.oem.dell.resources.manager.manager.SharedParameters object>
class sushy.oem.dell.resources.manager.manager.ImportActionField(*args, **kwargs)

基类: ActionField

allowed_shutdown_type_values = <sushy.resources.base.Field object>
class sushy.oem.dell.resources.manager.manager.SharedParameters(*args, **kwargs)

基类: CompositeField

allowed_target_values = <sushy.resources.base.Field object>
sushy.oem.dell.resources.manager.manager.get_extension(*args, **kwargs)

模块内容