Class fc:IfPol (CONCRETE)

Class ID:9058
Class Label: Interface FC Policy
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [access-connectivity-l1, access-protocol-l2, admin]
Read Access: [access-connectivity-l1, access-protocol-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: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

interface FC policy

Naming Rules
RN FORMAT: fcIfPol-{name}

    [1] PREFIX=fcIfPol- PROPERTY = name




DN FORMAT: 

[1] uni/infra/fcIfPol-{name}

                


Diagram

Super Mo: fabric:L2IfPol,
Container Mos: infra:Infra (deletable:yes),
Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,
Relations From: infra:AccGrp, l1:EthIf, infra:FcAccGrp, l1:FcIf,
Relations: fc:RtFcIfPol, fc:RtFcIfPolCons, fc:RtFcL2IfPol, fc:RtNfcIfPolCons,


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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] infra:Infra A container for all tenant infra configurations.
 
 
 
 
 
 
 
 ├
[V] fc:IfPol  interface FC policy
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] infra:Infra A container for all tenant infra configurations.
 
 
 ├
[V] fc:IfPol  interface FC policy


Contained Hierarchy
[V] fc:IfPol  interface FC policy
 ├
[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] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] fc:RtFcIfPol  Relation to fcIFPol
 ├
[V] fc:RtFcIfPolCons  Relationship with the fcIfPol policy consumed by this physical interface
 ├
[V] fc:RtFcL2IfPol  Relationship to FC policy providing physical L2 configuration of the interfaces
 ├
[V] fc:RtNfcIfPolCons  Relationship with the fc Interface policy consumed by this physical interface
 ├
[V] tag:Annotation 
 ├
[V] tag:Tag 


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Def Represents self-contained policy document.
 
 
 ├
[V] fabric:ProtoPol A base class for protocol policies.
 
 
 
 ├
[V] fabric:ProtoIfPol A base class for interface-level protocol policies.
 
 
 
 
 ├
[V] fabric:L2IfPol A base class for layer 2 interface-level policies.
 
 
 
 
 
 ├
[V] fc:IfPol  interface FC policy


Events
                fc:IfPol:creation__fc_IfPol
fc:IfPol:modification__fc_IfPol
fc:IfPol:deletion__fc_IfPol


Faults
                


Fsms
                


Properties Summary
Defined in: fc:IfPol
mo:Annotation
          string:Basic
annotation  (fc:IfPol:annotation)
           NO COMMENTS
l1:FcMaxSpeed
          scalar:Enum8
automaxspeed  (fc:IfPol:automaxspeed)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (fc:IfPol:extMngdBy)
           NO COMMENTS
l1:FillPattern
          scalar:Enum8
fillPattern  (fc:IfPol:fillPattern)
           Fill Pattern for native FC ports
naming:Name
          string:Basic
name  (fc:IfPol:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
          
fc:IfMode
          scalar:Enum8
portMode  (fc:IfPol:portMode)
          
l1:Credit
          scalar:Uint32
rxBBCredit  (fc:IfPol:rxBBCredit)
           Receive buffer credits for native FC ports
l1:FcSpeed
          scalar:Enum8
speed  (fc:IfPol:speed)
           The CPU or port speed.
fc:TrkingMode
          scalar:Enum8
trunkMode  (fc:IfPol:trunkMode)
           Trunking on/off for native FC ports. And default value has to be OFF
Defined in: pol:Def
naming:Descr
          string:Basic
descr  (pol:Def:descr)
           Specifies a description of the policy definition.
naming:Descr
          string:Basic
ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic
ownerTag  (pol:Def:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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.
Defined in: mo:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
Properties Detail

annotation

Type: mo:Annotation
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS



automaxspeed

Type: l1:FcMaxSpeed
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
2G 10 2 Gbps Speed is 2 Gbps
4G 11 4 Gbps Speed is 4 Gbps
8G 12 8 Gbps Speed is 8 Gbps
16G 13 16 Gbps Speed is 16 Gbps
32G 14 32 Gbps Speed is 32 Gbps
DEFAULT 32G(14) 32 Gbps Speed is 32 Gbps





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
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies a description of the policy definition.



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.



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





fillPattern

Type: l1:FillPattern
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Fill Pattern for native FC ports
Constants
ARBFF 0 ARBFF NO COMMENTS
IDLE 1 IDLE NO COMMENTS
DEFAULT IDLE(1) IDLE NO COMMENTS





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





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:pol:Obj:name  |  naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators: Range: min: "1" max: "64" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    Comments:
NO COMMENTS



ownerKey

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
The key for enabling clients to own their data for entity correlation.



ownerTag

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
A tag for enabling clients to add their own data. For example, to indicate who created this object.



portMode

Type: fc:IfMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
f 0 F NO COMMENTS
np 1 NP NO COMMENTS
DEFAULT f(0) F 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.



rxBBCredit

Type: l1:Credit
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)16l  max: (long)64l
    Comments:
Receive buffer credits for native FC ports
Constants
defaultValue 64u --- NO COMMENTS





speed

Type: l1:FcSpeed
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The CPU or port speed.
Constants
unknown 0 Unspecified Speed is unknown
auto 10 Auto Speed is auto
4G 11 4 Gbps Speed is 4 Gbps
8G 12 8 Gbps Speed is 8 Gbps
16G 13 16 Gbps Speed is 16 Gbps
32G 14 32 Gbps Speed is 32 Gbps
DEFAULT auto(10) Auto Speed is auto





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.






trunkMode

Type: fc:TrkingMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Trunking on/off for native FC ports. And default value has to be OFF
Constants
un-init 0 un-init NO COMMENTS
trunk-off 1 trunk-off NO COMMENTS
trunk-on 2 trunk-on NO COMMENTS
auto 3 auto NO COMMENTS
DEFAULT trunk-off(1) trunk-off NO COMMENTS





uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.