org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313

Interface Hardware

All Superinterfaces:

Augmentable<Hardware>, BindingObject, ChildOf<IetfHardwareData>, DataContainer, DataObject

public interface Hardware
extends ChildOf<IetfHardwareData>, Augmentable<Hardware>

Data nodes representing components. If the server supports configuration of hardware components, then this data model is instantiated in the configuration datastores supported by the server. The leaf-list 'datastore' for the module 'ietf-hardware' in the YANG library provides this information.

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

 container hardware {
   leaf last-change {
     type yang:date-and-time;
     config false;
   }
   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

To create instances of this class use HardwareBuilder.

See Also:

HardwareBuilder

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
@Nullable List<Component>	getComponent() List of components.When the server detects a new hardware component, itinitializes a list entry in the operational state.If the server does not support configuration of hardwarecomponents, list entries in the operational state areinitialized with values for all nodes as detected by theimplementation.Otherwise, this procedure is followed: 1.
@Nullable DateAndTime	getLastChange() The time the '/hardware/component' list changed in theoperational state.
default @NonNull List<Component>	nonnullComponent()

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

Method Detail

getLastChange

@Nullable DateAndTime getLastChange()

The time the '/hardware/component' list changed in theoperational state.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime lastChange, or null if not present

getComponent

@Nullable List<Component> getComponent()

List of components.When the server detects a new hardware component, itinitializes a list entry in the operational state.If the server does not support configuration of hardwarecomponents, list entries in the operational state areinitialized with values for all nodes as detected by theimplementation.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 detected values, then the list entry in the operational state is initialized with the configured values, including the 'name'. 2. 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 intendedconfiguration is modified, then the system MUST behave as ifit re-initializes itself and follow the procedure in (1).

Returns:

java.util.List component, or null if not present

nonnullComponent

default @NonNull List<Component> nonnullComponent()

Returns:

java.util.List component, or an empty list if it is not present