Class lacp:If (CONCRETE)

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

The LACP information that is operated at an interface (member port of the port channel) level.

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

    [1] PREFIX=if- PROPERTY = id




DN FORMAT: 

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

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

                


Diagram

Super Mo: l2:ProtIf,
Container Mos: lacp:Inst (deletable:no),
Contained Mos: lacp:AdjEp, lacp:IfStats,
Relations From: nw:PathEp,
Relations To: l1:EthIf, mgmt:MgmtIf,
Relations: l2:RsEthIf, l2:RsMgmtIf, 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] lacp:Entity Holds lacp control plane entity information.
 
 
 
 
 
 ├
[V] lacp:Inst The LACP instance information. Only one LACP instance is currently supported.
 
 
 
 
 
 
 ├
[V] lacp:If The LACP information that is operated at an interface (member port of the port channel) 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] lacp:Entity Holds lacp control plane entity information.
 
 
 ├
[V] lacp:Inst The LACP instance information. Only one LACP instance is currently supported.
 
 
 
 ├
[V] lacp:If The LACP information that is operated at an interface (member port of the port channel) level.


Contained Hierarchy
[V] lacp:If The LACP information that is operated at an interface (member port of the port channel) level.
 ├
[V] l2:RsEthIf A source relation to an L1 interface. This is an internal object.
 ├
[V] l2:RsMgmtIf  Association to the corresponding mgmt::MgmtIf
 ├
[V] lacp:AdjEp The LACP neighbor information.
 ├
[V] lacp:IfStats Holds LACP interface statistics operational information. This is a singleton within an interface.
 ├
[V] nw:RtPathToIf A target relation to the interface information.


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] lacp:If The LACP information that is operated at an interface (member port of the port channel) level.


Events
                lacp:If:lacp_If_portPrioChange


Faults
                


Fsms
                


Properties Summary
Defined in: lacp:If
lacp:ActivityFlags
          scalar:Bitmask8
activityFlags  (lacp:If:activityFlags)
           Specifies the LACP interface activity flags.
nw:IfId
          base:IfIndex
id  (lacp:If:id)
           Overrides:nw:If:id
           Specifies the LACP interface ID.
lacp:Key
          scalar:Uint16
key  (lacp:If:key)
           Specifies the LACP interface operational key.
scalar:Date lastActive  (lacp:If:lastActive)
           Indicates the last operationally active timestamp on the LACP interface.
reference:BinRef monPolDn  (lacp:If:monPolDn)
           The monitoring policy attached to this observable object.
lacp:PortPrio
          scalar:Uint16
operPrio  (lacp:If:operPrio)
           Specifies the LACP interface operational port priority.
lacp:PortNum
          scalar:Uint16
port  (lacp:If:port)
           Specifies the LACP interface local port number.
lacp:PortPrio
          scalar:Uint16
prio  (lacp:If:prio)
           Specifies the LACP interface port priority. When there is a limitation that prevents all compatible ports from aggregating then the port priority should be set to standby mode. A higher port priority value means a lower priority for LACP.
lacp:TxRate
          scalar:Enum8
txRate  (lacp:If:txRate)
           Specifies the rate at which the LACP packets are transmitted.
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.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Properties Detail

activityFlags

Type: lacp:ActivityFlags
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Specifies the LACP interface activity flags.
Constants
active 1 Active Active mode
short 2 Short timeout Timeout
aggregate 4 Aggregatable Aggregatable
sync 8 In sync In sync
collect 16 Collecting Collecting
distribute 32 Distributing Distributing
defaulted 64 Defaulted Defaulted
expired 128 Expired Expired
DEFAULT 0 --- Activity flags





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





descr

Type: naming:Descr
Primitive Type: string:Basic

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



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:
Specifies the LACP interface ID.



key

Type: lacp:Key
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Specifies the LACP interface operational key.



lastActive

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Indicates the last operationally active timestamp on the LACP interface.



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





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The 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.



operPrio

Type: lacp:PortPrio
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Specifies the LACP interface operational port priority.
Constants
defaultValue 32768 --- NO COMMENTS





port

Type: lacp:PortNum
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Specifies the LACP interface local port number.



prio

Type: lacp:PortPrio
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the LACP interface port priority. When there is a limitation that prevents all compatible ports from aggregating then the port priority should be set to standby mode. A higher port priority value means a lower priority for LACP.
Constants
defaultValue 32768 --- 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.






txRate

Type: lacp:TxRate
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies the rate at which the LACP packets are transmitted.
Constants
normal 1 Normal Normal
fast 2 Fast Fast
DEFAULT normal(1) Normal Normal