Bases: object
Based on data source get data and parse to JSON
Sets mandatory connection parameters
connector – A Connector instance
path – path of the resource
Bases: collections.abc.Mapping
, sushy.resources.base.Field
Base class for fields consisting of several sub-fields.
Bases: sushy.resources.base.Field
Base class for fields consisting of dictionary of several sub-fields.
Bases: object
Definition for fields fetched from JSON.
Bases: object
Contains data to be used when constructing Fields
The headers
The parsed JSON body
The status code
Bases: sushy.resources.base.AbstractDataReader
Gets the data from JSON file in archive
Gets JSON file from archive. Currently supporting ZIP only
Bases: sushy.resources.base.AbstractDataReader
Gets the data from HTTP response given by path
Gets JSON file from URI directly
Bases: sushy.resources.base.AbstractDataReader
Gets the data from packaged file given by path
Gets JSON file from packaged file denoted by path
Bases: sushy.resources.base.AbstractDataReader
Loads the data from the Internet
Get JSON file from full URI
Bases: sushy.resources.base.CompositeField
Reference to linked resources.
Bases: sushy.resources.base.Field
Base class for fields consisting of a list of several sub-fields.
Bases: sushy.resources.base.Field
Field taking real value from a mapping.
Bases: sushy.resources.base.Field
Field taking a list of values with a mapping for the values
Given JSON {‘field’:[‘xxx’, ‘yyy’]}, a sushy resource definition and mapping {‘xxx’:’a’, ‘yyy’:’b’}, the sushy object to come out will be like resource.field = [‘a’, ‘b’]
Bases: sushy.resources.base.ListField
List of messages with details of settings update status
Human readable message, if provided
List of message substitution arguments for the message referenced by message_id from the message registry
The key for this message which can be used to look up the message in a message registry
Used to provide suggestions on how to resolve the situation that caused the error
Severity of the error
Bases: object
Instantiate given resource using existing BMC connection context
Get the OEM extension instance for this resource by OEM vendor
vendor – the OEM vendor string which is the vendor-specific
extensibility identifier. Examples are ‘Contoso’, ‘Hpe’.
Possible value can be got from oem_vendors
attribute.
the Redfish resource OEM extension instance.
OEMExtensionNotFoundError
Mark the resource as stale, prompting refresh() before getting used.
If force_refresh
is set to True, then it invokes refresh()
on the resource.
force_refresh – will invoke refresh on the resource, if set to True.
ResourceNotFoundError
ConnectionError
HTTPError
The Redfish version
Refresh the resource
Freshly retrieves/fetches the resource attributes and invokes
_parse_attributes()
method on successful retrieval.
It is recommended not to override this method in concrete ResourceBase
classes. Resource classes can place their refresh specific operations
in _do_refresh()
method, if needed. This method represents the
template method in the paradigm of Template design pattern.
force – if set to False, will only refresh if the resource is marked as stale, otherwise neither it nor its subresources will be refreshed.
json_doc – parsed JSON document in form of Python types.
ResourceNotFoundError
ConnectionError
HTTPError
Bases: sushy.resources.base.ResourceBase
Given the identity return a _resource_type
object
identity – The identity of the _resource_type
The _resource_type
object
ResourceNotFoundError
Return a list of _resource_type
objects present in collection
A list of _resource_type
objects
A tuple with the members identities
The name of the collection
Create and configure the reader.
connector – A Connector instance
path – sub-URI path to the resource.
reader – Reader to use to fetch JSON data.
the reader
Bases: sushy.resources.base.CompositeField
Bases: sushy.resources.base.CompositeField
Reference to the resource odata identity field.
The unique identifier for a resource
Bases: sushy.resources.base.ListField
This type describes any additional identifiers for a resource.
This indicates the world wide, persistent name of the resource.
This represents the format of the DurableName property.
Bases: sushy.resources.common.ActionField
Bases: sushy.resources.base.CompositeField
The expiry time of maintenance window in seconds
The start time of a maintenance window
The types of apply times that the client is allowed request when performing a create, delete, or action operation returned as a mapped list
The types of apply times that the client is allowed request when performing a create, delete, or action operation returned as an unmapped list
Deprecated: Use mapped_supported_values.
Bases: sushy.resources.common.ActionField
Bases: sushy.resources.base.CompositeField
This Field describes the status of a resource and its children.
This field shall contain any state or health properties of a resource.
Represents health of resource w/o considering its dependent resources
Represents health state of resource and its dependent resources
Indicates the known state of the resource, such as if it is enabled.
The Indicator LED is blinking
The Indicator LED is lit
The Indicator LED is off
The state of the Indicator LED cannot be determine
The resource is powered off, although some components may continue to have AUX power such as management controller
The resource is powered on
A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process
A temporary state between Off and On. This temporary state can be very short
Turn the unit off immediately (non-graceful shutdown)
Turn the unit on immediately
Perform an immediate (non-graceful) shutdown, followed by a restart
Perform a graceful shutdown followed by a restart of the system
Perform a graceful shutdown and power off
Generate a Diagnostic Interrupt (usually an NMI on x86 systems) to cease normal operations, perform diagnostic actions and typically halt the system
Turn the unit on
Perform a power cycle of the unit
Simulate the pressing of the physical power button on this unit
Bases: sushy.resources.base.CompositeField
The expiry time of maintenance window in seconds
The start time of a maintenance window
No updates made
Bases: sushy.resources.base.CompositeField
When the future configuration should be applied
The list of allowable ApplyTime values
The expiry time of maintenance window in seconds
The start time of a maintenance window
Bases: sushy.resources.base.CompositeField
The settings of a resource
Represents the future state and configuration of the resource. The field is added to resources that support future state and configuration.
This field includes several properties to help clients monitor when the resource is consumed by the service and determine the results of applying the values, which may or may not have been successful.
Commits new settings values
The new values will be applied when the system or a service restarts.
connector – A Connector instance
value – Value representing JSON whose structure is specific to each resource and the caller must format it correctly
Determines the status of last update based
Uses message id-s and severity to determine the status.
registries – registries to use to parse message
SettingsUpdate
object containing status
and any messages
MaintenanceWindow field
Indicates if a given resource has a maintenance window assignment for applying settings or operations
Represents the results of the last time the values of the Settings resource were applied to the server
OperationApplyTimeSupport field
Indicates if a client is allowed to request for a specific apply time of a create, delete, or action operation of a given resource
Indicates the time the settings were applied to the server
Bases: object
Contains Settings update status and details of the update
List of MessageListField
with messages from the update
The status of the update
Update encountered errors
Update waiting for being applied
Update was successful
Update status unknown
Bases: sushy.resources.base.ResourceBase
Deprecated: Use sushy.taskmonitor.TaskMonitor
Checks the status of the async task
True if the async task is still in progress, False otherwise
The Location header returned from the GET on the Task Monitor
The Location header (an absolute URL)
The response from the last TaskMonitor in_progress check
The requests response object or None
Time the client should wait before querying the task status
The Retry-After time in datetime format
Set the time the client should wait before querying the task status
value – The value of the Retry-After header, which can be the number of seconds to wait or an HTTP-date string as defined by RFC 7231
The TaskMonitor object
Seconds the client should wait before querying the operation status
The number of seconds to wait
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.