The rsd_lib.resources.v2_2.telemetry_service.metric_report_definition Module

class rsd_lib.resources.v2_2.telemetry_service.metric_report_definition.MetricReportDefinition(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)

Bases: rsd_lib.base.ResourceBase

MetricReportDefinition resource class

A set of metrics that are collected periodically.

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

Time scope for collecting the corresponding metric values.

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

A collection of URI that relates to the metric properties that will be included in the metric report.

property metric_report

Property to provide reference to MetricReport instance

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

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

The collection type for the corresponding metric values.

property metrics

Property to provide collection to Metric

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

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

This property specifies what action is perform when a metric report is generated.

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

A schedule for collecting metric values.

status = <rsd_lib.base.StatusField object>

This indicates the known state of the resource, such as if it is enabled.

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_service.metric_report_definition.WildcardCollectionField object>

Wildcards used to replace values in MetricProperties array property.

class rsd_lib.resources.v2_2.telemetry_service.metric_report_definition.MetricReportDefinitionCollection(connector, path, redfish_version=None, registries=None, root=None)

Bases: rsd_lib.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_service.metric_report_definition.ScheduleField(*args, **kwargs)

Bases: sushy.resources.base.CompositeField

Schedule field

Schedule a series of occurrences.

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

Days of month when scheduled occurrences are enabled.

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

Days of the week when scheduled occurrences are enabled, for enabled days of month and months of year.

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

Intervals when scheduled occurrences are enabled.

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

Months of year when scheduled occurrences are enabled.

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

Time for initial occurrence.

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

The time after provisioning when the schedule as a whole expires.

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

Maximum number of scheduled occurrences.

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

The Schedule name.

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

Distance until the next occurrences.

class rsd_lib.resources.v2_2.telemetry_service.metric_report_definition.WildcardCollectionField(*args, **kwargs)

Bases: sushy.resources.base.ListField

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

An array of Key values to substitute for the wildcard.

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

The name of Wildcard.