Class ethpm:Inst (CONCRETE)

Class ID:3635
Class Label: Ethernet Port Manager Instance
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin]
Creatable/Deletable: no (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 global configuration for a running EthPM instance. (one instance per system)

Naming Rules
RN FORMAT: inst

    [1] PREFIX=inst


DN FORMAT: 

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

[1] sys/ethpm/inst

                


Diagram

Super Mo: nw:CpInst,
Container Mos: ethpm:Entity (deletable:no),
Contained Mos: ethpm:ErrDisRecover, ethpm:InstRuntime, ethpm:Module, ethpm:Vlan,


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] 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)


Contained Hierarchy
[V] ethpm:Inst Stores global configuration for a running EthPM instance. (one instance per system)
 ├
[V] ethpm:ErrDisRecover The global configuration for error-disable recovery.
 
 ├
[V] ethpm:Event 
 
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 ├
[V] tag:Annotation 
 
 
 ├
[V] tag:Tag 
 
 ├
[V] ethpm:RsErrDisRecoverPolCons A source relation to the error-disable recovery policy.
 ├
[V] ethpm:InstRuntime Internal object: Global runtime state of the ethpm process.
 ├
[V] ethpm:Module Stores the runtime state associated with a module inside ethpm.
 ├
[V] ethpm:Vlan Stores the runtime state of VLANs inside ethpm


Inheritance
[V] nw:Item Ignore.
 ├
[V] nw:Conn A connection abstraction.
 
 ├
[V] nw:GEp A group endpoint abstraction.
 
 
 ├
[V] nw:CpInst A control plane instance abstraction. This object represents an instance of the protocol. For example, the protocol instance of OSPF or ISIS.
 
 
 
 ├
[V] ethpm:Inst Stores global configuration for a running EthPM instance. (one instance per system)


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: ethpm:Inst
ethpm:SyslogLevel
          scalar:Uint32
adminLinkDownSyslogLevel  (ethpm:Inst:adminLinkDownSyslogLevel)
           Admin link-down syslog level
ethpm:SyslogLevel
          scalar:Uint32
adminLinkUpSyslogLevel  (ethpm:Inst:adminLinkUpSyslogLevel)
           Admin link-up syslog level
scalar:Bool allowUnsupportedSfp  (ethpm:Inst:allowUnsupportedSfp)
           Allow unsupported SFP
ethpm:SyslogInfo
          scalar:Enum8
ifSyslogInfo  (ethpm:Inst:ifSyslogInfo)
           Interface syslog info
ethpm:AccessCredits
          scalar:Uint32
pacerAccessCredits  (ethpm:Inst:pacerAccessCredits)
           Access pacer credits
ethpm:FabricPortCredits
          scalar:Uint32
pacerFabricPortCredits  (ethpm:Inst:pacerFabricPortCredits)
           fabric port pacer credits
ethpm:NotConnectedTimer
          scalar:Uint32
pacerNotConnTimer  (ethpm:Inst:pacerNotConnTimer)
           Pacer not connected timer value
ethpm:NotUpTimer
          scalar:Uint32
pacerNotUpTimer  (ethpm:Inst:pacerNotUpTimer)
           Pacer not up timer value
ethpm:PerSiCredits
          scalar:Uint32
pacerPerSiCredits  (ethpm:Inst:pacerPerSiCredits)
           Per sub-interface pacer credits
ethpm:PerVlanCredits
          scalar:Uint32
pacerPerVlanCredits  (ethpm:Inst:pacerPerVlanCredits)
           Per vlan pacer credits
ethpm:RouetdPortCredits
          scalar:Uint32
pacerRtdPortCredits  (ethpm:Inst:pacerRtdPortCredits)
           Routed port pacer credits
ethpm:TotalCredits
          scalar:Uint32
pacerTotalCredits  (ethpm:Inst:pacerTotalCredits)
           Total pacer credits
ethpm:TrunkCredits
          scalar:Uint32
pacerTrunkCredits  (ethpm:Inst:pacerTrunkCredits)
           Trunk pacer credits
l1:Mtu
          scalar:Uint32
systemJumboMtu  (ethpm:Inst:systemJumboMtu)
           System jumbo Mtu
scalar:Bool vlanTagNative  (ethpm:Inst:vlanTagNative)
           Tag native vlan
Defined in: nw:CpInst
nw:AdminSt
          scalar:Enum8
adminSt  (nw:CpInst:adminSt)
           The administrative state of the object or policy.
nw:InstCtrl
          scalar:Bitmask64
ctrl  (nw:CpInst:ctrl)
           The control state.
naming:Name
          string:Basic
name  (nw:CpInst:name)
           Overrides:nw:Conn:name
           The name of the object.
nw:OperErrQual
          scalar:Bitmask64
operErr  (nw:CpInst:operErr)
          
Defined in: mo:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
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

adminLinkDownSyslogLevel

Type: ethpm:SyslogLevel
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Admin link-down syslog level
Constants
defaultValue 5u --- NO COMMENTS





adminLinkUpSyslogLevel

Type: ethpm:SyslogLevel
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Admin link-up syslog level
Constants
defaultValue 5u --- NO COMMENTS





adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative state of the object or policy.
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled





allowUnsupportedSfp

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Allow unsupported SFP
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- NO COMMENTS





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





ctrl

Type: nw:InstCtrl
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
stateful-ha 1ull stateful-ha Enable stateful HA
DEFAULT 0 --- Instance controls





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.



ifSyslogInfo

Type: ethpm:SyslogInfo
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Interface syslog info
Constants
default 0 default NO COMMENTS
info-1 1 info-1 NO COMMENTS
DEFAULT default(0) default NO COMMENTS





lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





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





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name
Units: null Encrypted: false Access: create Category: TopLevelRegular
    Comments:
The name of the object.



operErr

Type: nw:OperErrQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
sock-err 16ull Socket error Socket errors
init-err 1ull Initialization error Initialization errors
mem-err 2ull Memory error Memory errors
proto-err 32ull Protocol error Protocol errors
ipc-err 4ull IPC error IPC errors
feature-unsupported 64ull Feature Unsupported Feature Unsupported
int-err 8ull Internal error Internal errors
DEFAULT 0 --- Operational error qualifier





pacerAccessCredits

Type: ethpm:AccessCredits
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Access pacer credits
Constants
defaultValue 1u --- NO COMMENTS





pacerFabricPortCredits

Type: ethpm:FabricPortCredits
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
fabric port pacer credits
Constants
defaultValue 0u --- NO COMMENTS





pacerNotConnTimer

Type: ethpm:NotConnectedTimer
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Pacer not connected timer value
Constants
defaultValue 30000u --- NO COMMENTS





pacerNotUpTimer

Type: ethpm:NotUpTimer
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Pacer not up timer value
Constants
defaultValue 60000u --- NO COMMENTS





pacerPerSiCredits

Type: ethpm:PerSiCredits
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Per sub-interface pacer credits
Constants
defaultValue 0u --- NO COMMENTS





pacerPerVlanCredits

Type: ethpm:PerVlanCredits
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Per vlan pacer credits
Constants
defaultValue 0u --- NO COMMENTS





pacerRtdPortCredits

Type: ethpm:RouetdPortCredits
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Routed port pacer credits
Constants
defaultValue 2u --- NO COMMENTS





pacerTotalCredits

Type: ethpm:TotalCredits
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Total pacer credits
Constants
defaultValue 32u --- NO COMMENTS





pacerTrunkCredits

Type: ethpm:TrunkCredits
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Trunk pacer credits
Constants
defaultValue 4u --- NO COMMENTS





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.



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.






systemJumboMtu

Type: l1:Mtu
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
System jumbo Mtu
Constants
defaultValue 9000u --- NO COMMENTS





vlanTagNative

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Tag native vlan
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS