Class dot1x:If (CONCRETE)

Class ID:10535
Class Label: 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-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: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

This object holds dot1x 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/dot1x/inst/if-{[id]}

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

                


Diagram

Super Mo: l2:ProtIf,
Container Mos: dot1x:Inst (deletable:no),
Contained Mos: dot1x:DAEp, dot1x:DUEp, dot1x:IfStats, dot1x:VDAEp,
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] dot1x:Entity  Holds dot1x control plane entity information
 
 
 
 
 
 ├
[V] dot1x:Inst  This objects hold per dot1x instance information. There is only one instance of dot1x running in the system today
 
 
 
 
 
 
 ├
[V] dot1x:If  This object holds dot1x information that is operated at a interface 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] dot1x:Entity  Holds dot1x control plane entity information
 
 
 ├
[V] dot1x:Inst  This objects hold per dot1x instance information. There is only one instance of dot1x running in the system today
 
 
 
 ├
[V] dot1x:If  This object holds dot1x information that is operated at a interface level


Contained Hierarchy
[V] dot1x:If  This object holds dot1x information that is operated at a interface level
 ├
[V] dot1x:DAEp  This object holds dynamic Authenticated EP info
 
 ├
[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] dot1x:DUEp 
 ├
[V] dot1x:IfStats  Dot1x Interface Statistics
 
 ├
[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] dot1x:VDAEp  This object holds dynamic Authenticated EP info. This is copied from concrete DAEp MO
 
 ├
[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] 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] l2:RsEthIf A source relation to an L1 interface. This is an internal object.
 ├
[V] l2:RsMgmtIf  Association to the corresponding mgmt::MgmtIf
 ├
[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] dot1x:If  This object holds dot1x information that is operated at a interface level


Events
                


Faults
                dot1x:If:hardwareNotSupported
dot1x:If:invalidConfiguration


Fsms
                


Properties Summary
Defined in: dot1x:If
dot1x:Ctrl
          scalar:Enum8
ctrl  (dot1x:If:ctrl)
           The control state.
dot1x:GuestVlan
          scalar:Uint16
guestVlan  (dot1x:If:guestVlan)
           Guest VLAN
dot1x:HostMode
          scalar:Enum8
hostMode  (dot1x:If:hostMode)
           Host Mode
nw:IfId
          base:IfIndex
id  (dot1x:If:id)
           Overrides:nw:If:id
           An object identifier.
dot1x:MacAuth
          scalar:Enum8
macAuth  (dot1x:If:macAuth)
           MAC Auth
dot1x:MaxReauthReq
          scalar:UByte
maxReauthReq  (dot1x:If:maxReauthReq)
           Max Reauth Request
dot1x:MaxReq
          scalar:UByte
maxReq  (dot1x:If:maxReq)
           Max Request
reference:BinRef monPolDn  (dot1x:If:monPolDn)
           The monitoring policy attached to this observable object.
dot1x:OperStQual
          scalar:Enum8
operStQual  (dot1x:If:operStQual)
           The chassis operational status qualifier.
dot1x:QuietPeriod
          scalar:Uint16
quietPeriod  (dot1x:If:quietPeriod)
           Quiet Period
dot1x:RateLimitPeriod
          scalar:Uint16
rateLimitPeriod  (dot1x:If:rateLimitPeriod)
           Rate limit period
scalar:Bool reAuth  (dot1x:If:reAuth)
           Re-authentication
dot1x:ReAuthPeriod
          scalar:Uint32
reAuthPeriod  (dot1x:If:reAuthPeriod)
           Re-auth Period
dot1x:ServerTimeout
          scalar:Uint16
serverTimeout  (dot1x:If:serverTimeout)
           Server Timeout
dot1x:SuppTimeout
          scalar:Uint16
suppTimeout  (dot1x:If:suppTimeout)
           Supplicant Timeout
dot1x:TxPeriod
          scalar:Uint16
txPeriod  (dot1x:If:txPeriod)
           Tx Period
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: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

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





ctrl

Type: dot1x:Ctrl
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
auto 1 Auto Auto
force-authorized 2 Force Authorized Force Authorized
force-unauthorized 3 Force Unauthorized Force Unauthorized
DEFAULT auto(1) Auto Auto





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.



guestVlan

Type: dot1x:GuestVlan
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Guest VLAN
Constants
defaultValue 0 --- Default value 0 means that GUEST VLAN is not configured





hostMode

Type: dot1x:HostMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Host Mode
Constants
single-host 1 Single Host Single Host
multi-host 2 Multi Host Multi Host
multi-auth 3 Multi Auth Multi Auth
multi-domain 4 Multi Domain Multi Domain
DEFAULT single-host(1) Single Host Single Host





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





macAuth

Type: dot1x:MacAuth
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
MAC Auth
Constants
bypass 2 EAP_FALLBACK_MAB Bypass Enabled
eap 3 EAP Enabled with EAP
DEFAULT eap(3) EAP Enabled with EAP





maxReauthReq

Type: dot1x:MaxReauthReq
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Reauth Request
Constants
defaultValue 2 --- NO COMMENTS





maxReq

Type: dot1x:MaxReq
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Request
Constants
defaultValue 2 --- 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.



operStQual

Type: dot1x:OperStQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The chassis operational status qualifier.
Constants
up 1 Up up
admin-down 2 Administratively down Down administratively
if-down 3 Interface down Interface down
unsupported 4 Unsupported Unsupported
platform-not-supported 5 Platform not supported Platform not supported
DEFAULT up(1) Up up





quietPeriod

Type: dot1x:QuietPeriod
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Quiet Period
Constants
defaultValue 60 --- NO COMMENTS





rateLimitPeriod

Type: dot1x:RateLimitPeriod
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Rate limit period
Constants
defaultValue 0 --- NO COMMENTS





reAuth

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Re-authentication
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





reAuthPeriod

Type: dot1x:ReAuthPeriod
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Re-auth Period
Constants
defaultValue 3600u --- 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.



serverTimeout

Type: dot1x:ServerTimeout
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Server Timeout
Constants
defaultValue 30 --- NO COMMENTS





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.






suppTimeout

Type: dot1x:SuppTimeout
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Supplicant Timeout
Constants
defaultValue 30 --- NO COMMENTS





txPeriod

Type: dot1x:TxPeriod
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Tx Period
Constants
defaultValue 30 --- NO COMMENTS