GREEN Controller YANG

Controller Energy Network State This section describes how to the Energy Controller renders an energy network overview of the devices and their major components that clients may query.

YANG Tree The current working assumption is that the energy controller superimposes the energy network view on top of an IVY inventory topology. The IVY components are augmented with information about the component's instantaneous-power, total-energy-consumed etc. Each component may also declare its energy relations. The relations describe which other components does this component powers or meters, and what it is powered-by.

YANG tree diagram of the energy network. ../../../../../nw:node/node-id +--rw peer-component* [peer-component] +--rw peer-component -> ../../../../../../nw:node[nw:node-id=current()/../../peer-node]/pen:energy-node-attributes/component/component-id +--rw details? string augment /nwi:network-inventory/nwi:network-elements/nwi:network-element/nwi:components/nwi:component: +--ro power | +--ro instantaneous-power? int64 | +--ro nameplate-power? uint32 | +--ro data-source-accuracy? identityref | +--ro power-factor? power-factor | +--ro measurement-local? boolean +--ro energy +--ro total-energy-consumed? uint64 +--ro total-energy-delivered? uint64 +--ro data-source-accuracy? identityref +--ro measurement-local? boolean +--ro certifications* identityref grouping references: +-- references +-- ref-string? string +-- ref-ietf-hw? string grouping relationship-set: +-- relationship* [type peer-node] +-- type identityref +-- peer-node -> ../../../../../nw:node/node-id +-- peer-component* [peer-component] +-- peer-component -> ../../../../../../nw:node[nw:node-id=current()/../../peer-node]/pen:energy-node-attributes/component/component-id +-- details? string ]]>

Example In order to make this YANG module a little more digestible, here follows a simple YANG instance data example of what a small energy network might look like. In this example, we have three Routers in a triangle formation. Each router has either an IP Phone or a Wifi Access Point attached to one of its line cards, which also deliver power to this device. The example's first section shows a classic network underlay called "green-underlay-1". It lists the nodes in the network and describes how their data paths are connected. The second section is more interesting from an energy point of view. It shows the same network seen as an energy network, "green-energy-1". For each node in the network we see its node-id used by the controller, references to what the node is called in some other contexts, and the current power and energy data. Then a list of components living on this node. For each component, there is a component-id and references to alternate names of this node in other contexts. Then power and energy data for this component, and the energy relationships this component has with other components, such as powered-by or metering.

YANG Modules

Types and Groupings WG List: "; description "Base identities, typedefs, and reusable power and energy attributes."; revision 2026-07-02 { description "Initial revision."; reference "RFC XXX: Energy Object YANG Data Model"; } identity data-source-accuracy { description "Base identity for all possible data accuracy types."; } identity accuracy-unknown { base data-source-accuracy; description "The accuracy of the power data is unknown."; } identity accuracy-unavailable { base accuracy-unknown; description "A power data is not available for some reason, such as a sensor failure or a component being powered off."; } identity accuracy-like-parent { base data-source-accuracy; description "The accuracy of the power and energy data is inherited from the parent object."; } identity accuracy-estimated { base data-source-accuracy; description "The power data is estimated rather than directly measured."; } identity accuracy-static { base accuracy-estimated; description "Static data such as manufacturer specifications or nameplate ratings."; } identity accuracy-historic { base accuracy-estimated; description "Historic measurement data for this specific system and usage pattern."; } identity accuracy-learned { base accuracy-estimated; description "A machine-learning-based prediction."; } identity accuracy-measured { base data-source-accuracy; description "The power data is a direct, real-time measurement from a sensor."; } identity accuracy-measured-bronze { base accuracy-measured; description "Direct measurement with bronze accuracy."; } identity accuracy-measured-bronze-1 { base accuracy-measured-bronze; description "Bronze accuracy with +/-1 absolute unit."; } identity accuracy-measured-bronze-10 { base accuracy-measured-bronze; description "Bronze accuracy with +/-10 absolute units."; } identity accuracy-measured-bronze-100 { base accuracy-measured-bronze; description "Bronze accuracy with +/-100 absolute units."; } identity accuracy-measured-bronze-1000 { base accuracy-measured-bronze; description "Bronze accuracy with +/-1000 absolute units."; } identity accuracy-measured-silver { base accuracy-measured; description "Direct measurement with silver accuracy."; } identity accuracy-measured-silver-1 { base accuracy-measured-silver; description "Silver accuracy with +/-1 absolute unit."; } identity accuracy-measured-silver-10 { base accuracy-measured-silver; description "Silver accuracy with +/-10 absolute units."; } identity accuracy-measured-silver-100 { base accuracy-measured-silver; description "Silver accuracy with +/-100 absolute units."; } identity accuracy-measured-silver-1000 { base accuracy-measured-silver; description "Silver accuracy with +/-1000 absolute units."; } identity accuracy-measured-gold { base accuracy-measured; description "Direct measurement with gold accuracy."; } identity accuracy-measured-gold-1 { base accuracy-measured-gold; description "Gold accuracy with +/-1 absolute unit."; } identity accuracy-measured-gold-10 { base accuracy-measured-gold; description "Gold accuracy with +/-10 absolute units."; } identity accuracy-measured-gold-100 { base accuracy-measured-gold; description "Gold accuracy with +/-100 absolute units."; } identity accuracy-measured-gold-1000 { base accuracy-measured-gold; description "Gold accuracy with +/-1000 absolute units."; } identity accuracy-measured-red { base accuracy-measured; description "Direct measurement with red accuracy."; } identity accuracy-measured-red-1 { base accuracy-measured-red; description "Red accuracy with +/-1 absolute unit."; } identity accuracy-measured-red-10 { base accuracy-measured-red; description "Red accuracy with +/-10 absolute units."; } identity accuracy-measured-red-100 { base accuracy-measured-red; description "Red accuracy with +/-100 absolute units."; } identity accuracy-measured-red-1000 { base accuracy-measured-red; description "Red accuracy with +/-1000 absolute units."; } identity accuracy-measured-ones { base accuracy-measured; description "All digits are valid except trailing zeros."; } typedef power-factor { type uint8 { range "0 .. 100"; } default 100; description "Percent value of the power factor measurement."; } identity power-state { description "Base identity for all possible power states."; } identity power-state-on { base power-state; description "Full power on."; } identity power-state-off { base power-state; description "Power off."; } identity power-state-sleep { base power-state; description "Low-power state."; } identity energy-relationship-type { description "Base identity for energy object relationships."; } identity powered-by { base energy-relationship-type; description "Energy Object A is powered by Energy Object B."; } identity powering { base energy-relationship-type; description "Energy Object A is powering Energy Object B."; } identity metered-by { base energy-relationship-type; description "Energy Object A is metered by Energy Object B."; } identity metering { base energy-relationship-type; description "Energy Object A is metering Energy Object B."; } identity aggregated-by { base energy-relationship-type; description "Energy Object A is aggregated by Energy Object B."; } identity aggregating { base energy-relationship-type; description "Energy Object A is aggregating Energy Object B."; } identity enabled-by { base energy-relationship-type; description "Energy Object A is enabled by Energy Object B."; } identity enabling { base energy-relationship-type; description "Energy Object A is enabling Energy Object B."; } grouping power-and-energy-attributes { description "Reusable power and energy measurement attributes."; container power { description "Container for power measurement attributes."; leaf instantaneous-power { type int64; units "mWatts"; description "Instantaneous power usage for the energy object."; } leaf nameplate-power { type uint32; units "Watts"; description "Nameplate power rating of the energy object."; } leaf data-source-accuracy { type identityref { base data-source-accuracy; } default accuracy-like-parent; description "Accuracy of the power data source."; } leaf power-factor { type power-factor; description "Percent value of the power factor measurement."; } leaf measurement-local { type boolean; description "Indicates whether the power measurement is local or remote."; } } container energy { description "Container for energy measurement attributes."; leaf total-energy-consumed { type uint64; units "Watt-hours"; description "Total cumulative energy consumed since the last reset."; } leaf total-energy-delivered { type uint64; units "Watt-hours"; description "Total cumulative energy delivered since the last reset."; } leaf data-source-accuracy { type identityref { base data-source-accuracy; } default accuracy-like-parent; description "Accuracy of the energy data source."; } leaf measurement-local { type boolean; description "Indicates whether the energy measurement is local or remote."; } leaf-list certifications { type identityref { base ianaeo:certification-type; } description "Certifications applicable to this energy object."; } } } } ]]>

Energy Network State WG List: "; description "Augments the network inventory model with reusable power and energy attributes for network components and defines a network-wide energy flow view."; revision 2026-09-26 { description "Initial revision."; reference "RFC XXX: Energy Object YANG Data Model"; } grouping references { description "A set of optional identifiers for correlating an energy node or component with external systems. Multiple references may be present simultaneously."; container references { description "External references for this object."; leaf ref-string { type string; description "Implementation-specific local or proprietary identifier."; } leaf ref-ietf-hw { type string; description "Identifier corresponding to a component known through the ietf-hardware model."; } // Augment additional external references as needed here // Augmentations would need to target each location where this // grouping is used. } } grouping relationship-set { description "Relationships from a local component to peer nodes and zero or more peer components."; list relationship { key "type peer-node"; description "Relationships for a local energy component."; leaf type { type identityref { base peb:energy-relationship-type; } description "The type of relationship the local component has with the peer node or component(s)."; } leaf peer-node { type leafref { path "../../../../../nw:node/nw:node-id"; } description "The peer energy node participating in this relationship."; } list peer-component { key "peer-component"; description "One or more peer components within the peer node. If this list is empty, the relationship applies to the peer node as a whole."; leaf peer-component { type leafref { path "../../../../../../nw:node[nw:node-id=current()/../../peer-node]" + "/pen:energy-node-attributes/pen:component" + "/pen:component-id"; } description "A peer component within the referenced peer node."; } leaf details { type string; description "Additional implementation-specific details about the relationship to this peer component."; } } } } augment "/nw:networks/nw:network/nw:network-types" { description "Introduces a network type for representing energy flows between network devices and components."; container energy-network { presence "Indicates an energy-flow network."; description "This network type represents energy relationships, power sourcing, and energy-consuming structures that may exist alongside other network views such as physical or logical topology."; } } augment "/nw:networks/nw:network/nw:node" { when '../nw:network-types/pen:energy-network'; description "Adds energy modeling attributes to nodes in an energy network."; container energy-node-attributes { presence "Indicates that the node participates in the energy network view."; description "Energy-related attributes for a node in the energy network. The node may represent a router, phone, access point, or another energy-relevant device."; uses references; uses peb:power-and-energy-attributes; list component { key "component-id"; description "Energy-relevant components scoped locally to this node. Component identifiers are unique only within the parent node, avoiding network-wide naming collisions."; leaf component-id { type string; description "Identifier of the component within the parent energy node."; } uses references; uses peb:power-and-energy-attributes; uses relationship-set; } } } augment "/nwi:network-inventory/nwi:network-elements/nwi:network-element/nwi:components/nwi:component" { description "Adds power and energy attributes to network inventory components."; uses peb:power-and-energy-attributes; } } ]]>