public interface Component extends ChildOf<Hardware>, Augmentable<Component>, Identifiable<ComponentKey>
This class represents the following YANG schema fragment defined in module ietf-hardware
list component {
key name;
leaf name {
type string;
}
leaf class {
type identityref {
base ianahw:hardware-class;
}
}
leaf physical-index {
if-feature entity-mib;
type int32 {
range 1..2147483647;
}
config false;
}
leaf description {
type string;
config false;
}
leaf parent {
type leafref {
path ../../component/name;
require-instance false;
}
}
leaf parent-rel-pos {
type int32 {
range "0 .. 2147483647";
}
}
leaf-list contains-child {
type leafref {
path ../../component/name;
}
config false;
}
leaf hardware-rev {
type string;
config false;
}
leaf firmware-rev {
type string;
config false;
}
leaf software-rev {
type string;
config false;
}
leaf serial-num {
type string;
config false;
}
leaf mfg-name {
type string;
config false;
}
leaf model-name {
type string;
config false;
}
leaf alias {
type string;
}
leaf asset-id {
type string;
}
leaf is-fru {
type boolean;
config false;
}
leaf mfg-date {
type yang:date-and-time;
config false;
}
leaf-list uri {
type inet:uri;
}
leaf uuid {
type yang:uuid;
config false;
}
container state {
if-feature hardware-state;
leaf state-last-changed {
type yang:date-and-time;
config false;
}
leaf admin-state {
type admin-state;
}
leaf oper-state {
type oper-state;
config false;
}
leaf usage-state {
type usage-state;
config false;
}
leaf alarm-state {
type alarm-state;
config false;
}
leaf standby-state {
type standby-state;
config false;
}
}
container sensor-data {
when
"derived-from-or-self(../class,
\"ianahw:sensor\")" {
}
if-feature hardware-sensor;
config false;
leaf value {
type sensor-value;
}
leaf value-type {
type sensor-value-type;
}
leaf value-scale {
type sensor-value-scale;
}
leaf value-precision {
type sensor-value-precision;
}
leaf oper-status {
type sensor-status;
}
leaf units-display {
type string;
}
leaf value-timestamp {
type yang:date-and-time;
}
leaf value-update-rate {
type uint32;
units milliseconds;
}
}
}
The schema path to identify an instance is
ietf-hardware/hardware/component
To create instances of this class use ComponentBuilder.
ComponentBuilder,
ComponentKey| Modifier and Type | Field and Description |
|---|---|
static org.opendaylight.yangtools.yang.common.QName |
QNAME |
| Modifier and Type | Method and Description |
|---|---|
@Nullable String |
getAlias()
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.
|
@Nullable String |
getAssetId()
This node is a user-assigned asset tracking identifier forthe component.A server
implementation MAY map this leaf to theentPhysicalAssetID MIB object.
|
@Nullable List<String> |
getContainsChild()
The name of the contained component.
|
@Nullable String |
getDescription()
A textual description of the component.
|
@Nullable String |
getFirmwareRev()
The vendor-specific firmware revision string for thecomponent.
|
@Nullable String |
getHardwareRev()
The vendor-specific hardware revision string for thecomponent.
|
@Nullable DateAndTime |
getMfgDate()
The date of manufacturing of the managed component.
|
@Nullable String |
getMfgName()
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.
|
@Nullable String |
getModelName()
The vendor-specific model name identifier stringassociated with this physical
component.
|
@Nullable String |
getName()
The name assigned to this component.This name is not required to be the same
asentPhysicalName.
|
@Nullable String |
getParent()
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.
|
@Nullable Integer |
getParentRelPos()
An indication of the relative position of this childcomponent among all its
sibling components.
|
@Nullable Integer |
getPhysicalIndex()
The entPhysicalIndex for the entPhysicalEntry representedby this list entry.
|
@Nullable SensorData |
getSensorData()
Sensor-related nodes.
|
@Nullable String |
getSerialNum()
The vendor-specific serial number string for thecomponent.
|
@Nullable String |
getSoftwareRev()
The vendor-specific software revision string for thecomponent.
|
@Nullable State |
getState()
State-related nodes
|
@Nullable List<Uri> |
getUri()
This node contains identification information about thecomponent.
|
@Nullable Uuid |
getUuid()
A Universally Unique Identifier of the component.
|
@Nullable Class<? extends HardwareClass> |
getXmlClass()
An indication of the general hardware type of thecomponent.
|
@Nullable Boolean |
isIsFru()
This node indicates whether or not this component isconsidered a
'field-replaceable unit' by the vendor.
|
ComponentKey |
key()
Returns an unique key for the object.
|
getImplementedInterfaceaugmentation@Nullable String getName()
java.lang.String name, or null if not present@Nullable Class<? extends HardwareClass> getXmlClass()
java.lang.Class xmlClass, or null if not present@Nullable Integer getPhysicalIndex()
java.lang.Integer physicalIndex, or null if not present@Nullable String getDescription()
java.lang.String description, or null if not present@Nullable String getParent()
java.lang.String parent, or null if not present@Nullable Integer getParentRelPos()
java.lang.Integer parentRelPos, or null if not present@Nullable List<String> getContainsChild()
java.util.List containsChild, or null if not present@Nullable String getHardwareRev()
java.lang.String hardwareRev, or null if not present@Nullable String getFirmwareRev()
java.lang.String firmwareRev, or null if not present@Nullable String getSoftwareRev()
java.lang.String softwareRev, or null if not present@Nullable String getSerialNum()
java.lang.String serialNum, or null if not present@Nullable String getMfgName()
java.lang.String mfgName, or null if not present@Nullable String getModelName()
java.lang.String modelName, or null if not present@Nullable String getAlias()
java.lang.String alias, or null if not present@Nullable String getAssetId()
java.lang.String assetId, or null if not present@Nullable Boolean isIsFru()
java.lang.Boolean isFru, or null if not present@Nullable DateAndTime getMfgDate()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime mfgDate, or null if not present@Nullable List<Uri> getUri()
java.util.List uri, or null if not present@Nullable Uuid getUuid()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid uuid, or null if not present@Nullable State getState()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313.hardware.component.State state, or null if not present@Nullable SensorData getSensorData()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313.hardware.component.SensorData sensorData, or null if not presentComponentKey key()
Identifiablekey in interface Identifiable<ComponentKey>Copyright © 2019 OpenDaylight. All rights reserved.