Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class l1:If (ABSTRACT)

Class ID:3613
Class Label: Interface
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity-l1, admin, tenant-protocol-l2]
Creatable/Deletable: no (see Container Mos for details)
Possible Semantic Scopes: Infra, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

An abstraction for a layer-1 interface in the system. The properties apply to all types of interfaces.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: nw:If,
Sub Mos: l1:EthIf, mgmt:MgmtIf,
Relations From: span:ASource, nw:PathEp,
Relations: l1:RtSpanSrcToL1IfAtt, nw:RtPathToIf,


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] l1:If An abstraction for a layer-1 interface in the system. The properties apply to all types of interfaces.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] l1:EthIf An abstraction of Ethernet interface properties that are common between Ethernet physical interfaces and aggregated interfaces.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] cnw:AggrIf The aggregated interface assigned to the node cluster.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] cnw:PhysIf The physical interface assigned to the node cluster.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] l1:PhysIf The object that represents the Layer 1 physical Ethernet interface information object.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] pc:AggrIf The aggregated interface, which is a collection of physical ports; aka port channel
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] mgmt:MgmtIf The management interface.


Events


Faults


Fsms


Properties Summary
Defined in: l1:If
l1:AdminSt
          scalar:Enum8 		adminSt  (l1:If:adminSt)
           Administrative port state
l1:AutoNeg
          scalar:Enum8 		autoNeg  (l1:If:autoNeg)
           Administrative port auto-negotiation
l1:Mtu
          scalar:Uint32 		mtu  (l1:If:mtu)
           Administrative port mtu
l1:SnmpTrapSt
          scalar:Enum8 		snmpTrapSt  (l1:If:snmpTrapSt)
           Administrative port snmp trap state
l1:Speed
          scalar:Enum8 		speed  (l1:If:speed)
           Administrative port speed
l1:SwitchingSt
          scalar:Enum8 		switchingSt  (l1:If:switchingSt)
           Switching state
Defined in: nw:If
naming:Descr
          string:Basic 		descr  (nw:If:descr)
          
nw:IfId
          base:IfIndex 		id  (nw:If:id)
           An identifier .
Defined in: nw:Ep
naming:Name
          string:Basic 		name  (nw:Ep:name)
           Overrides:nw:Conn:name
           The name of the object.
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

adminSt

Type: l1:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Administrative port state
Constants
down 1 down Admin state shut
up 2 up Admin state up
DEFAULT down(1) down Admin state shut




autoNeg

Type: l1:AutoNeg
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Administrative port auto-negotiation
Constants
on 1 on NO COMMENTS
off 2 off 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
    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.


id

Type: nw:IfId
Primitive Type: base:IfIndex

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
    Comments:
An identifier .


mtu

Type: l1:Mtu
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Administrative port mtu
Constants
defaultValue 9000u --- NO COMMENTS




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.


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.


snmpTrapSt

Type: l1:SnmpTrapSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Administrative port snmp trap state
Constants
enable 1 enable NO COMMENTS
disable 2 disable NO COMMENTS
DEFAULT enable(1) enable NO COMMENTS




speed

Type: l1:Speed
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Administrative port speed
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
100G 6 100 Gbps Speed is 100 Gbps
inherit 7 inherit Speed is Inherited
DEFAULT inherit(7) 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.





switchingSt

Type: l1:SwitchingSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Switching state
Constants
disabled 0 disabled NO COMMENTS
enabled 1 enabled NO COMMENTS
DEFAULT disabled(0) disabled NO COMMENTS






Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail