Port Objects

This page contains descriptions of Port related objects in the FlexSwitch object models.

This set of objects are a part of the asicd objects model.

Attention

Attributes without default values listed are required in API calls.

Configuration Object

Port Objects

config/Port

Attribute Data
Type
Description Permitted Values
IntfRef [Key] string Front panel port name or system assigned interface id
IfIndex int32 System assigned interface id for this port. Read only attribute
Description string User provided string description DEFAULT: FP Port
PhyIntfType string Type of internal phy interface SELECTION: GMII/SGMII/
QSMII/SFI/XFI/
XAUI/XLAUI/RXAUI/
CR/CR2/CR4/KR/
KR2/KR4/SR/SR2/
SR4/SR10/LR/LR4
AdminState string Administrative state of this port SELECTION: UP/DOWN
DEFAULT:DOWN
MacAddr string Mac address associated with this port
Speed int32 Port speed in Mbps MIN: 10
MAX: 100000
Duplex string Duplex setting for this port SELECTION: Half_Duplex/Full_Duplex
DEFAULT:Full_Duplex
Autoneg string Autonegotiation setting for this port SELECTION: ON/OFF
DEFAULT: OFF
MediaType string Type of media inserted into this port
Mtu int32 Maximum transmission unit size for this port
BreakOutMode string Break out mode for the port.
Only applicable on ports that support breakout.
SELECTION: 1x100/1x40/
2x50/4x25/4x10
LoopbackMode string Desired loopback setting for this port SELECTION: NONE/MAC/PHY/RMT
DEFAULT: NONE
EnableFEC bool Enable/Disable 802.3bj FEC on this interface DEFAULT: false
PRBSTxEnable bool Enable/Disable generation of PRBS on this port DEFAULT: false
PRBSRxEnable bool Enable/Disable PRBS checker on this port DEFAULT: false
PRBSPolynomial string PRBS polynomial to use for generation/checking SELECTION: 2^7/2^23/
2^31
DEFAULT:2^7
StormControlProfile string Profile name corresponding to storm control profile to apply to this port DEFAULT: NONE
PcpToCosProfileRef string PCP to COS Profile Name DEFAULT: default
DscpToCosProfileRef string DSCP to COS Profile Name DEFAULT: default
SchedProfileRef string Port Scheduler Profile Name DEFAULT: default

State Objects

PortState

state/Port

Attribute Data
Type
Description Permitted Values
IntfRef [KEY] string Front panel port name or system assigned interface id
IfIndex int32 System assigned interface id for this port
Name string System assigned vlan name
OperState string Operational state of front panel port
NumUpEvents int32 Number of times the operational state transitioned from DOWN to UP
LastUpEventTime string Timestamp corresponding to the last DOWN to UP operational state change event
NumDownEvents int32 Number of times the operational state transitioned from UP to DOWN"`
LastDownEventTime string Timestamp corresponding to the last UP to DOWN operational state change event
Pvid int32 The vlanid assigned to untagged traffic ingressing this port
IfInOctets int64 RFC2233 Total number of octets received on this port
IfInUcastPkts int64 RFC2233 Total number of unicast packets received on this port
IfInDiscards int64 RFC2233 Total number of inbound packets that were discarded
IfInErrors int64 RFC2233 Total number of inbound packets that contained an error
IfInUnknownProtos int64 RFC2233 Total number of inbound packets discarded due to unknown protocol
IfOutOctets int64 RFC2233 Total number of octets transmitted on this port
IfOutUcastPkts int64 RFC2233 Total number of unicast packets transmitted on this port
IfOutDiscards int64 RFC2233 Total number of error free packets discarded and not transmitted
IfOutErrors int64 RFC2233 Total number of packets discarded and not transmitted due to packet errors
IfEtherUnderSizePktCnt int64 RFC 1757 Total numbe of undersized packets received and transmitted
IfEtherOverSizePktCnt int64 RFC 1757 Total number of oversized packets received and transmitted
IfEtherFragments int64 RFC1757 Total number of ethernet fragments received and transmitted
IfEtherCRCAlignError int64 RFC 1757 Total number of CRC alignment errors
IfEtherJabber int64 RFC 1757 Total number of jabber frames received and transmitted
IfEtherPkts int64 RFC 1757 Total number of ethernet packets received and transmitted
IfEtherMCPkts int64 RFC 1757 Total number of multicast packets received and transmitted
IfEtherBcastPkts int64 RFC 1757 Total number of ethernet broadcast packets received and transmitted
IfEtherPkts64OrLessOctets int64 RFC1757 Total number of ethernet packets sized 64 bytes or lesser
IfEtherPkts65To127Octets int64 RFC 1757 Total number of ethernet packets sized between 65 and 127 byte
IfEtherPkts128To255Octets int64 RFC 1757 Total number of ethernet packets sized between 128 and 255 bytes
IfEtherPkts256To511Octets int64 RFC 1757 Total number of ethernet packets sized between 256 and 511 bytes
IfEtherPkts512To1023Octets int64 RFC 1757 Total number of ethernet packets sized between 512 and 1023 bytes
IfEtherPkts1024To1518Octets int64 RFC 1757 Total number of ethernet packets sized between 1024 and 1518 bytes
ErrDisableReason string Reason explaining why port has been disabled by protocol code
PresentInHW string Indication of whether this port object maps to a physical port. Set to 'No' for ports that are not broken out.
ConfigMode string The current mode of configuration on this port (L2/L3/Internal)
PRBSRxErrCnt int64 Receive error count reported by PRBS checker
PcpToCosProfileRef string PCP to COS Profile Name
DscpToCosProfileRef string DSCP to COS Profile Name
SchedProfileRef string Port Scheduler Profile Name
OperSpeed int32 Operational Port speed in Mbps
OperDuplex string Operational Duplex setting for this port