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

Interface State

All Superinterfaces:

Augmentable<State>, BindingObject, ChildOf<Component>, DataContainer, DataObject

public interface State
extends ChildOf<Component>, Augmentable<State>

State-related nodes

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

 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;
   }
 }
 

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

To create instances of this class use StateBuilder.

See Also:

StateBuilder

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 AdminState	getAdminState() The administrative state for this component.This node refers to a component's administrativepermission to service both other components within itscontainment hierarchy as well other users of itsservices defined by means outside the scope of thismodule.Some components exhibit only a subset of the remainingadministrative state values.
@Nullable AlarmState	getAlarmState() The alarm state for this component.
@Nullable OperState	getOperState() The operational state for this component.Note that this node does not follow the administrativestate.
@Nullable StandbyState	getStandbyState() The standby state for this component.Some components will exhibit only a subset of theremaining standby state values.
@Nullable DateAndTime	getStateLastChanged() The date and time when the value of any of theadmin-state, oper-state, usage-state, alarm-state, orstandby-state changed for this component.If there has been no change since the lastre-initialization of the local system, this nodecontains the date and time of local systeminitialization.
@Nullable UsageState	getUsageState() The usage state for this component.This node refers to a component's ability to servicemore components in a containment hierarchy.Some components will exhibit only a subset of the usagestate values.

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

getStateLastChanged

@Nullable DateAndTime getStateLastChanged()

The date and time when the value of any of theadmin-state, oper-state, usage-state, alarm-state, orstandby-state changed for this component.If there has been no change since the lastre-initialization of the local system, this nodecontains the date and time of local systeminitialization. If there has been no change since thecomponent was added to the local system, this nodecontains the date and time of the insertion.

Returns:

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

getAdminState

@Nullable AdminState getAdminState()

The administrative state for this component.This node refers to a component's administrativepermission to service both other components within itscontainment hierarchy as well other users of itsservices defined by means outside the scope of thismodule.Some components exhibit only a subset of the remainingadministrative state values. Some components cannot belocked; hence, this node exhibits only the 'unlocked'state. Other components cannot be shut down gracefully;hence, this node does not exhibit the 'shutting-down'state.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313.AdminState adminState, or null if not present

getOperState

@Nullable OperState getOperState()

The operational state for this component.Note that this node does not follow the administrativestate. An administrative state of 'down' does notpredict an operational state of 'disabled'.Note that some implementations may not be able toaccurately report oper-state while the admin-state nodehas a value other than 'unlocked'. In these cases, thisnode MUST have a value of 'unknown'.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313.OperState operState, or null if not present

getUsageState

@Nullable UsageState getUsageState()

The usage state for this component.This node refers to a component's ability to servicemore components in a containment hierarchy.Some components will exhibit only a subset of the usagestate values. Components that are unable to everservice any components within a containment hierarchywill always have a usage state of 'busy'. In somecases, a component will be able to support only oneother component within its containment hierarchy andwill therefore only exhibit values of 'idle' and'busy'.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313.UsageState usageState, or null if not present

getAlarmState

@Nullable AlarmState getAlarmState()

The alarm state for this component. It does notinclude the alarms raised on child components within itscontainment hierarchy.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313.AlarmState alarmState, or null if not present

getStandbyState

@Nullable StandbyState getStandbyState()

The standby state for this component.Some components will exhibit only a subset of theremaining standby state values. If this componentcannot operate in a standby role, the value of this nodewill always be 'providing-service'.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313.StandbyState standbyState, or null if not present