Class ethpm:Module (CONCRETE)

Class ID:3639
Class Label: Module
Encrypted: false - Exportable: false - Persistent: false - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

Stores the runtime state associated with a module inside ethpm.

Naming Rules
RN FORMAT: module-{id}

    [1] PREFIX=module- PROPERTY = id




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/ethpm/inst/module-{id}

[1] sys/ethpm/inst/module-{id}

                


Diagram

Container Mos: ethpm:Inst (deletable:yes),


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] ethpm:Entity Entity
 
 
 
 
 
 ├
[V] ethpm:Inst Stores global configuration for a running EthPM instance. (one instance per system)
 
 
 
 
 
 
 ├
[V] ethpm:Module Stores the runtime state associated with a module inside ethpm.
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] ethpm:Entity Entity
 
 
 ├
[V] ethpm:Inst Stores global configuration for a running EthPM instance. (one instance per system)
 
 
 
 ├
[V] ethpm:Module Stores the runtime state associated with a module inside ethpm.


Contained Hierarchy
[V] ethpm:Module Stores the runtime state associated with a module inside ethpm.


Inheritance
[V] ethpm:Module Stores the runtime state associated with a module inside ethpm.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: ethpm:Module
ethpm:PortBitmap
          base:BitArray128
cfgdPorts  (ethpm:Module:cfgdPorts)
           cfgd ports
scalar:Uint32 flags  (ethpm:Module:flags)
           module flags
scalar:UByte id  (ethpm:Module:id)
           module id
scalar:Bool isOffline  (ethpm:Module:isOffline)
           module offline status
scalar:Uint32 lcNodeAddress  (ethpm:Module:lcNodeAddress)
           LC node address
l1:Module
          scalar:Enum8
moduleType  (ethpm:Module:moduleType)
           module type
scalar:Uint32 numPortTypes  (ethpm:Module:numPortTypes)
           number of port-types
scalar:Uint16 portCfgSap  (ethpm:Module:portCfgSap)
           port coonfig sap
scalar:UByte runtimeNumPorts  (ethpm:Module:runtimeNumPorts)
           runtime number of ports
ethpm:PortBitmap
          base:BitArray128
runtimePorts  (ethpm:Module:runtimePorts)
           runtime ports
scalar:Uint16 swCardId  (ethpm:Module:swCardId)
           software card Id
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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

cfgdPorts

Type: ethpm:PortBitmap
Primitive Type: base:BitArray128

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
cfgd ports



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





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.



flags

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
module flags



id

Type: scalar:UByte

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
module id



isOffline

Type: scalar:Bool

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
module offline status
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





lcNodeAddress

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
LC node address



modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS





moduleType

Type: l1:Module
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
module type
Constants
sup 0 sup NO COMMENTS
lc 1 lc NO COMMENTS
DEFAULT lc(1) lc NO COMMENTS





numPortTypes

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
number of port-types



portCfgSap

Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
port coonfig sap



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.



runtimeNumPorts

Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
runtime number of ports



runtimePorts

Type: ethpm:PortBitmap
Primitive Type: base:BitArray128

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
runtime ports



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.






swCardId

Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
software card Id