Component (md-sal 3.0.7-SNAPSHOT API)

All Superinterfaces:: Augmentable<Component>, BindingObject, ChildOf<Hardware>, DataContainer, DataObject, Identifiable<ComponentKey>

Deprecated.

@Deprecated
public interface Component
extends ChildOf<Hardware>, Augmentable<Component>, Identifiable<ComponentKey>

List of components. When the server detects a new hardware component, it initializes a list entry in the operational state. If the server does not support configuration of hardware components, list entries in the operational state are initialized with values for all nodes as detected by the implementation. Otherwise, this procedure is followed: 1. If there is an entry in the '/hardware/component' list in the intended configuration with values for the nodes 'class', 'parent', and 'parent-rel-pos' that are equal to the values, then: 1a. If the configured entry has a value for 'mfg-name' that is equal to the detected value or if the 'mfg-name' value cannot be detected, then the list entry in the operational state is initialized with the configured values for all configured nodes, including the 'name'. Otherwise, the list in the operational state is initialized with values for all nodes as detected the implementation. The implementation may raise an alarm that informs about 'mfg-name' mismatch condition. How this is done is outside the scope of this document. 1b. Otherwise (i.e., there is no matching configuration entry), the list entry in the operational state is initialized with values for all nodes as detected by the implementation. If the '/hardware/component' list in the intended configuration is modified, then the system MUST behave as if it re-initializes itself and follow the procedure in (1).

This class represents the following YANG schema fragment defined in module ietf-hardware-state

 list component {
   key name;
   status deprecated;
   leaf name {
     type string;
     status deprecated;
   }
   leaf class {
     type identityref {
       base ianahw:hardware-class;
     }
     status deprecated;
   }
   leaf physical-index {
     if-feature entity-mib;
     type int32 {
       range 1..2147483647;
     }
     status deprecated;
   }
   leaf description {
     type string;
     status deprecated;
   }
   leaf parent {
     type leafref {
       path ../../component/name;
       require-instance false;
     }
     status deprecated;
   }
   leaf parent-rel-pos {
     type int32 {
       range "0 .. 2147483647";
     }
     status deprecated;
   }
   leaf-list contains-child {
     type leafref {
       path ../../component/name;
     }
     status deprecated;
   }
   leaf hardware-rev {
     type string;
     status deprecated;
   }
   leaf firmware-rev {
     type string;
     status deprecated;
   }
   leaf software-rev {
     type string;
     status deprecated;
   }
   leaf serial-num {
     type string;
     status deprecated;
   }
   leaf mfg-name {
     type string;
     status deprecated;
   }
   leaf model-name {
     type string;
     status deprecated;
   }
   leaf alias {
     type string;
     status deprecated;
   }
   leaf asset-id {
     type string;
     status deprecated;
   }
   leaf is-fru {
     type boolean;
     status deprecated;
   }
   leaf mfg-date {
     type yang:date-and-time;
     status deprecated;
   }
   leaf-list uri {
     type inet:uri;
     status deprecated;
   }
   leaf uuid {
     type yang:uuid;
     status deprecated;
   }
   container state {
     if-feature hardware-state;
     status deprecated;
     leaf state-last-changed {
       type yang:date-and-time;
       status deprecated;
     }
     leaf admin-state {
       type hw:admin-state;
       status deprecated;
     }
     leaf oper-state {
       type hw:oper-state;
       status deprecated;
     }
     leaf usage-state {
       type hw:usage-state;
       status deprecated;
     }
     leaf alarm-state {
       type hw:alarm-state;
       status deprecated;
     }
     leaf standby-state {
       type hw:standby-state;
       status deprecated;
     }
   }
   container sensor-data {
     when
       "derived-from-or-self(../class,
                                           \"ianahw:sensor\")" {
     }
     if-feature hardware-sensor;
     status deprecated;
     leaf value {
       type hw:sensor-value;
       status deprecated;
     }
     leaf value-type {
       type hw:sensor-value-type;
       status deprecated;
     }
     leaf value-scale {
       type hw:sensor-value-scale;
       status deprecated;
     }
     leaf value-precision {
       type hw:sensor-value-precision;
       status deprecated;
     }
     leaf oper-status {
       type hw:sensor-status;
       status deprecated;
     }
     leaf units-display {
       type string;
       status deprecated;
     }
     leaf value-timestamp {
       type yang:date-and-time;
       status deprecated;
     }
     leaf value-update-rate {
       type uint32;
       units milliseconds;
       status deprecated;
     }
   }
 }

The schema path to identify an instance is ietf-hardware-state/hardware/component

To create instances of this class use ComponentBuilder.

See Also:: ComponentBuilder, ComponentKey

Field Summary

Fields
Modifier and Type Field and Description

static org.opendaylight.yangtools.yang.common.QName QNAME
Deprecated.

Fields
Modifier and Type	Field and Description
`static org.opendaylight.yangtools.yang.common.QName`	`QNAME` Deprecated.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`@Nullable String`	`getAlias()` Deprecated.
`@Nullable String`	`getAssetId()` Deprecated.
`@Nullable List<String>`	`getContainsChild()` Deprecated.
`@Nullable String`	`getDescription()` Deprecated.
`@Nullable String`	`getFirmwareRev()` Deprecated.
`@Nullable String`	`getHardwareRev()` Deprecated.
`@Nullable DateAndTime`	`getMfgDate()` Deprecated.
`@Nullable String`	`getMfgName()` Deprecated.
`@Nullable String`	`getModelName()` Deprecated.
`@Nullable String`	`getName()` Deprecated.
`@Nullable String`	`getParent()` Deprecated.
`@Nullable Integer`	`getParentRelPos()` Deprecated.
`@Nullable Integer`	`getPhysicalIndex()` Deprecated.
`@Nullable SensorData`	`getSensorData()` Deprecated.
`@Nullable String`	`getSerialNum()` Deprecated.
`@Nullable String`	`getSoftwareRev()` Deprecated.
`@Nullable State`	`getState()` Deprecated.
`@Nullable List<Uri>`	`getUri()` Deprecated.
`@Nullable Uuid`	`getUuid()` Deprecated.
`@Nullable Class<? extends HardwareClass>`	`getXmlClass()` Deprecated.
`@Nullable Boolean`	`isIsFru()` Deprecated.
`ComponentKey`	`key()` Deprecated. Returns an unique key for the object.

Methods inherited from interface org.opendaylight.yangtools.yang.binding.DataContainer
getImplementedInterface

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable
augmentation

- Field Detail
  - QNAME
```
static final org.opendaylight.yangtools.yang.common.QName QNAME
```
    Deprecated.
- Method Detail
  - getName
```
@Deprecated
@Nullable String getName()
```
    Deprecated.
    
    The name assigned to this component.This name is not required to be the same asentPhysicalName.
    
    Returns:
    
    java.lang.String name, or null if not present
  - getXmlClass
```
@Deprecated
@Nullable Class<? extends HardwareClass> getXmlClass()
```
    Deprecated.
    
    An indication of the general hardware type of thecomponent.
    
    Returns:
    
    java.lang.Class xmlClass, or null if not present
  - getPhysicalIndex
```
@Deprecated
@Nullable Integer getPhysicalIndex()
```
    Deprecated.
    
    The entPhysicalIndex for the entPhysicalEntry representedby this list entry.
    
    Returns:
    
    java.lang.Integer physicalIndex, or null if not present
  - getDescription
```
@Deprecated
@Nullable String getDescription()
```
    Deprecated.
    
    A textual description of the component. This node shouldcontain a string that identifies the manufacturer's namefor the component and should be set to a distinct valuefor each version or model of the component.
    
    Returns:
    
    java.lang.String description, or null if not present
  - getParent
```
@Deprecated
@Nullable String getParent()
```
    Deprecated.
    
    The name of the component that physically contains thiscomponent.If this leaf is not instantiated, it indicates that thiscomponent is not contained in any other component.In the event that a physical component is contained bymore than one physical component (e.g., double-widemodules), this node contains the name of one of thesecomponents. An implementation MUST use the same nameevery time this node is instantiated.
    
    Returns:
    
    java.lang.String parent, or null if not present
  - getParentRelPos
```
@Deprecated
@Nullable Integer getParentRelPos()
```
    Deprecated.
    
    An indication of the relative position of this childcomponent among all its sibling components. Siblingcomponents are defined as components that: o share the same value of the 'parent' node and o share a common base identity for the 'class' node.Note that the last rule gives implementations flexibilityin how components are numbered. For example, someimplementations might have a single number series for allcomponents derived from 'ianahw:port', while some othersmight have different number series for differentcomponents with identities derived from 'ianahw:port' (forexample, one for RJ45 and one for SFP).
    
    Returns:
    
    java.lang.Integer parentRelPos, or null if not present
  - getContainsChild
```
@Deprecated
@Nullable List<String> getContainsChild()
```
    Deprecated.
    
    The name of the contained component.
    
    Returns:
    
    java.util.List containsChild, or null if not present
  - getHardwareRev
```
@Deprecated
@Nullable String getHardwareRev()
```
    Deprecated.
    
    The vendor-specific hardware revision string for thecomponent. The preferred value is the hardware revisionidentifier actually printed on the component itself (ifpresent).
    
    Returns:
    
    java.lang.String hardwareRev, or null if not present
  - getFirmwareRev
```
@Deprecated
@Nullable String getFirmwareRev()
```
    Deprecated.
    
    The vendor-specific firmware revision string for thecomponent.
    
    Returns:
    
    java.lang.String firmwareRev, or null if not present
  - getSoftwareRev
```
@Deprecated
@Nullable String getSoftwareRev()
```
    Deprecated.
    
    The vendor-specific software revision string for thecomponent.
    
    Returns:
    
    java.lang.String softwareRev, or null if not present
  - getSerialNum
```
@Deprecated
@Nullable String getSerialNum()
```
    Deprecated.
    
    The vendor-specific serial number string for thecomponent. The preferred value is the serial numberstring actually printed on the component itself (ifpresent).
    
    Returns:
    
    java.lang.String serialNum, or null if not present
  - getMfgName
```
@Deprecated
@Nullable String getMfgName()
```
    Deprecated.
    
    The name of the manufacturer of this physical component.The preferred value is the manufacturer name stringactually printed on the component itself (if present).Note that comparisons between instances of the'model-name', 'firmware-rev', 'software-rev', and'serial-num' nodes are only meaningful amongst componentswith the same value of 'mfg-name'.If the manufacturer name string associated with thephysical component is unknown to the server, then thisnode is not instantiated.
    
    Returns:
    
    java.lang.String mfgName, or null if not present
  - getModelName
```
@Deprecated
@Nullable String getModelName()
```
    Deprecated.
    
    The vendor-specific model name identifier stringassociated with this physical component. The preferredvalue is the customer-visible part number, which may beprinted on the component itself.If the model name string associated with the physicalcomponent is unknown to the server, then this node is notinstantiated.
    
    Returns:
    
    java.lang.String modelName, or null if not present
  - getAlias
```
@Deprecated
@Nullable String getAlias()
```
    Deprecated.
    
    An 'alias' name for the component, as specified by anetwork manager, that provides a non-volatile 'handle' forthe component.If no configured value exists, the server MAY set thevalue of this node to a locally unique value in theoperational state.A server implementation MAY map this leaf to theentPhysicalAlias MIB object. Such an implementation needsto use some mechanism to handle the differences in sizeand characters allowed between this leaf andentPhysicalAlias. The definition of such a mechanism isoutside the scope of this document.
    
    Returns:
    
    java.lang.String alias, or null if not present
  - getAssetId
```
@Deprecated
@Nullable String getAssetId()
```
    Deprecated.
    
    This node is a user-assigned asset tracking identifier forthe component.A server implementation MAY map this leaf to theentPhysicalAssetID MIB object. Such an implementationneeds to use some mechanism to handle the differences insize and characters allowed between this leaf andentPhysicalAssetID. The definition of such a mechanism isoutside the scope of this document.
    
    Returns:
    
    java.lang.String assetId, or null if not present
  - isIsFru
```
@Deprecated
@Nullable Boolean isIsFru()
```
    Deprecated.
    
    This node indicates whether or not this component isconsidered a 'field-replaceable unit' by the vendor. Ifthis node contains the value 'true', then this componentidentifies a field-replaceable unit. For all componentsthat are permanently contained within a field-replaceableunit, the value 'false' should be returned for thisnode.
    
    Returns:
    
    java.lang.Boolean isFru, or null if not present
  - getMfgDate
```
@Deprecated
@Nullable DateAndTime getMfgDate()
```
    Deprecated.
    
    The date of manufacturing of the managed component.
    
    Returns:
    
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime mfgDate, or null if not present
  - getUri
```
@Deprecated
@Nullable List<Uri> getUri()
```
    Deprecated.
    
    This node contains identification information about thecomponent.
    
    Returns:
    
    java.util.List uri, or null if not present
  - getUuid
```
@Deprecated
@Nullable Uuid getUuid()
```
    Deprecated.
    
    A Universally Unique Identifier of the component.
    
    Returns:
    
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid uuid, or null if not present
  - getState
```
@Deprecated
@Nullable State getState()
```
    Deprecated.
    
    State-related nodes
    
    Returns:
    
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.state.rev180313.hardware.component.State state, or null if not present
  - getSensorData
```
@Deprecated
@Nullable SensorData getSensorData()
```
    Deprecated.
    
    Sensor-related nodes.
    
    Returns:
    
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.state.rev180313.hardware.component.SensorData sensorData, or null if not present
  - key
```
ComponentKey key()
```
    Deprecated.
    
    Description copied from interface: Identifiable
    
    Returns an unique key for the object.
    
    Specified by:
    
    key in interface Identifiable<ComponentKey>
    
    Returns:
    
    Key for the object

Interface Component

Field Summary

Method Summary

Methods inherited from interface org.opendaylight.yangtools.yang.binding.DataContainer

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

Field Detail

QNAME

Method Detail

getName

getXmlClass

getPhysicalIndex

getDescription

getParent

getParentRelPos

getContainsChild

getHardwareRev

getFirmwareRev

getSoftwareRev

getSerialNum

getMfgName

getModelName

getAlias

getAssetId

isIsFru

getMfgDate

getUri

getUuid

getState

getSensorData

key