Class fabric:HIfPol (CONCRETE)

Class ID:847
Class Label: Link Level 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, access-protocol, admin]
Read Access: [access-connectivity, access-protocol, 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: false, HasHealth: true, HasEventRules: false ]

The host interface policy specifies the layer 1 parameters of host facing ports.

Naming Rules
RN FORMAT: hintfpol-{name}

    [1] PREFIX=hintfpol- PROPERTY = name




DN FORMAT: 

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

                


Diagram

Super Mo: fabric:IntfPol,
Container Mos: infra:Infra (deletable:yes),
Contained Mos: aaa:RbacAnnotation, tag:AInst, tag:Annotation, tag:Tag,
Relations From: infra:AAccGrp, l1:EthIf,
Relations: fabric:RtHIfPol, fabric:RtHIfPolCons, fabric:RtResHIfPol,


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] fabric:HIfPol The host interface policy specifies the layer 1 parameters of host facing ports.
[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] fabric:HIfPol The host interface policy specifies the layer 1 parameters of host facing ports.


Contained Hierarchy
[V] fabric:HIfPol The host interface policy specifies the layer 1 parameters of host facing ports.
 ├
[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] fabric:RtHIfPol A target relation to the host interface policy. Note that this relation is an internal object.
 ├
[V] fabric:RtHIfPolCons A target relation to the host interface policy. Note that this relation is an internal object.
 ├
[V] fabric:RtResHIfPol A target relation to the host interface policy. Note that this relation is an internal object.
 ├
[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: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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] tag:AInst The label instance, which is contained by the taggable object.
 
 ├
[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] 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:IntfPol An abstraction of the interface policy.
 
 
 
 
 ├
[V] fabric:HIfPol The host interface policy specifies the layer 1 parameters of host facing ports.


Events
                fabric:HIfPol:creation__fabric_HIfPol
fabric:HIfPol:modification__fabric_HIfPol
fabric:HIfPol:deletion__fabric_HIfPol


Faults
                


Fsms
                


Properties Summary
Defined in: fabric:HIfPol
mo:Annotation
          string:Basic
annotation  (fabric:HIfPol:annotation)
           NO COMMENTS
l1:AutoNeg
          scalar:Enum8
autoNeg  (fabric:HIfPol:autoNeg)
           The policy auto-negotiation. Auto-negotiation is an optional function of the IEEE 802.3u Fast Ethernet standard that enables devices to automatically exchange information over a link about speed and duplex abilities.
l1:DfeDelayMs
          scalar:Uint16
dfeDelayMs  (fabric:HIfPol:dfeDelayMs)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (fabric:HIfPol:extMngdBy)
           NO COMMENTS
l1:FECMode
          scalar:Enum8
fecMode  (fabric:HIfPol:fecMode)
           Forwarding error correction (FEC) mode. By incorporating error correction information into data packets, FEC improves the reliability of data transmission over networks that lack guaranteed delivery mechanisms.
l1:LinkDebounce
          scalar:Uint16
linkDebounce  (fabric:HIfPol:linkDebounce)
           The interface policy administrative port link debounce interval. Enables the debounce timer for physical interface ports and sets it for a specified amount of time in milliseconds. The debounce timer is disabled if you specify the time to 0 ms.
reference:BinRef monPolDn  (fabric:HIfPol:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic
name  (fabric:HIfPol:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           The name of the interface policy. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.
l1:Speed
          scalar:Enum16
speed  (fabric:HIfPol:speed)
           The interface policy administrative port speed. The data transfer rate for the port should match the destination to which the port is linked. The administrative speed can be changed only for certain ports, and not all speeds are available on all systems. For more information, see the Hardware Installation Guide for your fabric interconnect.
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: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.
mo:UserDomType
          string:Basic
userdom  (mo:Ownable:userdom)
           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.
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



autoNeg

Type: l1:AutoNeg
Primitive Type: scalar:Enum8

Like: l1:If:autoNeg
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The policy auto-negotiation. Auto-negotiation is an optional function of the IEEE 802.3u Fast Ethernet standard that enables devices to automatically exchange information over a link about speed and duplex abilities.
Constants
on 1 on NO COMMENTS
off 2 off NO COMMENTS
on-enforce 3 on-enforce NO COMMENTS
DEFAULT on(1) on NO COMMENTS





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.



dfeDelayMs

Type: l1:DfeDelayMs
Primitive Type: scalar:Uint16

Like: l1:PhysIf:dfeDelayMs
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 10000
    Comments:
NO COMMENTS
Constants
defaultValue 0 --- NO 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.



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





fecMode

Type: l1:FECMode
Primitive Type: scalar:Enum8

Like: l1:PhysIf:fecMode
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Forwarding error correction (FEC) mode. By incorporating error correction information into data packets, FEC improves the reliability of data transmission over networks that lack guaranteed delivery mechanisms.
Constants
inherit 1 Inherit NO COMMENTS
cl91-rs-fec 2 CL91-RS-FEC NO COMMENTS
cl74-fc-fec 3 CL74-FC-FEC NO COMMENTS
ieee-rs-fec 4 IEEE-RS-FEC NO COMMENTS
cons16-rs-fec 5 CONS16-RS-FEC NO COMMENTS
kp-fec 6 KP-FEC NO COMMENTS
disable-fec 7 DISABLE-FEC NO COMMENTS
auto-fec 8 AUTO-FEC NO COMMENTS
DEFAULT inherit(1) Inherit 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





linkDebounce

Type: l1:LinkDebounce
Primitive Type: scalar:Uint16

Like: l1:EthIf:linkDebounce
Units: msec
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 5000
    Comments:
The interface policy administrative port link debounce interval. Enables the debounce timer for physical interface ports and sets it for a specified amount of time in milliseconds. The debounce timer is disabled if you specify the time to 0 ms.
Constants
defaultValue 100 --- 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: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:
The name of the interface policy. This name can be up to 64 characters. Note that you cannot change this name after the object has been saved.



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.



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.



speed

Type: l1:Speed
Primitive Type: scalar:Enum16

Like: l1:If:speed
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The interface policy administrative port speed. The data transfer rate for the port should match the destination to which the port is linked. The administrative speed can be changed only for certain ports, and not all speeds are available on all systems. For more information, see the Hardware Installation Guide for your fabric interconnect.
Constants
unknown 0 Unspecified Speed is unknown
100M 1 100 Mbps Speed is 100 Mbps
1G 2 1 Gbps Speed is 1 Gbps
10G 3 10 Gbps Speed is 10 Gbps
25G 4 25 Gbps Speed is 25 Gbps
40G 5 40 Gbps Speed is 40 Gbps
50G 6 50 Gbps Speed is 50 Gbps
100G 7 100 Gbps Speed is 100 Gbps
200G 8 200 Gbps Speed is 200 Gbps
400G 9 400 Gbps Speed is 400 Gbps
inherit 10 inherit Speed is Inherited
DEFAULT inherit(10) inherit Speed is Inherited





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.






uid

Type: scalar:Uint16

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



userdom

Type: mo:UserDomType
Primitive Type: string:Basic

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