Class equipment:Item (ABSTRACT)

Class ID:692
Encrypted: false - Exportable: false - Persistent: true
Privileges: []
SNMP OID:

NO COMMENTS


Naming Rules


DN FORMAT: 

                




Inheritance
equipment:Item
 ├
equipment:InventoryStatus Hardware component inventory status.
 ├
equipment:SecureController Secure controller is a abstract MO that would specify the status of a security controller. Secure controller might represent different security chips such as TPM, TXT etc
 
 ├
equipment:Tpm Trusted Platform Module would be a type of security controller. It is a chip on the MotherBoard and is used to store encryption keys and signifies the integrity of hardware.
 ├
equipment:Stateful
 
 ├
equipment:Holder
 
 
 ├
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:Fex
 
 
 ├
equipment:SlotEnclosure
 
 ├
equipment:StatefulChComp
 
 
 ├
compute:SlotEntity A physical slot entity.
 
 
 
 ├
compute:Cartridge A physical compute cartridge.
 
 
 ├
equipment:Card
 
 
 
 ├
equipment:IOCardBase
 
 
 
 
 ├
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:SwitchIOCard Represents an inventoried FI-IOM Card on a UCS-Mini Chassis This object is created implicitly when an FI-IOM Card is detected during hardware discovery. TODO: This is model similar to IOCard currently however this does not behave like a IOCard (IOM) and some of the properties will be removed if not needed.
 
 
 
 ├
equipment:SharedIOModule Represents an inventoried Shared IO Module on a device
 
 
 
 ├
equipment:SwitchCard Represents a physical switch card, such as a fixed module on a Fabric Interconnect or an extension module. This object is automatically created through hardware discovery.
 
 
 
 ├
equipment:SystemIOController Represents a SIOC on a Colusa 2 chassis
 
 
 ├
equipment:Fan Represents a fan in a Fan module.
 
 
 ├
equipment:FanModule Represents an inventoried Fan module. This object is created implicitly when a Fan module is detected during equipment discovery.
 
 
 ├
equipment:Psu Represents an inventoried Power Supply Unit. This object is created implicitly when a Power Supply Unit is detected during equipment discovery.
 
 
 ├
equipment:StatefulBladeComp
 
 
 
 ├
adaptor:HostPort An managed object representing a PCI link . In case of cruz based adapters there can be multiple hostports. This MO will be created during adapter inventory based on the catalog entry
 
 
 
 ├
adaptor:UnitExtn An managed object representing a network adaptor unit extension. This card is typically works in conjunction with a adaptor:Unit card, adds functioanlity such as increased capacity to the adaptor:Unit
 
 
 
 ├
compute:ABoard Abstract Motherboard added for supporting aggregate boards.
 
 
 
 
 ├
compute:Board Motherboard contained by physical compute item.
 
 
 
 
 ├
compute:ExtBoard Added for aggregate boards. Extended Motherboard contained by physical compute item.
 
 
 
 ├
compute:BoardController Managed object representing a blade PLD such as CPLD, EPLD, and FPGAs for sanfrancisco blade.
 
 
 
 ├
compute:IOHub IOHub to capture sensor info
 
 
 
 ├
compute:RtcBattery RTC battery to capture battery faults
 
 
 
 ├
equipment:IOExpander
 
 
 
 ├
memory:Array
 
 
 
 ├
memory:BufferUnit
 
 
 
 ├
memory:Unit
 
 
 
 ├
pci:Card
 
 
 
 
 ├
adaptor:Unit An managed object representing a network adaptor unit such as a card that has Nic and/or Hba, Scsi functionality.
 
 
 
 
 ├
graphics:Card
 
 
 
 
 ├
graphics:Controller
 
 
 
 
 ├
pci:Unit
 
 
 
 
 ├
security:Unit
 
 
 
 
 ├
storage:ControllerBase Abstract Base Class for Storage Controllers
 
 
 
 
 
 ├
storage:Controller
 
 
 
 
 
 ├
storage:FlexFlashController FlexFlash Controller Inventory
 
 
 
 
 
 ├
storage:MiniStorage
 
 
 
 ├
processor:Unit
 
 
 
 ├
storage:NvmeSwitch Represents HHHL, SSF/LFF and MSwitch
 
 
 
 ├
storage:SasExpander Represents a SAS Expander that exposes the physical disks to the SCSI controller
 
 
 ├
storage:Enclosure
 ├
equipment:Xcvr

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: equipment:Item
equipment:Id
          scalar:Uint32
id  (equipment:Item:id)
           NO COMMENTS
equipment:Model
          string:Basic
model  (equipment:Item:model)
           NO COMMENTS
equipment:Revision
          string:Basic
revision  (equipment:Item:revision)
           NO COMMENTS
equipment:Serial
          string:Basic
serial  (equipment:Item:serial)
           NO COMMENTS
equipment:Vendor
          string:Basic
vendor  (equipment:Item:vendor)
           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

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" />

id

Type: equipment:Id
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

model

Type: equipment:Model
Primitive Type: string:Basic
Like: equipment:Info:model
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
Comments:
NO COMMENTS

revision

Type: equipment:Revision
Primitive Type: string:Basic
Like: equipment:Info:revision
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
Comments:
NO COMMENTS
Constants
defaultValue "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

serial

Type: equipment:Serial
Primitive Type: string:Basic
Like: equipment:Info:serial
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
Comments:
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.


vendor

Type: equipment:Vendor
Primitive Type: string:Basic
Like: equipment:Info:vendor
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
Comments:
NO COMMENTS