Overview  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class adaptor:ExtIf (ABSTRACT)

Class ID:332
Encrypted: false - Exportable: false - Persistent: true
Privileges: [admin, ext-lan-config, ext-lan-policy, pn-equipment, pn-maintenance]
SNMP OID:

Abstract representation of network facing adaptor interface on a server adaptor.

Naming Rules 


DN FORMAT:


Inheritance
naming:NamedObject
 ├
 		network:Conn EndPoint abstraction
 
 		 ├
 		network:Ep EndPoint abstraction
 
 		 
 		 ├
 		network:IfEp Interface End Point abstraction
 
 		 
 		 
 		 ├
 		network:PhysEp
 
 		 
 		 
 		 
 		 ├
 		network:PIoEp Physical Interface End Point abstraction
 
 		 
 		 
 		 
 		 
 		 ├
 		adaptor:ExtIf
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		adaptor:ExtEthIf Network facing Ethernet interface on a server adaptor. For example, on a network adaptor installed on a UCS blade, this MO represents the Ethernet interface connected to the IO Module on the UCS chassis. In this case, the peer of this MO is a Server facing Ethernet interface on the IOM.
Events


Faults 
                adaptor:ExtIf:link-down


Fsms


Properties Summary
Defined in: adaptor:ExtIf
equipment:Id
          scalar:Uint32 		adapterId  (adaptor:ExtIf:adapterId)
           NO COMMENTS
scalar:Enum8 adminState  (adaptor:ExtIf:adminState)
           NO COMMENTS
ether:SatelliteConnectionDisc
          scalar:Enum8 		discovery  (adaptor:ExtIf:discovery)
           NO COMMENTS
equipment:Id
          scalar:Uint32 		id  (adaptor:ExtIf:id)
           NO COMMENTS
adaptor:LinkState
          scalar:Enum8 		linkState  (adaptor:ExtIf:linkState)
           NO COMMENTS
address:MAC lldpMac  (adaptor:ExtIf:lldpMac)
           In case of Lexington, the lldp MAC address is diferent from the MAC address and hence the lldp MAC has to be maintained sepraately as it is used to detect connectivity changes
address:MAC mac  (adaptor:ExtIf:mac)
           NO COMMENTS
network:PortOperState
          scalar:Enum8 		operState  (adaptor:ExtIf:operState)
           NO COMMENTS
string:Basic operStateDesc  (adaptor:ExtIf:operStateDesc)
           NO COMMENTS
reference:Object physEpDn  (adaptor:ExtIf:physEpDn)
           points at the terminating ep under switche's server facing port TODO - This used to have a reference to port:SIo - should we have a ref to fabric:Locale instead??? points at the physical server facing port of the mux
adaptor:Purpose
          scalar:Enum8 		purpose  (adaptor:ExtIf:purpose)
           NO COMMENTS
network:Side
          scalar:Enum8 		side  (adaptor:ExtIf:side)
           NO COMMENTS
Defined in: network:PIoEp
equipment:PortId
          scalar:Uint32 		aggrPortId  (network:PIoEp:aggrPortId)
           The aggregate port ID of this endpoint. Port using break-out cable to split an aggregate port to multiple ports.
equipment:PortId
          scalar:Uint32 		peerAggrPortId  (network:PIoEp:peerAggrPortId)
           NO COMMENTS
Defined in: network:PhysEp
equipment:ChassisId
          scalar:Uint32 		chassisId  (network:PhysEp:chassisId)
           The chassis ID of this endpoint
network:PortType
          scalar:Enum8 		ifType  (network:PhysEp:ifType)
           Overrides:network:IfEp:ifType
           NO COMMENTS
equipment:ChassisId
          scalar:Uint32 		peerChassisId  (network:PhysEp:peerChassisId)
           NO COMMENTS
equipment:Id
          scalar:Uint32 		peerPortId  (network:PhysEp:peerPortId)
           NO COMMENTS
equipment:Id
          scalar:Uint32 		peerSlotId  (network:PhysEp:peerSlotId)
           NO COMMENTS
equipment:PortId
          scalar:Uint32 		portId  (network:PhysEp:portId)
           The port ID of this endpoint
equipment:SlotId
          scalar:Uint32 		slotId  (network:PhysEp:slotId)
           The slot ID of this endpoint
network:SwitchId
          scalar:Enum8 		switchId  (network:PhysEp:switchId)
           The switch ID of this endpoint
Defined in: network:IfEp
network:PortRole
          scalar:Enum8 		ifRole  (network:IfEp:ifRole)
           NO COMMENTS
reference:Object peerDn  (network:IfEp:peerDn)
           NO COMMENTS
Defined in: network:Ep
reference:Object epDn  (network:Ep:epDn)
           cross-pointer to the other side of connection
Defined in: network:Conn
network:Locale
          scalar:Bitmask8 		locale  (network:Conn:locale)
           NO COMMENTS
network:Transport
          scalar:Bitmask8 		transport  (network:Conn:transport)
           The types of transport currently supported by this endpoint. This property is a bitmask, so multiple transports can be supported.
network:ConnectionType
          scalar:Bitmask8 		type  (network:Conn:type)
           NO COMMENTS
Defined in: naming:NamedObject
naming:Name
          string:Basic 		name  (naming:NamedObject:name)
           NO COMMENTS
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32 		childAction  (mo:TopProps:childAction)
          
reference:Object dn  (mo:TopProps:dn)
           The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />
reference:RN rn  (mo:TopProps:rn)
           The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />
mo:InstSaclType
          scalar:Bitmask8 		sacl  (mo:TopProps:sacl)
           The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
mo:ModificationStatus
          scalar:Bitmask32 		status  (mo:TopProps:status)
           This property controls the life cycle of a managed object
Properties Detail

adapterId

Type: equipment:Id
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

adminState

Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
enabled 0 NO COMMENTS
reset-connectivity 44 NO COMMENTS
DEFAULT enabled(0) NO COMMENTS

aggrPortId

Type: equipment:PortId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
The aggregate port ID of this endpoint. Port using break-out cable to split an aggregate port to multiple ports.

chassisId

Type: equipment:ChassisId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)255l

Comments:
The chassis ID of this endpoint
Constants
N/A 0u NO COMMENTS
DEFAULT 0 NO COMMENTS

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
Property Validators:

Comments:
Constants
deleteAll 16384u NO COMMENTS
ignore 4096u NO COMMENTS
deleteNonPresent 8192u NO COMMENTS
DEFAULT 0 This type is used to

discovery

Type: ether:SatelliteConnectionDisc
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
absent 0 NO COMMENTS
present 1 NO COMMENTS
mis-connect 2 NO COMMENTS
missing 3 NO COMMENTS
new 4 NO COMMENTS
un-initialized 5 NO COMMENTS
un-supported 6 NO COMMENTS
DEFAULT absent(0) NO COMMENTS

dn

Type: reference:Object
Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
Property Validators:

Comments:
The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />

epDn

Type: reference:Object
Refers: network:PIoEp
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
cross-pointer to the other side of connection

id

Type: equipment:Id
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

ifRole

Type: network:PortRole
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
network 1 NO COMMENTS
server 2 NO COMMENTS
mgmt 3 NO COMMENTS
diag 4 NO COMMENTS
storage 5 NO COMMENTS
monitor 6 NO COMMENTS
fcoe-storage 7 NO COMMENTS
nas-storage 8 NO COMMENTS
fcoe-nas-storage 9 NO COMMENTS
fcoe-uplink 10 NO COMMENTS
network-fcoe-uplink 11 NO COMMENTS
service 12 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

ifType

Type: network:PortType
Primitive Type: scalar:Enum8
Overrides:network:IfEp:ifType
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
physical 1 NO COMMENTS
aggregation 2 NO COMMENTS
virtual 3 NO COMMENTS
DEFAULT physical(1) NO COMMENTS

linkState

Type: adaptor:LinkState
Primitive Type: scalar:Enum8
Like: adaptor:LinkStateHolder:linkState
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
admin-down 1 NO COMMENTS
down 2 NO COMMENTS
error 3 NO COMMENTS
up 4 NO COMMENTS
unallocated 5 NO COMMENTS
unavailable 6 NO COMMENTS
offline 7 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

lldpMac

Type: address:MAC
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
In case of Lexington, the lldp MAC address is diferent from the MAC address and hence the lldp MAC has to be maintained sepraately as it is used to detect connectivity changes

locale

Type: network:Locale
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
server 1 NO COMMENTS
chassis 2 NO COMMENTS
internal 4 NO COMMENTS
external 8 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

mac

Type: address:MAC
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

name

Type: naming:Name
Primitive Type: string:Basic
Like: naming:Named:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

Comments:
NO COMMENTS

operState

Type: network:PortOperState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
indeterminate 0
up 1 This port is operationally up
admin-down 2 This port is down because it is administratively down.
link-down 3 The link is down
failed 4 NO COMMENTS
no-license 5 The port has no valid license
link-up 6 NO COMMENTS
hardware-failure 7 This port has a hardware failure
software-failure 8 This port has a software failure
error-disabled 9 NO COMMENTS
sfp-not-present 10 NO COMMENTS
udld-aggr-down 11 NO COMMENTS
down 12 NO COMMENTS
DEFAULT indeterminate(0)

operStateDesc

Type: string:Basic
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

Comments:
NO COMMENTS

peerAggrPortId

Type: equipment:PortId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

peerChassisId

Type: equipment:ChassisId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)255l

Comments:
NO COMMENTS
Constants
N/A 0u NO COMMENTS
DEFAULT 0 NO COMMENTS

peerDn

Type: reference:Object
Refers: network:PIoEp
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

peerPortId

Type: equipment:Id
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

peerSlotId

Type: equipment:Id
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

physEpDn

Type: reference:Object
Refers: port:PIo
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
points at the terminating ep under switche's server facing port TODO - This used to have a reference to port:SIo - should we have a ref to fabric:Locale instead??? points at the physical server facing port of the mux

portId

Type: equipment:PortId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
The port ID of this endpoint

purpose

Type: adaptor:Purpose
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unused 0 NO COMMENTS
general 1 Interprete "general" the same as "host data io"
management 2 NO COMMENTS
utility 3 NO COMMENTS
crosslink 4 NO COMMENTS
overlay 5 NO COMMENTS
DEFAULT general(1) Interprete "general" the same as "host data io"

rn

Type: reference:RN
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
Property Validators:

Comments:
The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />

sacl

Type: mo:InstSaclType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelSacl
Property Validators:

Comments:
The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
Constants
none 0 NO COMMENTS
del 1 NO COMMENTS
mod 2 NO COMMENTS
addchild 4 NO COMMENTS
cascade 8 NO COMMENTS
DEFAULT 0 NO COMMENTS

side

Type: network:Side
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
left 0 NO COMMENTS
right 1 NO COMMENTS
DEFAULT left(0) NO COMMENTS

slotId

Type: equipment:SlotId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
The slot ID of this endpoint

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
Property Validators:

Comments:
This property controls the life cycle of a managed object
Constants
removed 16u In a setter method: specifies that an object should be removed.
In the return value of a setter method: indicates that an object has been removed.
created 2u 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 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 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.

switchId

Type: network:SwitchId
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
The switch ID of this endpoint
Constants
NONE 0 NO COMMENTS
A 1 NO COMMENTS
B 2 NO COMMENTS
DEFAULT A(1) NO COMMENTS

transport

Type: network:Transport
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
The types of transport currently supported by this endpoint. This property is a bitmask, so multiple transports can be supported.
Constants
unknown 0 NO COMMENTS
ether 1 Transport is Ethernet
dce 2 Transport is Data Center Ethernet (DCE)
fc 4 Transport is Fibre Channel
DEFAULT unknown(0) NO COMMENTS

type

Type: network:ConnectionType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
lan 1 NO COMMENTS
san 2 NO COMMENTS
ipc 4 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS
Overview  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail