The rsd_lib.resources.v2_2.telemetry_service.triggers
Module¶
-
class
rsd_lib.resources.v2_2.telemetry_service.triggers.
DiscreteTriggerCollectionField
(*args, **kwargs)¶ Bases:
sushy.resources.base.ListField
DiscreteTrigger field
A discrete trigger.
-
dwell_tim_msec
= <sushy.resources.base.Field object>¶ This time the excursion persists before a trigger is determined.
-
name
= <sushy.resources.base.Field object>¶ The name of trigger.
-
severity
= <sushy.resources.base.Field object>¶ This property contains the value of the Severity property in the Event message.
-
value
= <sushy.resources.base.Field object>¶ This property contains the value of the trigger.
-
-
class
rsd_lib.resources.v2_2.telemetry_service.triggers.
NumericTriggerCollectionField
(*args, **kwargs)¶ Bases:
sushy.resources.base.ListField
NumericTrigger field
A numeric trigger.
-
direction_of_crossing
= <sushy.resources.base.Field object>¶ This property contains the value of the trigger.
-
dwell_tim_msec
= <sushy.resources.base.Field object>¶ This time the excursion persists before a trigger is determined.
-
name
= <sushy.resources.base.Field object>¶ The name of trigger.
-
severity
= <sushy.resources.base.Field object>¶ This property contains the value of the Severity property in the Event message.
-
value
= <sushy.resources.base.Field object>¶ This property contains the value of the trigger.
-
-
class
rsd_lib.resources.v2_2.telemetry_service.triggers.
Triggers
(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)¶ Bases:
rsd_lib.base.ResourceBase
Triggers resource class
This is the schema definition for a Triggers.
-
discrete_trigger_condition
= <sushy.resources.base.Field object>¶ The type of trigger.
-
discrete_triggers
= <rsd_lib.resources.v2_2.telemetry_service.triggers.DiscreteTriggerCollectionField object>¶ List of discrete triggers.
-
metric_properties
= <sushy.resources.base.Field object>¶ A collection of URI for the properties on which this metric definition is defined.
-
metric_type
= <sushy.resources.base.Field object>¶ The type of trigger.
-
numeric_triggers
= <rsd_lib.resources.v2_2.telemetry_service.triggers.NumericTriggerCollectionField object>¶ List of numeric triggers.
-
status
= <rsd_lib.base.StatusField object>¶ This indicates the known state of the resource, such as if it is enabled.
-
trigger_actions
= <sushy.resources.base.Field object>¶ This property specifies what action is perform when the MetricTrigger occurs.
-
wildcards
= <rsd_lib.resources.v2_2.telemetry_service.triggers.WildcardCollectionField object>¶ Wildcards used to replace values in MetricProperties array property.
-
-
class
rsd_lib.resources.v2_2.telemetry_service.triggers.
TriggersCollection
(connector, path, redfish_version=None, registries=None, root=None)¶ Bases:
rsd_lib.base.ResourceCollectionBase
-
create_trigger
(name=None, description=None, metric_type=None, trigger_actions=None, numeric_triggers=None, discrete_trigger_condition=None, discrete_triggers=None, status=None, wildcards=None, metric_properties=None)¶ Create a new trigger
- Parameters
name – The trigger name
description – The trigger description
metric_type – The type of trigger
trigger_actions – The metric report description
numeric_triggers – List of numeric triggers
discrete_trigger_condition – The value shall indicate how the corresponding metric
discrete_triggers – List of discrete triggers
status – The trigger status
wildcards – Wildcards used to replace values in MetricProperties array property
metric_properties – The report definition metric properties
- Returns
The uri of the new trigger
-
-
class
rsd_lib.resources.v2_2.telemetry_service.triggers.
WildcardCollectionField
(*args, **kwargs)¶ Bases:
sushy.resources.base.ListField
Wildcard field
Wildcards used to replace values in MetricProperties array property.
-
name
= <sushy.resources.base.Field object>¶ The name of Wildcard.
-
values
= <sushy.resources.base.Field object>¶ An array of values to substitute for the wildcard.
-