Overview  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class port:IntFIo (ABSTRACT)

Class ID:520
Encrypted: false - Exportable: false - Persistent: true
Privileges: []
SNMP OID:

Abstraction of a physical port on an IO Card.

Naming Rules 
RN FORMAT: port-[portId]

    [1] PREFIX=port- PROPERTY = portId




DN FORMAT: 

[0] sys/chassis-[id]/slot-[id]/[type]/port-[portId]

[1] sys/fex-[id]/slot-[id]/[type]/port-[portId]

[2] sys/chassis-[id]/shared-io-module/[type]/port-[portId]

[3] sys/chassis-[id]/slot-[id]/shared-io-module/[type]/port-[portId]

[4] sys/switch-[id]/slot-[id]/[type]/port-[portId]

[5] sys/chassis-[id]/sw-slot-[id]/[type]/port-[portId]


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
 
 		 
 		 
 		 
 		 
 		 ├
 		port:PhysSwitchIo Physical switch port superclass.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		port:IntFIo
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		port:ServerIntFIo
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		port:SwitchIntFIo Abstraction of a physical port on an IO Card. IO Modules on a UCS chassis and IO modules on a FEX have ports that are connected to a Fabric Interconnect and ports that are connected to the servers. Concrete subclasses are defined to model server-facing and switch-facing ports.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		ether:ServerIntFIo Represents a server-facing physical Ethernet port on an IO Card. IO Modules on a UCS chassis and IO modules on a FEX have Ethernet ports that are connected to a Fabric Interconnect and Ethernet ports that are connected to the servers. This object represents the Ethernet ports on the IO Card that are connected to the servers.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		ether:SwitchIntFIo Represents a switch-facing physical Ethernet port on an IO Card. IO Modules on a UCS chassis and IO modules on a FEX have Ethernet ports that are connected to a Fabric Interconnect and Ethernet ports that are connected to the servers. This object represents the Ethernet ports on the IO Card that are connected to the Fabric Interconnect.
Events


Faults


Fsms


Properties Summary
Defined in: port:IntFIo
equipment:PortId
          scalar:Uint32 		portId  (port:IntFIo:portId)
           Overrides:network:PhysEp:portId
           NO COMMENTS
Defined in: port:PhysSwitchIo
fabric:AdminState
          scalar:Enum8 		adminState  (port:PhysSwitchIo:adminState)
           NO COMMENTS
port:Encap
          scalar:Enum8 		encap  (port:PhysSwitchIo:encap)
           NO COMMENTS
reference:Object epDn  (port:PhysSwitchIo:epDn)
           Overrides:network:Ep:epDn
           NO COMMENTS
port:Mode
          scalar:Enum8 		mode  (port:PhysSwitchIo:mode)
           NO COMMENTS
equipment:Model
          string:Basic 		model  (port:PhysSwitchIo:model)
           NO COMMENTS
network:PortOperState
          scalar:Enum8 		operState  (port:PhysSwitchIo:operState)
           NO COMMENTS
equipment:Revision
          string:Basic 		revision  (port:PhysSwitchIo:revision)
           NO COMMENTS
equipment:Serial
          string:Basic 		serial  (port:PhysSwitchIo:serial)
           NO COMMENTS
port:StateQual
          string:Basic 		stateQual  (port:PhysSwitchIo:stateQual)
           NO COMMENTS
scalar:Date ts  (port:PhysSwitchIo:ts)
           NO COMMENTS
equipment:Vendor
          string:Basic 		vendor  (port:PhysSwitchIo:vendor)
           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: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: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

adminState

Type: fabric:AdminState
Primitive Type: scalar:Enum8
Like: port:Port:adminState
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
enabled 1 Indicates the administrative state is enabled. Set this value when you want to administratively enable an end-point. The system will enable the end-point and the operational state should transition to an "up" state. However, some pre-condition may prevent the operational state to be up, such as a misconfigured end-point, or external conditions such as a port not being physically connected.
disabled 2 Indicates the administrative state is disabled. Set this value when you want to administratively disable an end-point. The system will disable the end-point and the operational state will transition to a "down" state.
DEFAULT disabled(2) Indicates the administrative state is disabled. Set this value when you want to administratively disable an end-point. The system will disable the end-point and the operational state will transition to a "down" state.

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

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" />

encap

Type: port:Encap
Primitive Type: scalar:Enum8
Like: port:Port:encap
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
dot1q 1 NO COMMENTS
isl 2 NO COMMENTS
negotiate 3 NO COMMENTS
proprietary 4 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

epDn

Type: reference:Object
Refers: fabric:PIoEp
Overrides:network:Ep:epDn
Units: null
Encrypted: false
Access: implicit
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

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

mode

Type: port:Mode
Primitive Type: scalar:Enum8
Like: port:Port:mode
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
access 1 NO COMMENTS
trunk 2 NO COMMENTS
fabric 3 NO COMMENTS
n_proxy 4 NO COMMENTS
F 5 FC NP mode
E 6 FC F mode
SD 7 FC E mode
vntag 8 FC Span Destination Mode
promiscuousAccess 9 NO COMMENTS
promiscuousTrunk 10 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

model

Type: equipment:Model
Primitive Type: string:Basic
Like: equipment:Info:model
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

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
Like: port:Port:operState
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)

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

portId

Type: equipment:PortId
Primitive Type: scalar:Uint32
Overrides:network:PhysEp:portId
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

revision

Type: equipment:Revision
Primitive Type: string:Basic
Like: equipment:Info:revision
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

Comments:
NO COMMENTS
Constants
defaultValue "0" NO COMMENTS

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

serial

Type: equipment:Serial
Primitive Type: string:Basic
Like: equipment:Info:serial
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

Comments:
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

stateQual

Type: port:StateQual
Primitive Type: string:Basic
Like: port:Port:stateQual
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

Comments:
NO COMMENTS

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

ts

Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
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

vendor

Type: equipment:Vendor
Primitive Type: string:Basic
Like: equipment:Info:vendor
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

Comments:
NO COMMENTS
Overview  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail