sushy.resources.registry package¶

Submodules¶

sushy.resources.registry.message_registry module¶

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

Bases: sushy.resources.base.DictionaryField

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

Indicates how and when the message is returned by the Redfish service

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

Template text of the message

Template can include placeholders for message arguments in form %<integer> where <integer> denotes a position passed from MessageArgs.

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

Number of arguments to be expected to be passed in as MessageArgs for this message

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

Mapped MessageArg types, in order, for the message

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

Suggestions on how to resolve the situation that caused the error

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

Mapped severity of the message

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

Bases: sushy.resources.base.ResourceBase

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

Human-readable description of the message registry

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

The Message registry identity string

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

RFC 5646 compliant language code for the registry

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

List of messages in this registry

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

The name of the message registry

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

Organization or company that publishes this registry

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

Prefix used in messageIDs which uniquely identifies all of the messages in this registry as belonging to this registry

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

Message registry version which is used in the middle portion of a messageID

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

Using message registries parse the message and substitute any parms

Parameters

• message_registries – dict of Message Registries

• message_field – settings.MessageListField to parse

Returns

parsed settings.MessageListField with missing attributes filled

sushy.resources.registry.message_registry_file module¶

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

Bases: sushy.resources.base.ListField

Location for each registry file of languages supported

There are 3 options where the file can be hosted:

• locally as a single file,

• locally as a part of archive (zip or other),

• publicly on the Internet.

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

File name for registry if using archive_uri

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

Location URI for archive file

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

File’s RFC5646 language code or the string ‘default’

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

Location URI of publicly available schema

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

Location URI for co-located registry file with the Redfish service

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

Bases: sushy.resources.base.ResourceBase

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

Description of Message Registry file resource

get_message_registry(language, public_connector)¶

Load message registry file depending on its source

Will try to find MessageRegistry based on odata.type property and provided language. If desired language is not found, will pick a registry that has ‘default’ language.

Parameters

• language – RFC 5646 language code for registry files

• public_connector – connector to use when downloading registry from the Internet

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

Identity of Message Registry file resource

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

List of RFC 5646 language codes supported by this resource

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

List of locations of Registry files for each supported language

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

Name of Message Registry file resource

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

Prefix for MessageId used for messages from this resource

This attribute is in form Registry_name.Major_version.Minor_version

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

Bases: sushy.resources.base.ResourceCollectionBase

Collection of Message Registry Files

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

Bases: sushy.resources.base.ResourceBase

Module contents¶