Cisco System Model: Classpoe:If

Overview

Naming

Diagram

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail

Class poe:If (CONCRETE)

Class ID:10530
Class Label: Interface
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l1, access-protocol-l2, admin, fabric-protocol-l1, fabric-protocol-l2, 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: false, HasStats: false, HasFaults: false, HasHealth: false, 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), Relations From: nw:PathEp, Relations To: l1:EthIf, Relations: l2:RsEthIf, nw:RtPathToIf,

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.

├

fabric:Topology The root for IFC topology.

├

fabric:Pod A pod.

├

fabric:Node The root node for the APIC.

├

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...

├

poe:Entity Holds Power over Ethernet control plane entity information

├

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

├

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

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├

├

poe:Entity Holds Power over Ethernet control plane entity information

├

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

├

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

Contained Hierarchy

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

├

l2:RsEthIf A source relation to an L1 interface. This is an internal object.

├

nw:RtPathToIf A target relation to the interface information.

Inheritance

nw:Item Ignore.

├

nw:Conn A connection abstraction.

├

nw:Ep A static endpoint.

├

nw:ConnEp A connection endpoint abstraction.

├

nw:If The interface information.

├

nw:LogicalIf A logical interface abstraction.

├

nw:ProtIf A protocol interface abstraction.

├

l2:ProtIf A protocol interface abstraction.

├

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

Events

Faults

Fsms

Properties Summary

Defined in: poe:If
poe:IfPwrCfgWattage scalar:Uint16	consumption (poe:If:consumption) Consumption
poe:IfPwrWattage scalar:Uint16	cutoffPower (poe:If:cutoffPower) Cutoff Power
poe:DeviceClass scalar:UByte	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 An object identifier.
poe:IfPwrCfgWattage scalar:Uint16	max (poe:If:max) A maximum limit on routes leaked.
poe:PowerMode scalar:Enum8	mode (poe:If:mode) The BGP Domain mode.
poe:OperSt scalar:Enum8	operSt (poe:If:operSt) The runtime state of the object or policy.
poe:PoliceAct scalar:Enum8	policeAct (poe:If:policeAct) Policing Action
poe:PoliceSt scalar:Enum8	policeSt (poe:If:policeSt) Operation Police state
scalar:Bool	prioHigh (poe:If:prioHigh) Port Priority High
poe:IfPwrWattage scalar:Uint16	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: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.

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.

Properties Detail

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:Uint16

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

Comments:

Cutoff 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: scalar:UByte

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:

An object identifier.

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:IfPwrCfgWattage
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

A maximum limit on routes leaked.

Constants
defaultValue	4000	---	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 BGP Domain mode.

Constants
never	1	Never	Never
auto	2	Auto	Auto
static	3	Static	Static
DEFAULT	auto(2)	Auto	Auto

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:

The runtime state of the object or policy.

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
DEFAULT	0	---	Operational state

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

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.

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.

used

Type: poe:IfPwrWattage
Primitive Type: scalar:Uint16

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

Comments:

Usage

Overview

Naming

Diagram

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail