Class eqpt:Led (ABSTRACT)

Class ID:3353
Class Label: LED
Encrypted: false - Exportable: false - Persistent: false - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-equipment, admin, fabric-equipment]
Creatable/Deletable: no (see Container Mos for details)
Possible Semantic Scopes: Infra, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The abstraction of an LED. This is a superclass for LED types, such as an indicator LED.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: eqpt:Comp,
Sub Mos: eqpt:ALocLed, eqpt:IndLed,


Inheritance
[V] nw:Item Ignore.
 ├
[V] eqpt:Item The abstraction for any equipment component/container in the system.
 
 ├
[V] eqpt:Comp An equipment component such as a card, port, transceiver, or ASIC.
 
 
 ├
[V] eqpt:Led The abstraction of an LED. This is a superclass for LED types, such as an indicator LED.
 
 
 
 ├
[V] eqpt:ALocLed The abstract class for a locator LED.
 
 
 
 
 ├
[V] eqpt:ExtChLocLed A locator LED on extended chassis components.
 
 
 
 
 ├
[V] eqpt:LocLed A locator LED on chassis components.
 
 
 
 ├
[V] eqpt:IndLed The locator LED for monitoring the component state.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: eqpt:Led
eqpt:Color
          scalar:Enum16
color  (eqpt:Led:color)
           Color status of an LED
eqpt:LedOpSt
          scalar:Enum32
operSt  (eqpt:Led:operSt)
           Operational status of an LED
eqpt:LedType
          scalar:Enum8
type  (eqpt:Led:type)
          
Defined in: eqpt:Comp
naming:Descr
          string:Basic
descr  (eqpt:Comp:descr)
           Additional descriptive information about the object.
scalar:Date mfgTm  (eqpt:Comp:mfgTm)
           The manufacturing time.
eqpt:Model
          string:Basic
model  (eqpt:Comp:model)
           The model of the component.
eqpt:Revision
          string:Basic
rev  (eqpt:Comp:rev)
           The revision number.
eqpt:Serial
          string:Basic
ser  (eqpt:Comp:ser)
           The serial number.
eqpt:Vendor
          string:Basic
vendor  (eqpt:Comp:vendor)
           The vendor.
Defined in: eqpt:Item
eqpt:Id
          scalar:Uint32
id  (eqpt:Item:id)
           The item identifier.
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Properties Detail

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent NO COMMENTS
DEFAULT 0 --- This type is used to





color

Type: eqpt:Color
Primitive Type: scalar:Enum16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Color status of an LED
Constants
no-color 0 No color NO COMMENTS
unknown 0 Unknown No-color
green 1 Green Green
yellow 2 Yellow Yellow
amber 3 Amber Amber
red 4 Red Red
blue 5 Blue Blue
DEFAULT unknown(0) Unknown No-color





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Additional descriptive information about the object.



dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.



id

Type: eqpt:Id
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The item identifier.



mfgTm

Type: scalar:Date

Like: eqpt:Mfg:mfgTm
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The manufacturing time.
Constants
not-applicable 0ull N/A NO COMMENTS
DEFAULT not-applicable(0ull) N/A NO COMMENTS





model

Type: eqpt:Model
Primitive Type: string:Basic

Like: eqpt:Dev:model
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The model of the component.



operSt

Type: eqpt:LedOpSt
Primitive Type: scalar:Enum32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operational status of an LED
Constants
unknown 0u Unknown Unknown state
off 1u Off Off state
on 2u On On state
blinking 3u Blinking Blinking state
fail 4u Fail Failed state
DEFAULT unknown(0u) Unknown Unknown state





rev

Type: eqpt:Revision
Primitive Type: string:Basic

Like: eqpt:Dev:rev
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The revision number.
Constants
defaultValue "0" --- NO COMMENTS





rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
    Comments:
Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.



ser

Type: eqpt:Serial
Primitive Type: string:Basic

Like: eqpt:Dev:ser
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The serial number.



status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
    Comments:
The upgrade status. This property is for internal use only.
Constants
created 2u created In a setter method: specifies that an object should be created. An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
modified 4u modified In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
deleted 8u deleted In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
DEFAULT 0 --- This type controls the life cycle of objects passed in the XML API.

When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed.

When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.






type

Type: eqpt:LedType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
unknown 0 Unknown unknown
status 1 status status
system 2 system system
active 3 active active
power 4 power power
battery 5 battery battery
lc-status 6 LC status LC status
sup-status 7 SUP status SUP status
fc-status 8 Fabric status FC status
fan-status 9 Fan status Fan status
pwr-status 10 power status pwr status
DEFAULT unknown(0) Unknown unknown





vendor

Type: eqpt:Vendor
Primitive Type: string:Basic

Like: eqpt:Dev:vendor
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The vendor.
Constants
defaultValue "Cisco Systems, Inc" --- NO COMMENTS