Documentation ¶
Overview ¶
This module contains a collection of YANG definitions for monitoring of platform components. Copyright (c) 2016-2017 by Cisco Systems, Inc. All rights reserved.
Index ¶
- type Components
- type Components_Component
- type Components_Component_PlatformProperties
- type Components_Component_PlatformProperties_PlatformProperty
- type Components_Component_PlatformProperties_PlatformProperty_Value
- type Components_Component_PlatformSubcomponents
- type Components_Component_PlatformSubcomponents_PlatformSubcomponent
- type Components_Component_State
- type Components_Component_State_Temp
- type PlatformCompType
- type PlatformPropValueType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Components ¶
type Components struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // List of components, keyed by component name. The type is slice of // Components_Component. Component []*Components_Component }
Components Enclosing container for the components in the system
func (*Components) GetEntityData ¶
func (components *Components) GetEntityData() *types.CommonEntityData
type Components_Component ¶
type Components_Component struct { EntityData types.CommonEntityData YFilter yfilter.YFilter YListKey string // This attribute is a key. References component name. The type is string. Cname interface{} // Operational state data for each component. State Components_Component_State // Platform component properties. PlatformProperties Components_Component_PlatformProperties // Platform subcomponents. PlatformSubcomponents Components_Component_PlatformSubcomponents }
Components_Component List of components, keyed by component name
func (*Components_Component) GetEntityData ¶
func (component *Components_Component) GetEntityData() *types.CommonEntityData
type Components_Component_PlatformProperties ¶
type Components_Component_PlatformProperties struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // List of platform component properties. The type is slice of // Components_Component_PlatformProperties_PlatformProperty. PlatformProperty []*Components_Component_PlatformProperties_PlatformProperty }
Components_Component_PlatformProperties Platform component properties
func (*Components_Component_PlatformProperties) GetEntityData ¶
func (platformProperties *Components_Component_PlatformProperties) GetEntityData() *types.CommonEntityData
type Components_Component_PlatformProperties_PlatformProperty ¶
type Components_Component_PlatformProperties_PlatformProperty struct { EntityData types.CommonEntityData YFilter yfilter.YFilter YListKey string // This attribute is a key. Property name. The type is string. Name interface{} // Indication of whether the property is user-configurable. The type is bool. Configurable interface{} // Property value. Value Components_Component_PlatformProperties_PlatformProperty_Value }
Components_Component_PlatformProperties_PlatformProperty List of platform component properties
func (*Components_Component_PlatformProperties_PlatformProperty) GetEntityData ¶
func (platformProperty *Components_Component_PlatformProperties_PlatformProperty) GetEntityData() *types.CommonEntityData
type Components_Component_PlatformProperties_PlatformProperty_Value ¶
type Components_Component_PlatformProperties_PlatformProperty_Value struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // String property value. The type is string. String interface{} // Boolean property value. The type is bool. Boolean interface{} // Integer64 property value. The type is interface{} with range: // -9223372036854775808..9223372036854775807. Intsixfour interface{} // Unsigned integer64 property value. The type is interface{} with range: // 0..18446744073709551615. Uintsixfour interface{} // Decimal64 property value. The type is string with range: // -92233720368547758.08..92233720368547758.07. Decimal interface{} }
Components_Component_PlatformProperties_PlatformProperty_Value Property value
func (*Components_Component_PlatformProperties_PlatformProperty_Value) GetEntityData ¶
func (value *Components_Component_PlatformProperties_PlatformProperty_Value) GetEntityData() *types.CommonEntityData
type Components_Component_PlatformSubcomponents ¶
type Components_Component_PlatformSubcomponents struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // List of platform subcomponents. The type is slice of // Components_Component_PlatformSubcomponents_PlatformSubcomponent. PlatformSubcomponent []*Components_Component_PlatformSubcomponents_PlatformSubcomponent }
Components_Component_PlatformSubcomponents Platform subcomponents
func (*Components_Component_PlatformSubcomponents) GetEntityData ¶
func (platformSubcomponents *Components_Component_PlatformSubcomponents) GetEntityData() *types.CommonEntityData
type Components_Component_PlatformSubcomponents_PlatformSubcomponent ¶
type Components_Component_PlatformSubcomponents_PlatformSubcomponent struct { EntityData types.CommonEntityData YFilter yfilter.YFilter YListKey string // This attribute is a key. Subcomponent name. The type is string. Name interface{} }
Components_Component_PlatformSubcomponents_PlatformSubcomponent List of platform subcomponents
func (*Components_Component_PlatformSubcomponents_PlatformSubcomponent) GetEntityData ¶
func (platformSubcomponent *Components_Component_PlatformSubcomponents_PlatformSubcomponent) GetEntityData() *types.CommonEntityData
type Components_Component_State ¶
type Components_Component_State struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // Type of component as identified by the system. The type is // PlatformCompType. Type interface{} // Unique identifier assigned to the component by the system. The type is // string. Id interface{} // System-supplied description of the component. The type is string. Description interface{} // System-supplied identifier for the manufacturer of the component. This // data is particularly useful when a component manufacturer is different than // the overall device vendor. The type is string. MfgName interface{} // System-defined version string for a hardware, firmware, or software // component. The type is string. Version interface{} // System-assigned serial number of the component. The type is string. SerialNo interface{} // System-assigned part number for the component. This should be present in // particular if the component is also an FRU (field replacable unit). The // type is string. PartNo interface{} // Temperature in degrees Celsius of the component. Values include the // instantaneous, average, minimum, and maximum statistics. If avg/min/max // statistics are not supported, the target is expected to just supply the // instant value. Temp Components_Component_State_Temp }
Components_Component_State Operational state data for each component
func (*Components_Component_State) GetEntityData ¶
func (state *Components_Component_State) GetEntityData() *types.CommonEntityData
type Components_Component_State_Temp ¶
type Components_Component_State_Temp struct { EntityData types.CommonEntityData YFilter yfilter.YFilter // Instantaneous temperature value of a component. The type is string with // range: -92233720368547758.08..92233720368547758.07. TempInstant interface{} // Arithmetic mean value of the statistic over a sampling period. The type is // string with range: -92233720368547758.08..92233720368547758.07. TempAvg interface{} // High water mark value of the statistic over a sampling period. The type is // string with range: -92233720368547758.08..92233720368547758.07. TempMax interface{} // Low water mark value of the statistic over a sampling period. The type is // string with range: -92233720368547758.08..92233720368547758.07. TempMin interface{} }
Components_Component_State_Temp Temperature in degrees Celsius of the component. Values include the instantaneous, average, minimum, and maximum statistics. If avg/min/max statistics are not supported, the target is expected to just supply the instant value
func (*Components_Component_State_Temp) GetEntityData ¶
func (temp *Components_Component_State_Temp) GetEntityData() *types.CommonEntityData
type PlatformCompType ¶
type PlatformCompType string
PlatformCompType represents Component Type
const ( PlatformCompType_comp_chassis PlatformCompType = "comp-chassis" PlatformCompType_comp_backplane PlatformCompType = "comp-backplane" PlatformCompType_comp_power_supply PlatformCompType = "comp-power-supply" PlatformCompType_comp_fan PlatformCompType = "comp-fan" PlatformCompType_comp_sensor PlatformCompType = "comp-sensor" PlatformCompType_comp_module PlatformCompType = "comp-module" PlatformCompType_comp_linecard PlatformCompType = "comp-linecard" PlatformCompType_comp_port PlatformCompType = "comp-port" PlatformCompType_comp_cpu PlatformCompType = "comp-cpu" PlatformCompType_comp_operating_system PlatformCompType = "comp-operating-system" PlatformCompType_comp_optical_channel PlatformCompType = "comp-optical-channel" PlatformCompType_comp_container PlatformCompType = "comp-container" )
type PlatformPropValueType ¶
type PlatformPropValueType string
PlatformPropValueType represents Property value type
const ( PlatformPropValueType_property_string PlatformPropValueType = "property-string" PlatformPropValueType_property_boolean PlatformPropValueType = "property-boolean" PlatformPropValueType_property_int64 PlatformPropValueType = "property-int64" PlatformPropValueType_property_uint64 PlatformPropValueType = "property-uint64" PlatformPropValueType_property_decimal64 PlatformPropValueType = "property-decimal64" )