Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class hcl1:BaseIf (ABSTRACT)

Class ID:14855
Class Label: Interface
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Enabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity, admin, fabric-protocol, tenant-connectivity, tenant-ext-connectivity, tenant-ext-protocol]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

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:ConnEp,
Sub Mos: hcl1:GigEthIf,


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] hcl1:BaseIf  Abstraction for a layer-1 interface in the system. The properties apply to all types of interfaces
 
 		 
 		 
 		 
 		 ├
 		[V] hcl1:GigEthIf  An abstraction of ethernet interface properties that are common between ethernet physical interfaces and aggregated interfaces
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] hcl1:PhysicalIf  Physical ethernet interface information holder


Events


Faults


Fsms


Properties Summary
Defined in: hcl1:BaseIf
hcl1:AdminState
          scalar:Enum8 		adminSt  (hcl1:BaseIf:adminSt)
           The administrative state of the object or policy.
hcl1:AutoNegotiate
          scalar:Enum8 		autoNeg  (hcl1:BaseIf: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.
scalar:Sint64 id  (hcl1:BaseIf:id)
           An object identifier.
hcl1:Mtu
          scalar:Uint32 		mtu  (hcl1:BaseIf:mtu)
           The administrative MTU port on the aggregated interface.
hcl1:Speed
          scalar:Enum8 		speed  (hcl1:BaseIf:speed)
           The CPU or port speed.
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: hcl1:AdminState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative state of the object or policy.
Constants
down 1 down Admin state shut
up 2 up Admin state up
DEFAULT down(1) down Admin state shut




autoNeg

Type: hcl1:AutoNegotiate
Primitive Type: scalar:Enum8

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




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: scalar:Sint64

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


mtu

Type: hcl1:Mtu
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative MTU port on the aggregated interface.
Constants
defaultValue 1400u --- 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.


speed

Type: hcl1:Speed
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The CPU or port speed.
Constants
unknown 0 Unspecified Speed is unknown
1G 1 1 Gbps Speed is 1 Gbps
10G 2 10 Gbps Speed is 10 Gbps
inherit 3 inherit Speed is Inherited
DEFAULT inherit(3) 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.







Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail