The rsd_lib.resources.v2_2.telemetry.metric_report_definition Module

The rsd_lib.resources.v2_2.telemetry.metric_report_definition Module

class rsd_lib.resources.v2_2.telemetry.metric_report_definition.MetricReportDefinition(connector, identity, redfish_version=None)

Bases: sushy.resources.base.ResourceBase

collection_time_scope = <sushy.resources.base.Field object>

The value shall specify the time scope for collecting the corresponding metric values

delete()

Delete report definition

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

The metric report definition description

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

The metric report definition identity

metric_properties = <sushy.resources.base.Field object>

The report definition metric properties

metric_report

Property to provide reference to MetricReport instance

It is calculated once the first time it is queried. On refresh, this property is reset.

metric_report_type = <sushy.resources.base.Field object>

The value shall specify the collection type for the corresponding metric values

metrics

Property to provide collection to Metric

It is calculated once the first time it is queried. On refresh, this property is reset.

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

The metric report definition name

report_actions = <sushy.resources.base.Field object>

The value of this property shall specify the action to perform when the metric report is generated. When a metric report is generated, place the metric information in the resource specified by the MetricReport property. The Volatile property will specify the behavior if MetricReport resource already exists.

schedule = <rsd_lib.resources.v2_2.telemetry.metric_report_definition.ScheduleField object>

If present, A metric values collected starting at each scheduled interval and for the time specified by Duration. No more than Schedule.MaxOccurrences values shall be collected for this metric. If not present, the corresponding metric values shall be collected when the related metric report is retrieved.

status = <rsd_lib.common.StatusField object>

The report definition status

volatile = <sushy.resources.base.Field object>

Entries in the resulting metric value properties are reused on each scheduled interval

wildcards = <rsd_lib.resources.v2_2.telemetry.metric_report_definition.WildcardsField object>

The property shall contain an array of wildcards and their replacements strings, which are to appliced to the MetricProperties array property

class rsd_lib.resources.v2_2.telemetry.metric_report_definition.MetricReportDefinitionCollection(connector, path, redfish_version=None)

Bases: sushy.resources.base.ResourceCollectionBase

create_metric_report_definition(metric_report_definition_req)

Create a new report definition

Parameters:metric_report_definition_req – JSON for event subscription
Returns:The uri of the new event report definition
class rsd_lib.resources.v2_2.telemetry.metric_report_definition.ScheduleField(*args, **kwargs)

Bases: sushy.resources.base.CompositeField

recurrence_interval = <sushy.resources.base.Field object>

The schedule recurrence interval

class rsd_lib.resources.v2_2.telemetry.metric_report_definition.WildcardsField(*args, **kwargs)

Bases: sushy.resources.base.ListField

keys = <sushy.resources.base.Field object>

If the value is an empty string, then the server shall substitute every current key. Each not empty key value shall be substituted for the wildcard

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

This property shall contain a name for a Wildcard for a key

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.