Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming 

Class equipment:HealthLed (CONCRETE)

Class ID:1714
Encrypted: false - Exportable: false - Persistent: true
Privileges: [admin, pn-equipment, pn-maintenance, pn-policy]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.38.75

NO COMMENTS

Naming Rules 
RN FORMAT: health-led

    [1] PREFIX=health-led


DN FORMAT: 

[0] sys/chassis-[id]/blade-[slotId]/health-led

[1] sys/chassis-[id]/blade-[slotId]/ext-board-[id]/health-led

[2] sys/rack-unit-[id]/ext-board-[id]/health-led

[3] sys/chassis-[id]/cartridge-[slotId]/server-[serverInstanceId]/ext-board-[id]/health-led

[4] sys/chassis-[id]/blade-[slotId]/health-led

[5] sys/rack-unit-[id]/health-led

[6] sys/chassis-[id]/cartridge-[slotId]/server-[serverInstanceId]/health-led

[7] sys/rack-unit-[id]/health-led

[8] sys/chassis-[id]/health-led

[9] sys/rack-unit-[id]/fan-module-[tray]-[id]/health-led

[10] sys/chassis-[id]/fan-module-[tray]-[id]/health-led

[11] sys/switch-[id]/fan-module-[tray]-[id]/health-led

[12] sys/fex-[id]/health-led

[13] sys/chassis-[id]/slot-[id]/health-led

[14] sys/fex-[id]/slot-[id]/health-led

[15] sys/rack-unit-[id]/psu-[id]/health-led

[16] sys/chassis-[id]/psu-[id]/health-led

[17] sys/fex-[id]/psu-[id]/health-led

[18] sys/switch-[id]/psu-[id]/health-led


Containers Hierarchies
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		compute:RackUnit A physical compute RackUnit. Physical compute item representing a Rack mountable unit.
 
 		 
 		 ├
 		compute:ExtBoard Added for aggregate boards. Extended Motherboard contained by physical compute item.
 
 		 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		compute:RackUnit A physical compute RackUnit. Physical compute item representing a Rack mountable unit.
 
 		 
 		 ├
 		equipment:FanModule Represents an inventoried Fan module. This object is created implicitly when a Fan module is detected during equipment discovery.
 
 		 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		compute:RackUnit A physical compute RackUnit. Physical compute item representing a Rack mountable unit.
 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		compute:RackUnit A physical compute RackUnit. Physical compute item representing a Rack mountable unit.
 
 		 
 		 ├
 		equipment:Psu Represents an inventoried Power Supply Unit. This object is created implicitly when a Power Supply Unit is detected during equipment discovery.
 
 		 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		equipment:Chassis A physical unit that can accomodate multiple blade servers. For example, the Cisco UCS 5108 Blade Server Chassis is six rack units (6RU) high, can mount in an industry-standard 19-inch rack and uses front-to-back cooling.
 
 		 
 		 ├
 		compute:Blade A physical compute blade. Physical compute item in blade form factor.
 
 		 
 		 
 		 ├
 		compute:ExtBoard Added for aggregate boards. Extended Motherboard contained by physical compute item.
 
 		 
 		 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		equipment:Chassis A physical unit that can accomodate multiple blade servers. For example, the Cisco UCS 5108 Blade Server Chassis is six rack units (6RU) high, can mount in an industry-standard 19-inch rack and uses front-to-back cooling.
 
 		 
 		 ├
 		compute:Blade A physical compute blade. Physical compute item in blade form factor.
 
 		 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		equipment:Chassis A physical unit that can accomodate multiple blade servers. For example, the Cisco UCS 5108 Blade Server Chassis is six rack units (6RU) high, can mount in an industry-standard 19-inch rack and uses front-to-back cooling.
 
 		 
 		 ├
 		compute:Cartridge A physical compute cartridge.
 
 		 
 		 
 		 ├
 		compute:ServerUnit A server instance on a cartridge.
 
 		 
 		 
 		 
 		 ├
 		compute:ExtBoard Added for aggregate boards. Extended Motherboard contained by physical compute item.
 
 		 
 		 
 		 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		equipment:Chassis A physical unit that can accomodate multiple blade servers. For example, the Cisco UCS 5108 Blade Server Chassis is six rack units (6RU) high, can mount in an industry-standard 19-inch rack and uses front-to-back cooling.
 
 		 
 		 ├
 		compute:Cartridge A physical compute cartridge.
 
 		 
 		 
 		 ├
 		compute:ServerUnit A server instance on a cartridge.
 
 		 
 		 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		equipment:Chassis A physical unit that can accomodate multiple blade servers. For example, the Cisco UCS 5108 Blade Server Chassis is six rack units (6RU) high, can mount in an industry-standard 19-inch rack and uses front-to-back cooling.
 
 		 
 		 ├
 		equipment:FanModule Represents an inventoried Fan module. This object is created implicitly when a Fan module is detected during equipment discovery.
 
 		 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		equipment:Chassis A physical unit that can accomodate multiple blade servers. For example, the Cisco UCS 5108 Blade Server Chassis is six rack units (6RU) high, can mount in an industry-standard 19-inch rack and uses front-to-back cooling.
 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		equipment:Chassis A physical unit that can accomodate multiple blade servers. For example, the Cisco UCS 5108 Blade Server Chassis is six rack units (6RU) high, can mount in an industry-standard 19-inch rack and uses front-to-back cooling.
 
 		 
 		 ├
 		equipment:IOCard Represents an inventoried IO Card on a device, such as an IO module on a UCS chassis or FEX. This object is created implicitly when an IO Card is detected during hardware discovery.
 
 		 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		equipment:Chassis A physical unit that can accomodate multiple blade servers. For example, the Cisco UCS 5108 Blade Server Chassis is six rack units (6RU) high, can mount in an industry-standard 19-inch rack and uses front-to-back cooling.
 
 		 
 		 ├
 		equipment:Psu Represents an inventoried Power Supply Unit. This object is created implicitly when a Power Supply Unit is detected during equipment discovery.
 
 		 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		equipment:Fex
 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		equipment:Fex
 
 		 
 		 ├
 		equipment:IOCard Represents an inventoried IO Card on a device, such as an IO module on a UCS chassis or FEX. This object is created implicitly when an IO Card is detected during hardware discovery.
 
 		 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		equipment:Fex
 
 		 
 		 ├
 		equipment:Psu Represents an inventoried Power Supply Unit. This object is created implicitly when a Power Supply Unit is detected during equipment discovery.
 
 		 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		network:Element Represents a physical network element, such as a Fabric Interconnect.
 
 		 
 		 ├
 		equipment:FanModule Represents an inventoried Fan module. This object is created implicitly when a Fan module is detected during equipment discovery.
 
 		 
 		 
 		 ├
 		equipment:HealthLed
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		top:System Provides general information about this system, such as the name, IP address and current time.
 
 		 ├
 		network:Element Represents a physical network element, such as a Fabric Interconnect.
 
 		 
 		 ├
 		equipment:Psu Represents an inventoried Power Supply Unit. This object is created implicitly when a Power Supply Unit is detected during equipment discovery.
 
 		 
 		 
 		 ├
 		equipment:HealthLed


Contained Hierarchy
equipment:HealthLed
 ├
 		compute:HealthLedSensorAlarm
 ├
 		fault:Inst An abnormal condition or defect at the component, equipment, or sub-system level which may lead to a failure, as defined in ISO/CD 10303-226.
Inheritance
naming:NamedObject
 ├
 		equipment:Led
 
 		 ├
 		equipment:HealthLed
Events


Faults 
                equipment:HealthLed:CriticalError

                equipment:HealthLed:MinorError


Fsms


Properties Summary
Defined in: equipment:HealthLed
equipment:HealthLedState
          scalar:Enum8 		healthLedState  (equipment:HealthLed:healthLedState)
           NO COMMENTS
string:Basic healthLedStateQualifier  (equipment:HealthLed:healthLedStateQualifier)
           NO COMMENTS
Defined in: equipment:Led
equipment:LedColor
          scalar:Enum8 		color  (equipment:Led:color)
           NO COMMENTS
equipment:Id
          scalar:Uint32 		id  (equipment:Led:id)
           NO COMMENTS
equipment:LedOperState
          scalar:Enum8 		operState  (equipment:Led:operState)
           NO COMMENTS
Defined in: naming:NamedObject
naming:Name
          string:Basic 		name  (naming:NamedObject:name)
           NO COMMENTS
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32 		childAction  (mo:TopProps:childAction)
          
reference:Object dn  (mo:TopProps:dn)
           The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />
reference:RN rn  (mo:TopProps:rn)
           The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />
mo:InstSaclType
          scalar:Bitmask8 		sacl  (mo:TopProps:sacl)
           The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
mo:ModificationStatus
          scalar:Bitmask32 		status  (mo:TopProps:status)
           This property controls the life cycle of a managed object
Properties Detail

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
Property Validators:

Comments:
Constants
deleteAll 16384u NO COMMENTS
ignore 4096u NO COMMENTS
deleteNonPresent 8192u NO COMMENTS
DEFAULT 0 This type is used to

color

Type: equipment:LedColor
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
green 1 NO COMMENTS
amber 2 NO COMMENTS
red 3 NO COMMENTS
blue 4 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

dn

Type: reference:Object
Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
Property Validators:

Comments:
The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />

healthLedState

Type: equipment:HealthLedState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
normal 0 green is normal
minor 1 amber is minor
critical 2 amber blinking is critical
DEFAULT normal(0) green is normal

healthLedStateQualifier

Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

Comments:
NO COMMENTS

id

Type: equipment:Id
Primitive Type: scalar:Uint32
Like: equipment:ItemIf:id
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

name

Type: naming:Name
Primitive Type: string:Basic
Like: naming:Named:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

Comments:
NO COMMENTS

operState

Type: equipment:LedOperState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
on 1 NO COMMENTS
off 2 NO COMMENTS
blinking 3 NO COMMENTS
eth 4 NO COMMENTS
fc 5 NO COMMENTS
unsupported 6 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

rn

Type: reference:RN
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
Property Validators:

Comments:
The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />

sacl

Type: mo:InstSaclType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelSacl
Property Validators:

Comments:
The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
Constants
none 0 NO COMMENTS
del 1 NO COMMENTS
mod 2 NO COMMENTS
addchild 4 NO COMMENTS
cascade 8 NO COMMENTS
DEFAULT 0 NO COMMENTS

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
Property Validators:

Comments:
This property controls the life cycle of a managed object
Constants
removed 16u In a setter method: specifies that an object should be removed.
In the return value of a setter method: indicates that an object has been removed.
created 2u 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 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 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.

Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming