sushy.resources.registry 包

子模块

sushy.resources.registry.attribute_registry 模块

class sushy.resources.registry.attribute_registry.AttributeListField(*args, **kwargs)

基础: ListField

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

枚举属性值的可能值数组

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

属性类型

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

属性的默认值

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

属性在定义语言中的用户可读显示字符串

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

指示此属性是否为不可变的

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

整数属性的下限

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

字符串属性的最大字符长度

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

字符串属性的最小字符长度

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

属性的唯一名称

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

指示此属性是否为只读的

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

是否需要系统重置才能更改此属性

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

指示此属性是否为此系统的唯一属性

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

整数属性的上限

class sushy.resources.registry.attribute_registry.AttributeRegistry(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)

基类: ResourceBase

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

注册表的易于理解的描述

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

属性注册表的身份字符串

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

符合 RFC 5646 的注册表语言代码

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

属性注册表的名称

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

发布此注册表的组织或公司

registry_entries = <sushy.resources.registry.attribute_registry.AttributeRegistryEntryField object>

包含属性、依赖项、菜单等的字段

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

此注册表版本

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

此注册表支持的系统

class sushy.resources.registry.attribute_registry.AttributeRegistryEntryField(*args, **kwargs)

基类: CompositeField

attributes = <sushy.resources.registry.attribute_registry.AttributeListField object>

此注册表中的属性列表

sushy.resources.registry.constants 模块

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

基础: Enum

消息注册表消息参数类型相关常量。

NUMBER = 'number'
STRING = 'string'

sushy.resources.registry.message_registry 模块

class sushy.resources.registry.message_registry.MessageDictionaryField(*args, **kwargs)

基础: DictionaryField

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

指示消息由 Redfish 服务以何种方式以及何时返回

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

消息的模板文本

模板可以包含 MessageArgs 中传递的位置的占位符,形式为 %<integer>,其中 <integer> 表示位置。

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

预期作为此消息的 MessageArgs 传递的参数数量

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

映射的消息参数类型,按顺序排列,用于消息

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

关于如何解决导致错误的状况的建议

severity = <sushy.resources.base.MappedField object>

映射的消息严重程度

class sushy.resources.registry.message_registry.MessageRegistry(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)

基类: ResourceBase

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

消息注册表的易读描述

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

消息注册表的身份字符串

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

符合 RFC 5646 的注册表语言代码

messages = <sushy.resources.registry.message_registry.MessageDictionaryField object>

此注册表中的消息列表

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

消息注册表的名称

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

发布此注册表的组织或公司

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

用于在messageID中使用的前缀,用于唯一标识此注册表中的所有消息,表明它们属于此注册表

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

消息注册表版本,用于messageID的中间部分

sushy.resources.registry.message_registry.parse_message(message_registries, message_field)

解析注册表中的消息并替换任何参数

仅检查支持消息的注册表。

参数:
  • message_registries – Message Registry字典

  • message_field – 要解析的settings.MessageListField

返回值:

已填充缺失属性的解析后的settings.MessageListField

sushy.resources.registry.message_registry_file 模块

class sushy.resources.registry.message_registry_file.LocationListField(*args, **kwargs)

基础: ListField

支持的语言的注册表文件位置

文件可以托管在3个选项中

  • 作为单个文件本地,

  • 作为存档(zip或其他)的一部分本地,

  • 在互联网上公开。

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

如果使用archive_uri,则存档文件的名称

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

存档文件的位置URI

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

文件的RFC5646语言代码或字符串“default”

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

公开可用模式的位置URI

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

与Redfish服务一起放置的注册表文件的位置URI

class sushy.resources.registry.message_registry_file.MessageRegistryFile(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)

基类: ResourceBase

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

消息注册表文件资源的描述

get_attribute_registry(language, public_connector)

从位置获取属性注册表

参数:
  • language – 注册表文件的RFC 5646语言代码

  • public_connector – 从互联网下载注册表时使用的连接器

返回值:

AttributeRegistry或未找到时为None

get_message_registry(language, public_connector)

从位置获取消息注册表

参数:
  • language – 注册表文件的RFC 5646语言代码

  • public_connector – 从互联网下载注册表时使用的连接器

返回值:

MessageRegistry或未找到时为None

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

消息注册表文件资源的身份

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

此资源支持的RFC 5646语言代码列表

location = <sushy.resources.registry.message_registry_file.LocationListField object>

每个支持语言的注册表文件的位置列表

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

消息注册表文件资源的名称

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

此资源的消息使用的MessageId的前缀

此属性的格式为Registry_name.Major_version.Minor_version

class sushy.resources.registry.message_registry_file.MessageRegistryFileCollection(connector, path, redfish_version=None, registries=None, root=None)

基类: ResourceCollectionBase

消息注册表文件集合

class sushy.resources.registry.message_registry_file.RegistryType(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)

基类: ResourceBase

模块内容