Class pc:Inst (CONCRETE)

Class ID:3669
Class Label: Port Channel Instance
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: 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 ]

This object holds per port channel instance information

Naming Rules
RN FORMAT: pc

    [1] PREFIX=pc


DN FORMAT: 

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

[1] sys/pc/pc

                


Diagram

Super Mo: nw:CpInst,
Container Mos: pc:Entity (deletable:no),


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] pc:Entity 
 
 
 
 
 
 ├
[V] pc:Inst This object holds per port channel instance information
[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] pc:Entity 
 
 
 ├
[V] pc:Inst This object holds per port channel instance information


Contained Hierarchy
[V] pc:Inst This object holds per port channel instance information


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] pc:Inst This object holds per port channel instance information


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: pc:Inst
pc:NumChannels
          scalar:Uint32
freeChannels  (pc:Inst:freeChannels)
          
pc:HashDist
          scalar:Enum8
hashDist  (pc:Inst:hashDist)
           Hash distribution type
pc:LoadBalance
          scalar:Bitmask32
lbAlgo  (pc:Inst:lbAlgo)
           Load balancing algorithm
pc:LoadDeferTime
          scalar:Uint32
loadDeferTime  (pc:Inst:loadDeferTime)
           Load defer timeout
pc:NumChannels
          scalar:Uint32
maxChannels  (pc:Inst:maxChannels)
           Max number of port-channels
pc:PcntChannels
          scalar:UByte
pcntChannels  (pc:Inst:pcntChannels)
          
pc:NumChannels
          scalar:Uint32
usedChannels  (pc:Inst:usedChannels)
          
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: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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

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





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.



freeChannels

Type: pc:NumChannels
Primitive Type: scalar:Uint32

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



hashDist

Type: pc:HashDist
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Hash distribution type
Constants
adaptive 1 Adaptive Adaptive
fixed 2 Fixed Fixed
DEFAULT adaptive(1) Adaptive Adaptive





lbAlgo

Type: pc:LoadBalance
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Load balancing algorithm
Constants
src-dst-port 10u Source Destination Port source destination port
src-ip-port 11u Source Ip Port source ip port
src-ip-port-vlan 12u Source Ip Port Vlan source ip port vlan
src-ip-vlan 13u Source Ip Vlan source ip vlan
src-mac 14u Source Mac source MAC
src-port 15u Source Port source port
dst-ip-port 1u Destination Ip Port destination ip port
dst-ip-port-vlan 2u Destination Ip Port Vlan destination ip port vlan
dst-ip-vlan 3u Destination Ip Vlan destination ip Vlan
dst-mac 4u Destination Mac destination MAC
dst-port 5u Destination Port destination port
src-dst-ip-port 6u Source Destination Ip Port source destination ip port
src-dst-ip-port-vlan 7u Source Destination Ip Port Vlan source destination ip port vlan
src-dst-ip-vlan 8u Source Destination Ip Vlan source destination ip vlan
src-dst-mac 9u Source Destination Mac source destination MAC
DEFAULT 0 --- Load balance algorithm





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





loadDeferTime

Type: pc:LoadDeferTime
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Load defer timeout
Constants
defaultValue 120u --- NO COMMENTS





maxChannels

Type: pc:NumChannels
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max number of port-channels



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
int-err 8ull Internal error Internal errors
DEFAULT 0 --- Operational error qualifier





pcntChannels

Type: pc:PcntChannels
Primitive Type: scalar:UByte

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






usedChannels

Type: pc:NumChannels
Primitive Type: scalar:Uint32

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