sushy.resources.registry package¶
Submodules¶
sushy.resources.registry.attribute_registry module¶
-
class
sushy.resources.registry.attribute_registry.
AttributeListField
(*args, **kwargs)¶ Bases:
sushy.resources.base.ListField
-
allowable_values
= <sushy.resources.base.Field object>¶ An array of the possible values for enumerated attribute values
-
attribute_type
= <sushy.resources.base.Field object>¶ The attribute type
-
default_value
= <sushy.resources.base.Field object>¶ The default value for the attribute
-
display_name
= <sushy.resources.base.Field object>¶ User-readable display string for attribute in the defined language
-
immutable
= <sushy.resources.base.Field object>¶ An indication of whether this attribute is immutable
-
lower_bound
= <sushy.resources.base.Field object>¶ The lower limit for an integer attribute
-
max_length
= <sushy.resources.base.Field object>¶ The maximum character length of the string attribute
-
min_length
= <sushy.resources.base.Field object>¶ The minimum character length of the string attribute
-
name
= <sushy.resources.base.Field object>¶ The unique name for the attribute
-
read_only
= <sushy.resources.base.Field object>¶ An indication of whether this attribute is read-only
-
reset_required
= <sushy.resources.base.Field object>¶ An indication of whether this attribute is read-only
-
unique
= <sushy.resources.base.Field object>¶ Indicates whether this attribute is unique for this system
-
upper_bound
= <sushy.resources.base.Field object>¶ The upper limit for an integer attribute
-
-
class
sushy.resources.registry.attribute_registry.
AttributeRegistry
(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)¶ Bases:
sushy.resources.base.ResourceBase
-
description
= <sushy.resources.base.Field object>¶ Human-readable description of the registry
-
identity
= <sushy.resources.base.Field object>¶ The Attribute registry identity string
-
language
= <sushy.resources.base.Field object>¶ RFC 5646 compliant language code for the registry
-
name
= <sushy.resources.base.Field object>¶ The name of the attribute registry
-
owning_entity
= <sushy.resources.base.Field object>¶ Organization or company that publishes this registry
-
registry_entries
= <sushy.resources.registry.attribute_registry.AttributeRegistryEntryField object>¶ Field containing Attributes, Dependencies, Menus etc.
-
registry_version
= <sushy.resources.base.Field object>¶ The version of this registry
-
supported_systems
= <sushy.resources.base.Field object>¶ The system that this registry supports
-
-
class
sushy.resources.registry.attribute_registry.
AttributeRegistryEntryField
(*args, **kwargs)¶ Bases:
sushy.resources.base.CompositeField
-
attributes
= <sushy.resources.registry.attribute_registry.AttributeListField object>¶ List of attributes in this registry
-
sushy.resources.registry.constants module¶
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, root=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)¶ Parse the messages in registries and substitute any params
Check only registries that support messages.
- Parameters
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, root=None)¶ Bases:
sushy.resources.base.ResourceBase
-
description
= <sushy.resources.base.Field object>¶ Description of Message Registry file resource
-
get_attribute_registry
(language, public_connector)¶ Get an Attribute Registry from the location
- Parameters
language – RFC 5646 language code for registry files
public_connector – connector to use when downloading registry from the Internet
- Returns
an AttributeRegistry or None if not found
-
get_message_registry
(language, public_connector)¶ Get a Message Registry from the location
- Parameters
language – RFC 5646 language code for registry files
public_connector – connector to use when downloading registry from the Internet
- Returns
a MessageRegistry or None if not found
-
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, root=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, root=None)¶