sushy.resources.taskservice package¶

Submodules¶

sushy.resources.taskservice.constants module¶

sushy.resources.taskservice.mappings module¶

sushy.resources.taskservice.task module¶

class sushy.resources.taskservice.task.Task(connector, identity, redfish_version=None, registries=None, json_doc=None)¶

Bases: sushy.resources.base.ResourceBase

description = <sushy.resources.base.Field object>¶: The Task description

end_time = <sushy.resources.base.Field object>¶: End time of the Task

identity = <sushy.resources.base.Field object>¶: The Task identity

property is_processing¶: Indicates if the Task is processing

messages = <sushy.resources.base.MessageListField object>¶: List of MessageListField with messages from the Task

name = <sushy.resources.base.Field object>¶: The Task name

parse_messages()¶: Parses the messages

percent_complete = <sushy.resources.base.Field object>¶: Percentage complete of the Task

start_time = <sushy.resources.base.Field object>¶: Start time of the Task

task_monitor = <sushy.resources.base.Field object>¶: An opaque URL that the client can use to monitor an asynchronous operation

task_state = <sushy.resources.base.MappedField object>¶: The Task state

task_status = <sushy.resources.base.MappedField object>¶: The Task status

class sushy.resources.taskservice.task.TaskCollection(connector, path, redfish_version=None, registries=None)¶

Bases: sushy.resources.base.ResourceCollectionBase

property summary¶

Summary of task ids and corresponding state

Returns: dictionary in the format {‘jid_123456789’: sushy.TASK_STATE_NEW, ‘jid_123454321’: sushy.TASK_STATE_RUNNING}

sushy.resources.taskservice.taskmonitor module¶

class sushy.resources.taskservice.taskmonitor.TaskMonitor(connector, task_monitor, redfish_version=None, registries=None, field_data=None)¶

Bases: object

property cancellable¶

The amount of time to sleep before retrying

Returns: A Boolean indicating if the Task is cancellable.

get_task()¶

property is_processing¶

Indicates if the task is still processing

Returns: A boolean indicating if the task is still processing.

refresh()¶

Refresh the Task

Freshly retrieves/fetches the Task. :raises: ResourceNotFoundError :raises: ConnectionError :raises: HTTPError

property retry_after¶

The amount of time to sleep before retrying

Returns: The amount of time in seconds to wait before calling is_processing.

property task¶

The executing task

Returns: The Task being executed.

property task_monitor¶

The TaskMonitor URI

Returns: The TaskMonitor URI.

sushy.resources.taskservice.taskservice module¶

class sushy.resources.taskservice.taskservice.TaskService(connector, identity, redfish_version=None, registries=None)¶

Bases: sushy.resources.base.ResourceBase

event_on_task_state_change = <sushy.resources.base.Field object>¶: Whether a task state change sends an event

identity = <sushy.resources.base.Field object>¶: The task service identity

name = <sushy.resources.base.Field object>¶: The task service name

overwrite_policy = <sushy.resources.base.MappedField object>¶: The overwrite policy for completed tasks

service_enabled = <sushy.resources.base.Field object>¶: The status of whether this service is enabled

status = <sushy.resources.common.StatusField object>¶: The status of the task service

property tasks¶

Property to reference TaskCollection instance

It is set once when the first time it is queried. On refresh, this property is marked as stale (greedy-refresh not done). Here the actual refresh of the sub-resource happens, if stale.

sushy.resources.taskservice package