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

Class equipment:HwCapDerivativeProvider (CONCRETE)

Class ID:2314
Encrypted: false - Exportable: true - Persistent: false
Privileges: []
SNMP OID: .1.3.6.1.4.1.9.9.719.1.38.78

DEFINITIONS Specifies a derivative product based on a common platform. For example, the HX series is based on the C220 and C240 series platform

Naming Rules 
RN FORMAT: derivative-[vendor]-model-[model]-revision-[revision]

    [1] PREFIX=derivative- PROPERTY = vendor


    [2] PREFIX=-model- PROPERTY = model


    [3] PREFIX=-revision- PROPERTY = revision




DN FORMAT: 

[0] capabilities/derivative-[vendor]-model-[model]-revision-[revision]


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.
 ├
 		capability:Catalogue
 
 		 ├
 		equipment:HwCapDerivativeProvider


Contained Hierarchy
equipment:HwCapDerivativeProvider
 ├
 		equipment:CapModSpec Used in capability catalog to specify a cloned entry should be deleted. Use in conjunction with HwCapDerivativeProvider.
 ├
 		equipment:HwCapProvider
 
 		 ├
 		equipment:Picture
 
 		 ├
 		firmware:Type identifies image type in the capability/type catalogue. Specifies that corresponding image types are applicable to a given FRU. This object also limits which versions apply to a FRU.
 
 		 
 		 ├
 		firmware:Dependency
 
 		 ├
 		firmware:UpgradeConstraint Mo to define a firmware constraint for an upgrade operation
Inheritance
capability:Provider
 ├
 		equipment:HwCapDerivativeProvider
Events


Faults


Fsms


Properties Summary
Defined in: equipment:HwCapDerivativeProvider
capability:Model
          string:Basic 		model  (equipment:HwCapDerivativeProvider:model)
           Overrides:capability:Provider:model
           NO COMMENTS
equipment:Revision
          string:Basic 		revision  (equipment:HwCapDerivativeProvider:revision)
           The vendor, model, revision specify the parent (base) product from which a secondary product is derived from.
The vendor, model and revision properties of this object specify the base product from which the secondary product is derived
capability:Vendor
          string:Basic 		vendor  (equipment:HwCapDerivativeProvider:vendor)
           Overrides:capability:Provider:vendor
           NO COMMENTS
Defined in: capability:Provider
capability:IsDeleted
          scalar:Bool 		deleted  (capability:Provider:deleted)
           NO COMMENTS
capability:IsDeprecated
          scalar:Bool 		deprecated  (capability:Provider:deprecated)
           NO COMMENTS
scalar:Uint32 elementLoadFailures  (capability:Provider:elementLoadFailures)
           NO COMMENTS
scalar:Uint32 elementsLoaded  (capability:Provider:elementsLoaded)
           NO COMMENTS
capability:Gencount
          scalar:Uint32 		gencount  (capability:Provider:gencount)
           NO COMMENTS
scalar:Uint32 loadErrors  (capability:Provider:loadErrors)
           NO COMMENTS
scalar:Uint32 loadWarnings  (capability:Provider:loadWarnings)
           NO COMMENTS
capability:MgmtPlaneVer
          string:Basic 		mgmtPlaneVer  (capability:Provider:mgmtPlaneVer)
           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

deleted

Type: capability:IsDeleted
Primitive Type: scalar:Bool
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
yes true NO COMMENTS
no false NO COMMENTS

deprecated

Type: capability:IsDeprecated
Primitive Type: scalar:Bool
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
yes true NO COMMENTS
no false 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" />

elementLoadFailures

Type: scalar:Uint32
Like: capability:ProviderLoadStats:elementLoadFailures
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

elementsLoaded

Type: scalar:Uint32
Like: capability:ProviderLoadStats:elementsLoaded
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

gencount

Type: capability:Gencount
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
defaultValue 0u NO COMMENTS

loadErrors

Type: scalar:Uint32
Like: capability:LoadStats:loadErrors
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

loadWarnings

Type: scalar:Uint32
Like: capability:LoadStats:loadWarnings
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

mgmtPlaneVer

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

Comments:
NO COMMENTS
Constants
defaultValue "" NO COMMENTS

model

Type: capability:Model
Primitive Type: string:Basic
Overrides:capability:Provider:model
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "510"

Comments:
NO COMMENTS

revision

Type: equipment:Revision
Primitive Type: string:Basic
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "510"

Comments:
The vendor, model, revision specify the parent (base) product from which a secondary product is derived from.
The vendor, model and revision properties of this object specify the base product from which the secondary product is derived
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

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: capability:Vendor
Primitive Type: string:Basic
Overrides:capability:Provider:vendor
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "510"

Comments:
NO COMMENTS
Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming