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

Class equipment:Tpm (CONCRETE)

Class ID:1864
Encrypted: false - Exportable: false - Persistent: true
Privileges: [admin, ls-compute, ls-config, ls-server, ls-storage]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.38.186

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.

Naming Rules 
RN FORMAT: Tpm-[id]

    [1] PREFIX=Tpm- PROPERTY = id




DN FORMAT: 

[0] sys/chassis-[id]/blade-[slotId]/board/Tpm-[id]

[1] sys/rack-unit-[id]/board/Tpm-[id]

[2] sys/chassis-[id]/cartridge-[slotId]/server-[serverInstanceId]/board/Tpm-[id]


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:Board Motherboard contained by physical compute item.
 
 		 
 		 
 		 ├
 		equipment:Tpm
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:Board Motherboard contained by physical compute item.
 
 		 
 		 
 		 
 		 ├
 		equipment:Tpm
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:Board Motherboard contained by physical compute item.
 
 		 
 		 
 		 
 		 
 		 ├
 		equipment:Tpm


Contained Hierarchy
equipment:Tpm
 ├
 		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
equipment:Item
 ├
 		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
Events


Faults 
                equipment:Tpm:SlaveTpm

                equipment:Tpm:TpmMismatch


Fsms


Properties Summary
Defined in: equipment:Tpm
equipment:ActiveStatus
          scalar:Enum8 		activeStatus  (equipment:Tpm:activeStatus)
           NO COMMENTS
equipment:AdminActionType
          scalar:Enum8 		adminAction  (equipment:Tpm:adminAction)
           Admin operation
equipment:ConfigState
          scalar:Enum8 		configState  (equipment:Tpm:configState)
           Admin config state
equipment:EnabledStatus
          scalar:Enum8 		enabledStatus  (equipment:Tpm:enabledStatus)
           NO COMMENTS
equipment:Id
          scalar:Uint32 		id  (equipment:Tpm:id)
           Overrides:equipment:Item:id
           NO COMMENTS
equipment:Ownership
          scalar:Enum8 		ownership  (equipment:Tpm:ownership)
           NO COMMENTS
equipment:PasswordState
          scalar:Enum8 		passwordState  (equipment:Tpm:passwordState)
           NO COMMENTS
equipment:Presence
          scalar:Enum8 		presence  (equipment:Tpm:presence)
           NO COMMENTS
string:Basic tpmRevision  (equipment:Tpm:tpmRevision)
           NO COMMENTS
equipment:TpmType
          scalar:Enum8 		type  (equipment:Tpm:type)
           NO COMMENTS
Defined in: equipment:Item
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

activeStatus

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

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
activated 1 NO COMMENTS
deactivated 2 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

adminAction

Type: equipment:AdminActionType
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
Admin operation
Constants
unspecified 0 NO COMMENTS
clear-config 1 NO COMMENTS
DEFAULT unspecified(0) NO COMMENTS

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

configState

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

Comments:
Admin config state
Constants
not-applied 0 NO COMMENTS
applying 1 NO COMMENTS
applied 2 NO COMMENTS
apply-failed 3 NO COMMENTS
DEFAULT not-applied(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" />

enabledStatus

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

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
enabled 1 NO COMMENTS
disabled 2 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

id

Type: equipment:Id
Primitive Type: scalar:Uint32
Overrides:equipment:Item:id
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
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

ownership

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

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
owned 1 NO COMMENTS
unowned 2 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

passwordState

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

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
set 1 NO COMMENTS
not-set 2 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

presence

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

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
empty 1 NO COMMENTS
equipped 10 NO COMMENTS
missing 11 NO COMMENTS
mismatch 12 NO COMMENTS
equipped-not-primary 13 NO COMMENTS
equipped-slave 14 NO COMMENTS
mismatch-slave 15 NO COMMENTS
missing-slave 16 NO COMMENTS
equipped-identity-unestablishable 20 NO COMMENTS
mismatch-identity-unestablishable 21 NO COMMENTS
equipped-with-malformed-fru 22 NO COMMENTS
inaccessible 30 NO COMMENTS
unauthorized 40 NO COMMENTS
not-supported 100 NO COMMENTS
equipped-unsupported 101 NO COMMENTS
equipped-deprecated 102 NO COMMENTS
equipped-disc-not-started 102 NO COMMENTS
equipped-disc-in-progress 103 NO COMMENTS
equipped-disc-error 104 NO COMMENTS
equipped-disc-unknown 105 NO COMMENTS
DEFAULT unknown(0) 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.

tpmRevision

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

Comments:
NO COMMENTS

type

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

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
physical 1 NO COMMENTS
virtual 2 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

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
Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming