Class poe:If (CONCRETE)

Class ID:10530
Class Label: Interface
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: [access-protocol-l1, access-protocol-l2, admin, fabric-protocol-l1, fabric-protocol-l2, tenant-ext-protocol-l1, tenant-ext-protocol-l2, tenant-protocol-l2]
Creatable/Deletable: no (see Container Mos for details)
Possible Semantic Scopes: Infra, Fabric,
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Relation
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

This object holds Power over Ethernet information that is operated at a interface level

Naming Rules
RN FORMAT: if-{[id]}

    [1] PREFIX=if- PROPERTY = id




DN FORMAT: 

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

[1] sys/poe/inst/if-{[id]}

                


Diagram

Super Mo: l2:ProtIf,
Container Mos: poe:Inst (deletable:no),
Contained Mos: poe:Module, poe:VDAEp,
Relations From: nw:PathEp,
Relations To: l1:EthIf,
Relations: l2:RsEthIf, nw:RtPathToIf,


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] poe:Entity  Holds Power over Ethernet control plane entity information
 
 
 
 
 
 ├
[V] poe:Inst  This objects hold per Power over Ethernet instance information. There is only one instance of Power over Ethernet running in the system today
 
 
 
 
 
 
 ├
[V] poe:If  This object holds Power over Ethernet information that is operated at a interface level
[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] poe:Entity  Holds Power over Ethernet control plane entity information
 
 
 ├
[V] poe:Inst  This objects hold per Power over Ethernet instance information. There is only one instance of Power over Ethernet running in the system today
 
 
 
 ├
[V] poe:If  This object holds Power over Ethernet information that is operated at a interface level


Contained Hierarchy
[V] poe:If  This object holds Power over Ethernet information that is operated at a interface level
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] l2:RsEthIf A source relation to an L1 interface. This is an internal object.
 ├
[V] nw:RtPathToIf A target relation to the interface information.
 ├
[V] poe:Module 
 ├
[V] poe:VDAEp  Copy of Module Mo owned by PE for triggering epAttachOrDetach
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] nw:Item Ignore.
 ├
[V] nw:Conn A connection abstraction.
 
 ├
[V] nw:Ep A static endpoint.
 
 
 ├
[V] nw:ConnEp A connection endpoint abstraction.
 
 
 
 ├
[V] nw:If The interface information.
 
 
 
 
 ├
[V] nw:LogicalIf A logical interface abstraction.
 
 
 
 
 
 ├
[V] nw:ProtIf A protocol interface abstraction.
 
 
 
 
 
 
 ├
[V] l2:ProtIf A protocol interface abstraction.
 
 
 
 
 
 
 
 ├
[V] poe:If  This object holds Power over Ethernet information that is operated at a interface level


Events
                


Faults
                poe:If:poeConfigFailRecoverable
poe:If:poeConfigFailUnrecoverable


Fsms
                


Properties Summary
Defined in: poe:If
scalar:Uint32 absentCounter  (poe:If:absentCounter)
           Number of absent conditions detected.
poe:IfPwrCfgWattage
          scalar:Uint16
consumption  (poe:If:consumption)
           Consumption
poe:IfPwrWattage
          scalar:Sint32
cutoffPower  (poe:If:cutoffPower)
           Cutoff Power
poe:IfPwrWattage
          scalar:Sint32
deliveredPower  (poe:If:deliveredPower)
           Delivered Power
poe:DeviceClass
          string:Basic
devClass  (poe:If:devClass)
           Device Class
poe:DeviceName
          string:Basic
devName  (poe:If:devName)
           Device Name
nw:IfId
          base:IfIndex
id  (poe:If:id)
           Overrides:nw:If:id
          
scalar:Uint32 invalidSignatureCounter  (poe:If:invalidSignatureCounter)
           Number of invalid signature conditions detected.
poe:ModPwrWattage
          scalar:Uint16
max  (poe:If:max)
           The maximum power in milliwatts that is allowed on the interface.
poe:PowerMode
          scalar:Enum8
mode  (poe:If:mode)
           The PoE power mode of the interface.
reference:BinRef monPolDn  (poe:If:monPolDn)
           Monitoring policy attached to this observable object
poe:OperSt
          scalar:Enum8
operSt  (poe:If:operSt)
           Operational
scalar:Uint32 overloadCounter  (poe:If:overloadCounter)
           Number of overload conditions detected.
reference:BinRef poeEpg  (poe:If:poeEpg)
           PoE Epg
base:Encap poeVoiceVlan  (poe:If:poeVoiceVlan)
           PoE VLAN
poe:PoliceAct
          scalar:Enum8
policeAct  (poe:If:policeAct)
           Policing Action
poe:PoliceSt
          scalar:Enum8
policeSt  (poe:If:policeSt)
           Operation Police state
poe:IfPwrWattage
          scalar:Sint32
policingPower  (poe:If:policingPower)
           Policing Power
poe:IfPwrWattage
          scalar:Sint32
portConsumption  (poe:If:portConsumption)
           Port Consumption
scalar:Uint16 portPriority  (poe:If:portPriority)
           port priority
scalar:Uint32 powerDeniedCounter  (poe:If:powerDeniedCounter)
           Number of denied conditions detected.
scalar:Bool prioHigh  (poe:If:prioHigh)
           Port Priority High
scalar:Uint32 shortCounter  (poe:If:shortCounter)
           Number of short conditions detected.
poe:OperSt
          scalar:Enum8
status  (poe:If:status)
           status
poe:IfPwrWattage
          scalar:Sint32
suppliedPower  (poe:If:suppliedPower)
           Supplied Power
poe:IfPwrWattage
          scalar:Sint32
used  (poe:If:used)
           Usage
Defined in: nw:ProtIf
nw:IfAdminSt
          scalar:Enum8
adminSt  (nw:ProtIf:adminSt)
           The administrative state of the object or policy.
Defined in: nw:If
naming:Descr
          string:Basic
descr  (nw:If:descr)
          
Defined in: nw:Ep
naming:Name
          string:Basic
name  (nw:Ep:name)
           Overrides:nw:Conn:name
           The name of the object.
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.
Properties Detail

absentCounter

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Number of absent conditions detected.



adminSt

Type: nw:IfAdminSt
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





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





consumption

Type: poe:IfPwrCfgWattage
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Consumption
Constants
defaultValue 4000 --- NO COMMENTS





cutoffPower

Type: poe:IfPwrWattage
Primitive Type: scalar:Sint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Cutoff Power



deliveredPower

Type: poe:IfPwrWattage
Primitive Type: scalar:Sint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Delivered Power



descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:



devClass

Type: poe:DeviceClass
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Device Class



devName

Type: poe:DeviceName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Device Name



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.



id

Type: nw:IfId
Primitive Type: base:IfIndex

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



invalidSignatureCounter

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Number of invalid signature conditions detected.



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





max

Type: poe:ModPwrWattage
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The maximum power in milliwatts that is allowed on the interface.
Constants
defaultValue 30000 --- 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





mode

Type: poe:PowerMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The PoE power mode of the interface.
Constants
never 1 Never Never
auto 2 Auto Auto
static 3 Static Static
DEFAULT auto(2) Auto Auto





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Monitoring policy attached to this observable object



name

Type: naming:Name
Primitive Type: string:Basic

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



operSt

Type: poe:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operational
Constants
off 0 No Power Applied Off
on 1 Power Applied On
err-dis 2 Error Disable Error Disable
fault 3 Fault Fault
power-deny 4 Power-Deny Power Deny
recoverable-error 5 Recoverable Error Recoverable Error
unrecoverable-error 6 Unrecoverable Error Unrecoverable Error
DEFAULT off(0) No Power Applied Off





overloadCounter

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Number of overload conditions detected.



poeEpg

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
PoE Epg



poeVoiceVlan

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
PoE VLAN



policeAct

Type: poe:PoliceAct
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Policing Action
Constants
none 0 None None
err-dis 1 Error Disable Error Disable
log 2 Log Log
DEFAULT err-dis(1) Error Disable Error Disable





policeSt

Type: poe:PoliceSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operation Police state
Constants
na 0 Not Available NA
err-dis 1 Error Disable Error Disable
log 2 Log Log
ok 3 OK OK
DEFAULT 0 --- Oper Police State





policingPower

Type: poe:IfPwrWattage
Primitive Type: scalar:Sint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Policing Power



portConsumption

Type: poe:IfPwrWattage
Primitive Type: scalar:Sint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Port Consumption



portPriority

Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
port priority



powerDeniedCounter

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Number of denied conditions detected.



prioHigh

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Port Priority High
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- 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.



shortCounter

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Number of short conditions detected.



status

Type: poe:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelStatus
    Comments:
status
Constants
off 0 No Power Applied Off
on 1 Power Applied On
err-dis 2 Error Disable Error Disable
fault 3 Fault Fault
power-deny 4 Power-Deny Power Deny
recoverable-error 5 Recoverable Error Recoverable Error
unrecoverable-error 6 Unrecoverable Error Unrecoverable Error
DEFAULT off(0) No Power Applied Off





suppliedPower

Type: poe:IfPwrWattage
Primitive Type: scalar:Sint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Supplied Power



used

Type: poe:IfPwrWattage
Primitive Type: scalar:Sint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Usage