Class vpc:If (CONCRETE)

Class ID:3428
Class Label: VPC 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-connectivity-l2, admin]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: true ]

The vPC interfaces information enables links that are physically connected to two different Fabric devices to appear as a single port channel by a third device. The third device can be a switch, server, or any other networking device that supports port channels. A vPC can provide Layer 2 multipathing, which allows you to create redundancy and increase bisectional bandwidth by enabling multiple parallel paths between nodes and allowing load balancing traffic.

Naming Rules
RN FORMAT: if-{id}

    [1] PREFIX=if- PROPERTY = id




DN FORMAT: 

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

[1] sys/vpc/inst/dom-{id}/if-{id}

                


Diagram

Container Mos: vpc:Dom (deletable:yes),
Contained Mos: vpc:AppParams,
Relations To: pc:AggrIf,
Relations: vpc:RsVpcConf,


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] vpc:Entity The vPC control plane entity information.
 
 
 
 
 
 ├
[V] vpc:Inst The vPC instance information. There is only one instance of vpc running in the system today.
 
 
 
 
 
 
 ├
[V] vpc:Dom The vPC domain information. There is only one configurable vPC domain that is in the system.
 
 
 
 
 
 
 
 ├
[V] vpc:If The vPC interfaces information enables links that are physically connected to two different Fabric devices to appear as a single port channel by a third device. The third device can be a switch, server, or any other networking device that supports port channels. A vPC can provide Layer 2 multipathing, which allows you to create redundancy and increase bisectional bandwidth by enabling multiple parallel paths between nodes and allowing load balanc...
[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] vpc:Entity The vPC control plane entity information.
 
 
 ├
[V] vpc:Inst The vPC instance information. There is only one instance of vpc running in the system today.
 
 
 
 ├
[V] vpc:Dom The vPC domain information. There is only one configurable vPC domain that is in the system.
 
 
 
 
 ├
[V] vpc:If The vPC interfaces information enables links that are physically connected to two different Fabric devices to appear as a single port channel by a third device. The third device can be a switch, server, or any other networking device that supports port channels. A vPC can provide Layer 2 multipathing, which allows you to create redundancy and increase bisectional bandwidth by enabling multiple parallel paths between nodes and allowing load balanc...


Contained Hierarchy
[V] vpc:If The vPC interfaces information enables links that are physically connected to two different Fabric devices to appear as a single port channel by a third device. The third device can be a switch, server, or any other networking device that supports port channels. A vPC can provide Layer 2 multipathing, which allows you to create redundancy and increase bisectional bandwidth by enabling multiple parallel paths between nodes and allowing load balanc...
 ├
[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] vpc:AppParams The application parameters.
 
 ├
[V] vpc:AppParamInfo A container for application and parameter information.
 ├
[V] vpc:RsVpcConf The port-channel.
 
 ├
[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] vpc:If The vPC interfaces information enables links that are physically connected to two different Fabric devices to appear as a single port channel by a third device. The third device can be a switch, server, or any other networking device that supports port channels. A vPC can provide Layer 2 multipathing, which allows you to create redundancy and increase bisectional bandwidth by enabling multiple parallel paths between nodes and allowing load balanc...


Events
                vpc:If:vpc_If_ifUp
vpc:If:vpc_If_peerIfUp
vpc:If:vpc_If_peerIfDown
vpc:If:vpc_If_ifCompatPass
vpc:If:vpc_If_ifCompatCheckBypass


Faults
                vpc:If:ifCompatFail
vpc:If:ifDown
vpc:If:ifFabricEncapMismatch
vpc:If:ifImpaired


Fsms
                


Properties Summary
Defined in: vpc:If
reference:BinRef accBndlGrpDn  (vpc:If:accBndlGrpDn)
           AccBndlGrp DN
base:Encap cfgdAccessVlan  (vpc:If:cfgdAccessVlan)
           The vPC interface's configured access VLAN.
l2:VlanBitmap
          base:BitArray4096
cfgdTrunkVlans  (vpc:If:cfgdTrunkVlans)
           The vPC interface's configured trunk VLANs. A trunk port can have two or more VLANs configured on the interface; it can carry traffic for several VLANs simultaneously.
l2:VlanBitmap
          base:BitArray4096
cfgdVlans  (vpc:If:cfgdVlans)
           The configured VLANs of the interface.
vpc:CompatQual
          scalar:Uint32
compatQual  (vpc:If:compatQual)
           Compatibility reason code
string:Basic compatQualStr  (vpc:If:compatQualStr)
           Compatibility reason code string
vpc:CompatSt
          scalar:Enum8
compatSt  (vpc:If:compatSt)
           Compatibility status
naming:Descr
          string:Basic
descr  (vpc:If:descr)
           The description of this configuration item.
l2:VlanBitmap
          base:BitArray4096
fabEncMismatchVlans  (vpc:If:fabEncMismatchVlans)
           Fabric Encap Mismatched vlans on peer
l2:fabEncMismatchVlansSetT
          scalar:Enum8
fabEncMismatchVlansSet  (vpc:If:fabEncMismatchVlansSet)
           Event Manger not able to raise fault on bitmaps So adding fabEncMismatchVlansSet to set Fault
reference:BinRef fabricPathDn  (vpc:If:fabricPathDn)
          
vpc:Id
          scalar:Uint16
id  (vpc:If:id)
           The vPC interface identifier.
vpc:OperSt
          scalar:Enum8
localOperSt  (vpc:If:localOperSt)
           The local operational status of the vPC interface.
reference:BinRef monPolDn  (vpc:If:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic
name  (vpc:If:name)
           The name of the object.
pc:Mode
          scalar:Enum8
pcMode  (vpc:If:pcMode)
          
l2:VlanBitmap
          base:BitArray4096
peerCfgdVlans  (vpc:If:peerCfgdVlans)
           The VLANs configured by the peer for the vPC interface.
l2:VlanBitmap
          base:BitArray4096
peerUpVlans  (vpc:If:peerUpVlans)
           The VLANs active on the peer for the vPC interface.
vpc:OperSt
          scalar:Enum8
remoteOperSt  (vpc:If:remoteOperSt)
           The peer's operational status for the vPC interface.
l2:VlanBitmap
          base:BitArray4096
suspVlans  (vpc:If:suspVlans)
           The suspended VLANs of the interface. You can configure VLANs to be in the active state, in which the VLANs pass traffic, or the suspended state, in which the VLANs do not pass traffic. By default, the VLANs are in the active state and pass traffic. Note that even if a VLAN is configured to be active, it can be operationally suspended if it has not been configured on the peer switch.
l2:VlanBitmap
          base:BitArray4096
upVlans  (vpc:If:upVlans)
           The active VLANs of the interface. You can configure VLANs to be in the active state, in which the VLANs pass traffic, or the suspended state, in which the VLANs do not pass traffic. By default, the VLANs are in the active state and pass traffic. Note that even if a VLAN is configured to be active, it can be operationally suspended if it has not been configured on the peer switch.
l1:PortUsage
          scalar:Bitmask32
usage  (vpc:If:usage)
           The usage of the port. This property shows how the port is used.
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.
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.
Properties Detail

accBndlGrpDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
AccBndlGrp DN



cfgdAccessVlan

Type: base:Encap

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The vPC interface's configured access VLAN.



cfgdTrunkVlans

Type: l2:VlanBitmap
Primitive Type: base:BitArray4096

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The vPC interface's configured trunk VLANs. A trunk port can have two or more VLANs configured on the interface; it can carry traffic for several VLANs simultaneously.



cfgdVlans

Type: l2:VlanBitmap
Primitive Type: base:BitArray4096

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The configured VLANs of the interface.



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





compatQual

Type: vpc:CompatQual
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Compatibility reason code



compatQualStr

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Compatibility reason code string



compatSt

Type: vpc:CompatSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Compatibility status
Constants
pass 0 success NO COMMENTS
fail 1 failed NO COMMENTS
notDone 2 Not Applicable NO COMMENTS
DEFAULT notDone(2) Not Applicable NO COMMENTS





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The description of this configuration item.



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.



fabEncMismatchVlans

Type: l2:VlanBitmap
Primitive Type: base:BitArray4096

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Fabric Encap Mismatched vlans on peer



fabEncMismatchVlansSet

Type: l2:fabEncMismatchVlansSetT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Event Manger not able to raise fault on bitmaps So adding fabEncMismatchVlansSet to set Fault
Constants
pass 0 No Mismatched Vlasns NO COMMENTS
failed 1 Mismatched Vlans NO COMMENTS
DEFAULT pass(0) No Mismatched Vlasns NO COMMENTS





fabricPathDn

Type: reference:BinRef

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



id

Type: vpc:Id
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
The vPC interface 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





localOperSt

Type: vpc:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The local operational status of the vPC interface.
Constants
unknown 0 Unknown NO COMMENTS
down 1 Down NO COMMENTS
up 2 Up NO COMMENTS
noCfg 3 Not configured NO COMMENTS
DEFAULT unknown(0) Unknown 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

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The name of the object.



pcMode

Type: pc:Mode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
on 0 on Static port channel
static 1 Static Static port channel, to be deprecated
active 2 lacp-active LACP active port channel
passive 3 lacp-passive LACP passive port channel
mac-pin 4 MAC Pinning mac-pin no LACP
mac-pin-nicload 5 MAC Pinning-Physical-NIC-load NO COMMENTS
explicit-failover 6 Explicit Failover Order explicit failover order
DEFAULT static(1) Static Static port channel, to be deprecated





peerCfgdVlans

Type: l2:VlanBitmap
Primitive Type: base:BitArray4096

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The VLANs configured by the peer for the vPC interface.



peerUpVlans

Type: l2:VlanBitmap
Primitive Type: base:BitArray4096

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The VLANs active on the peer for the vPC interface.



remoteOperSt

Type: vpc:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The peer's operational status for the vPC interface.
Constants
unknown 0 Unknown NO COMMENTS
down 1 Down NO COMMENTS
up 2 Up NO COMMENTS
noCfg 3 Not configured NO COMMENTS
DEFAULT unknown(0) Unknown 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.






suspVlans

Type: l2:VlanBitmap
Primitive Type: base:BitArray4096

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The suspended VLANs of the interface. You can configure VLANs to be in the active state, in which the VLANs pass traffic, or the suspended state, in which the VLANs do not pass traffic. By default, the VLANs are in the active state and pass traffic. Note that even if a VLAN is configured to be active, it can be operationally suspended if it has not been configured on the peer switch.



upVlans

Type: l2:VlanBitmap
Primitive Type: base:BitArray4096

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The active VLANs of the interface. You can configure VLANs to be in the active state, in which the VLANs pass traffic, or the suspended state, in which the VLANs do not pass traffic. By default, the VLANs are in the active state and pass traffic. Note that even if a VLAN is configured to be active, it can be operationally suspended if it has not been configured on the peer switch.



usage

Type: l1:PortUsage
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The usage of the port. This property shows how the port is used.
Constants
out-of-service 128u Out Of Service NO COMMENTS
controller 16u Controller NO COMMENTS
discovery 1u Discovery NO COMMENTS
fabric-ext 256u Fabric External NO COMMENTS
epg 2u EPG NO COMMENTS
blacklist 32u Black listed NO COMMENTS
fabric 4u Fabric NO COMMENTS
span 64u Span NO COMMENTS
infra 8u Infra NO COMMENTS
DEFAULT discovery(1u) Discovery NO COMMENTS