equipment
Port



public abstract class Port

Stats:
service.AccessEgressOctets service.AccessEgressPackets service.AccessPortEgressOctets service.AccessPortEgressPackets service.CombinedAccessEgressOctets service.CombinedAccessEgressPackets service.CombinedAccessPortEgressPacketsOctets service.CombinedNetworkEgressOctets service.CombinedNetworkEgressPackets service.CombinedNetworkEgressPacketsOctets service.CombinedNetworkIngressOctets service.CombinedNetworkIngressPackets service.CombinedPortAccessIngressOctets service.CombinedPortAccessIngressPackets service.CompleteNetworkEgressPacketOctets service.CompleteNetworkIngressPacketOctets service.CompletePortAccessEgressOctets service.CompletePortAccessEgressPackets service.CompletePortAccessIngressOctets service.CompletePortAccessIngressPackets service.NetworkEgressOctets service.NetworkEgressPackets service.NetworkIngressOctets service.NetworkIngressPackets service.PortAccessIngressOctets service.PortAccessIngressPackets

Properties
accessuplink.EgressQueueStatsConfig-Set type=Children-Set
accountingPolicyCapable

type=boolean
access=read-only
default=false

accountingPolicyId

type=long
access=read-only
default=0

accountingPolicyName

type=string
access=read-only
default=
maximum=80

accountingPolicyObjectPointer

type=Pointer
default=
Displayed(tab/group)=Accounting Policy (Policies.General/Accounting)

actualSpeed

type=long
access=read-only
default=0
units=kbps
Displayed(tab/group)=Actual Speed

collectStats

type=boolean
default=true
Displayed(tab/group)=Collect Accounting Statistics (Policies.General/Accounting)

currentNumberOfChannels

type=int
access=read-only
default=0

description

type=string
default=
minimum=0
maximum=256
Displayed(tab/group)=Description

encapType

type=equipment.PortEncapType
default=nullEncap
Displayed(tab/group)=Encapsulation Type

equipment.PortEgrHsmdaSchedulerOverride-Set type=Children-Set
equipment.PortSchedulerOverride-Set type=Children-Set
ethAccessAccountingPolicyObjectPointer The value of ethAccessAccountingPolicyObjectPointer specifies the TIMETRA-LOG-MIB::tmnxLogApPolicyId that identifies the policy entry in TIMETRA-LOG-MIB::tmnxLogApTable which is associated with this ethernet access port queue for the purpose of collecting physical layer ethernet access port queue statistics.

type=Pointer
default=
Displayed(tab/group)=Access Accounting Policy (Policies.General/Ethernet Access Accounting)

ethAccessCollectStats The value of ethAccessCollectStats specifies whether or not the collection of physical layer ethernet accounting and statistical data for the ethernet access port queue is enabled

type=boolean
default=false
Displayed(tab/group)=Collect Access Accounting Statistics (Policies.General/Ethernet Access Accounting)

etherAccountingPolicyObjectPointer

type=Pointer
default=
Displayed(tab/group)=Accounting Policy (Policies.General/Ethernet Accounting)

etherCollectStats

type=boolean
default=false
Displayed(tab/group)=Collect Accounting Statistics (Policies.General/Ethernet Accounting)

hasConnections Indicates the existence of services on an AccessInterface or a Network Interface. This property is also set to true in case of management ports.

type=boolean
access=read-only
default=false

hasUserAssignedMac

type=boolean
access=read-only
default=false

holdTimeDown

type=int
default=0
minimum=0
maximum=36000
units=seconds
Displayed(tab/group)=Hold Time Down (/Hold Time)

holdTimeUnits

type=equipment.HoldTimeUnitsType
default=0
Displayed(tab/group)=Hold Time Units (/Hold Time)

holdTimeUp

type=int
default=0
minimum=0
maximum=36000
units=seconds
Displayed(tab/group)=Hold Time Up (/Hold Time)

hwMacAddress

type=MacAddress
access=read-only
default=00-00-00-00-00-00
Displayed(tab/group)=Hardware MAC

intervalNumber Stats interval number to retrieve when doing a manual resync.

type=int
access=read-only
default=1

iomType

type=equipment.CardType
access=read-only
default=unassigned

isConnectionTerminated

type=boolean
access=read-only
default=false

isLinkUp Indicates whether or not the port has a physical link.

type=boolean
access=read-only
default=false
Displayed(tab/group)=Link Up (States)

isPortChannelALeaf

type=generic.TruthValue
access=read-only
default=false

isTerminatable

type=boolean
access=read-only
default=false

isl2UplinkMode

type=boolean
default=false
Displayed(tab/group)=L2Uplink

l2ProfilePointer Pointer to the L2 Profile Policy object.

type=Pointer
default=
Displayed(tab/group)=L2 Profile (Policies.General/L2 Profile)

linkTrap

type=int
default=disable
Displayed(tab/group)=Link Trap
enums=
    1: enable - Enabled
    2: disable - Disabled

loadBalanceAlgorithm Specifies the load balancing algorithm to be used on this port.

type=equipment.PortLoadBalanceAlgorithm
default=notApplicable
Displayed(tab/group)=Load Balance Algorithm

macAddress

type=MacAddress
default=00-00-00-00-00-00
Displayed(tab/group)=Configured MAC

memberOfIGH ECMP fate sharing group membership

type=Pointer
access=read-only
default=
Displayed(tab/group)=Holding IGH (/IGH Membership)

mirrorStatus

type=mirror.MirrorStatusBit
access=read-only
default=disabled

mode

type=equipment.PortMode
default=undefined
Displayed(tab/group)=Mode

mpr.FlowEntry-Set type=Children-Set
mpr.PwAtmLayer-Set type=Children-Set
mpr.VlanPort-Set type=Children-Set
mptCombiner Enable/Disable Combiner(SD)function on MPT.

type=long
access=read-only
default=disable
Displayed(tab/group)=Combiner (/Port Usage)
enums=
    2: enable - Enabled
    1: disable - Disabled

mptCombinerImplemented TRUE/FALSE based on MPT provision

type=long
default=false
enums=
    1: true - True
    2: false - False

mptSubrackPointer specifies where the MPT is connected to on the subrack

type=Pointer
access=read-only
Displayed(tab/group)=Subrack Connection (/Port Usage)

mtuValue

type=int
default=0
units=bytes
Displayed(tab/group)=MTU

neSpecificMtu The MTU of the port as reported by the network element. Various vendors may configure the MTU differently. For example on Cisco IOS/IOS-XE the port MTU is configured as protocol MTU, it means that MTU 1500 can fit a protocol payload of 1500 bytes. Whereas on Cisco IOS-XR to fit 1500 bytes of payload data the MTU must be configured as 1514. This attribute is read-only and its purpose is to indicate the NE specific MTU value that may be used for troubleshooting. The normalized MTU value for the port is specified by the mtuValue property.

type=int
access=read-only
default=0
units=bytes
Displayed(tab/group)=NE Actual MTU

networkQueueObjectPointer

type=Pointer
default=

networkQueuePolicyCapable

type=boolean
access=read-only
default=false

networkQueuePolicyName

type=string
access=read-only
default=default
minimum=1
maximum=32
Displayed(tab/group)=Network Queue Policy Name (Policies.General/Network Queue)

numberOfPossibleChannels

type=long
access=read-only
default=0

operationalMTU

type=int
access=read-only
default=0
units=bytes
Displayed(tab/group)=Operational MTU

parentSnmpPortId

type=long
access=read-only
default=0

portBreakout

type=int
default=disable
Displayed(tab/group)=Port breakout
enums=
    1: enable - Enabled
    2: disable - Disabled

portCategory

type=equipment.PortCategory
access=read-only
default=unknown

portClass

type=equipment.PortClass
access=read-only
default=none
Displayed(tab/group)=Class

portEgrHsmdaSchedulerPolicy Specifies the hsmda scheduler policy used by this port

type=Pointer
default=
Displayed(tab/group)=HSMDA Egress Scheduler Policy (Policies.General/HSMDA Scheduler)

portEgrNamedPoolPlcy

type=Pointer
default=

portEgrPoolPercentageRate

type=int
default=100
minimum=0
maximum=1000
units=%

portHoldTimeDownRemaining

type=int
access=read-only
default=0
units=centiseconds
Displayed(tab/group)=Hold Time Down Remaining (/Hold Time)

portHoldTimeUpRemaining

type=int
access=read-only
default=0
units=centiseconds
Displayed(tab/group)=Hold Time Up Remaining (/Hold Time)

portId

type=long
access=read-create
default=0

portIngrNamedPoolPlcy

type=Pointer
default=

portIngrPoolPercentageRate

type=int
default=100
minimum=0
maximum=1000
units=%

portName

type=string
access=read-only
default=
maximum=252
Displayed(tab/group)=CLI Name

portRsFecOperMode The value of portRsFecOperMode indicates the mode of Reed-Solomon Forward Error Correction (RS-FEC) in use on this port. When the value of portRsFecOperMode is set to 'none', the port is transmiting and receiving using standard 64B/66B encoding.

type=equipment.RsFecMode
access=read-only
default=0

portSchedulerPolicyObjectPointer Specifies the port scheduler policy used by this port

type=Pointer
default=
Displayed(tab/group)=Port Scheduler Policy (Policies.General/Port Scheduler)

portStateFPNumber The value of portStateFPNumber indicates the forwarding plane number for this port.

type=int
access=read-only
default=0

portStateLicensed The value of portStateLicensed indicates whether this port is licensed for the current licensed level of the assigned MDA. A value of 'true' indicates this port is licensed and can be used in service configuration. A value of 'false' indicates that the port is unlicensed and may not be used.

type=boolean
access=read-only
default=false

portStateMacChipNumber The value of portStateMacChipNumber indicates the MAC chip number for this port.

type=int
access=read-only
default=0

portUsage

type=int
access=read-only
default=0
Displayed(tab/group)=Port Usage (/Port Usage)
enums=
    0: empty - EMPTY
    1: mpthl - MPT-HL
    2: sfp - SFP
    3: mptmc - MPT-MC
    4: mpthc - MPT-HC
    5: sfpo - SFP-O
    6: sfpe - SFP-E
    7: mpthls - MPT-HLS
    8: mpthlc - MPT-HLC
    9: mpthqam - MPT-HQAM
    10: syncio - SYNC-IO
    11: todio - TOD-IO
    12: csfp - C-SFP
    13: ubtt - UBT-T
    14: ubt80 - UBT-m_80GHz
    15: ubts - UBT-S
    16: ubtc - UBT-C
    17: sfpcpl - SFP-CPL
    18: ubti - UBT-I
    19: ubttxp - UBT-T XP

portUsageType

type=int
access=read-only
default=0
enums=
    0: none - None
    1: electrical - Electrical
    2: optical - Optical
    3: hybridelectrical - Hybrid-Electrical
    4: hybridoptical - Hybrid-Optical

previousState

type=equipment.PortState
access=read-only
default=1
Displayed(tab/group)=Previous State (States)

radioequipment.RadioPortSpecifics-Set type=Children-Set
snmpPortId

type=long
access=read-only
default=0
Displayed(tab/group)=Interface ID

specificCardType

type=equipment.CardType
access=read-only
default=mda_unknown

specificType

type=equipment.PortType
access=read-only
default=unknownPort

speed

type=equipment.Speed
default=0
units=Mbps
Displayed(tab/group)=Speed

state Indicates the state of the port none state indicates the port is either in its initial creation state or in deletion. ghost state indicates a port that is not physically present. linkDown state indicates a port that is physically present but does not have a link. linkUp state indicates a port that is physically present and has physical link present. up state is ready to pass some kinds of traffic.

type=equipment.PortState
access=read-only
default=1
Displayed(tab/group)=State (States)

ubtListBits

type=equipment.MPR_TypeList
access=read-only
Displayed(tab/group)=UBT-bits (/UBT Attributes)

ubtSpeed

type=equipment.UbtSpeedType
access=read-only
default=oneGbps
Displayed(tab/group)=UBT-Speed (/UBT Attributes)

uniProfilePointer Pointer to the UNI Profile Policy object.

type=Pointer
default=
Displayed(tab/group)=UNI Profile (Policies.General/UNI Profile)

unpPortType Configures UNP functionality for the specified port

type=unpprofile.UNPPortType
default=none
Displayed(tab/group)=UNP Port Type (Policies.General/UNP Port)

upProtocols

type=equipment.PortProtocols
access=read-only
default=0

userLabel

type=string
maximum=20
Displayed(tab/group)=User label

vlanAutoBind

type=boolean
default=true
Displayed(tab/group)=Automatic VLAN Binding

vwm.OtdrSpecifics-Set type=Children-Set
 
Overridden Properties
displayedName

 
Properties inherited from equipment.Equipment
administrativeState, backgroundDiagnosticsFaultReason, backgroundDiagnosticsState, baseMacAddress, cleiCode, compositeEquipmentState, containingEquipmentState, displayedName, equipmentCategory, equipmentState, hardwareClass, hardwareFailureReason, hwFirmwareRevisionStatus, hwIndex, hwName, isEquipmentInserted, isEquipped, isTempSensorAvailable, lockOlcState, manufactureDate, manufacturer, manufacturerBoardNumber, manufacturingAssemblyNo, manufacturingDeviations, manufacturingVariant, oesShelfId, olcState, operationalState, phyShelfClass, phyShelfType, serialNumber, shelfId, siteId, siteName
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

getMigrationResult

Method to migrate port from Access to Hybrid mode.
Input Parameters:
distinguishedName : Pointer - Distinguished Name of Port/LAG to be migrated.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
migrationResult : equipment.HybridMigrationResultStruct -
Exceptions:
equipment.Port.getMigrationResultException

migrateMode

Method is used to migrate mode of an port (i.e copying existing Access and Network Interface during Port Mode Change) Currently only access to hybrid port migration is supported
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
distinguishedName : Pointer - Distinguished Name of Port/LAG to be migrated.
portMode : equipment.PortMode - Desired Mode value
configInfo : generic.CommonManagedContainmentEntityConfigurationInformation - (Optional) Desired values to configure Port/LAG during migration.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
equipment.Port.migrateModeException
Methods inherited from equipment.Equipment
getDependencyCount
 
Supported Network Elements
7450 ESS
7210 SAS M
7210 SAS X
7210 SAS E
7210 SAS D
7210 SAS K
7210 SAS T
7210 SAS Mxp
7210 SAS Dxp
7210 SAS S/Sx
7210 SAS R
7250 IXR
7750 SR
7705 SAR Gen 2
7705 SAR Hm
1830 VWM OSU
7705 SAR
7705 SAR H
7701 CPAA
OS6850/6850E
OS6855
OS6400
Wavence SM
OS6250
OS6450
OS6350
OS9700E/9800E
OS6900
OS6860E/OS6860N
OS6870
OS6865
OS6560/OS6560E
OS6570M
OS6465
OS6360
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Wavence SA
Generic NE
Product Specifics
1830 VWM OSU 8.2
1830 VWM OSU 8.3
1830 VWM OSU 8.4
1830 VWM OSU 8.5
1830 VWM OSU 9.0
7210 SAS D 20.0.0
7210 SAS D 21.0.0
7210 SAS D 22.0.0
7210 SAS D 23.0.0
7210 SAS D 24.0.0
7210 SAS D 25.0.0
7210 SAS Dxp 20.0
7210 SAS Dxp 21.0
7210 SAS Dxp 22.0
7210 SAS Dxp 23.0
7210 SAS Dxp 24.0
7210 SAS Dxp 25.0
7210 SAS K 20.0
7210 SAS K 21.0
7210 SAS K 22.0
7210 SAS K 23.0
7210 SAS K 24.0
7210 SAS K 25.0
7210 SAS M 20.0
7210 SAS M 21.0
7210 SAS Mxp 20.0
7210 SAS Mxp 21.0
7210 SAS Mxp 22.0
7210 SAS Mxp 23.0
7210 SAS Mxp 24.0
7210 SAS Mxp 25.0
7210 SAS R 20.0
7210 SAS R 21.0
7210 SAS R 22.0
7210 SAS R 23.0
7210 SAS R 24.0
7210 SAS R 25.0
7210 SAS S/Sx 20.0
7210 SAS S/Sx 21.0
7210 SAS S/Sx 22.0
7210 SAS S/Sx 23.0
7210 SAS S/Sx 24.0
7210 SAS S/Sx 25.0
7210 SAS T 20.0
7210 SAS T 21.0
7210 SAS T 22.0
7210 SAS T 23.0
7210 SAS T 24.0
7210 SAS T 25.0
7250 IXR 20.0
7250 IXR 21.0
7250 IXR 22.0
7250 IXR 23.0
7250 IXR 24.0
7250 IXR 25.0
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7701 CPAA 8.0
7705 SAR Gen 2 25.0
7705 SAR H 20.0
7705 SAR H 21.0
7705 SAR H 22.0
7705 SAR H 23.0
7705 SAR H 24.0
7705 SAR H 25.0
7705 SAR H 9.0
7705 SAR Hm 20.0
7705 SAR Hm 21.0
7705 SAR Hm 22.0
7705 SAR Hm 23.0
7705 SAR Hm 24.0
7705 SAR Hm 25.0
7705 SAR 20.0
7705 SAR 21.0
7705 SAR 22.0
7705 SAR 23.0
7705 SAR 24.0
7705 SAR 25.0
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0
7950 XRS 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0
DC 210 20.5
DC 210 5.0
DC 210 6.0
DC 7850 20.0
DC 7850 5.0
DC 7850 6.0
DC VSA8 5.0
DC VSA8 6.0
DC VSC 20.0
DC VSC 5.0
DC VSC 6.0
Generic NE 1.0.0
OS6250 6.6.3
OS6250 6.6.4
OS6250 6.6.5
OS6250 6.7.1
OS6350 6.7.2
OS6360 8.10
OS6360 8.10
OS6360 8.9
OS6360 8.9
OS6400 6.4.3
OS6400 6.4.4
OS6400 6.4.5
OS6450 6.6.4
OS6450 6.6.5
OS6450 6.7.1
OS6450 6.7.2
OS6465 8.10
OS6465 8.10
OS6465 8.6
OS6465 8.7
OS6465 8.8
OS6465 8.8
OS6465 8.9
OS6465 8.9
OS6465 8.9
OS6560/OS6560E 8.10
OS6560/OS6560E 8.10
OS6560/OS6560E 8.6
OS6560/OS6560E 8.7
OS6560/OS6560E 8.8
OS6560/OS6560E 8.8
OS6560/OS6560E 8.9
OS6560/OS6560E 8.9
OS6560/OS6560E 8.9
OS6570M 8.10
OS6570M 8.10
OS6570M 8.9
OS6850/6850E 6.4.2
OS6850/6850E 6.4.3
OS6850/6850E 6.4.4
OS6850/6850E 6.4.5
OS6850/6850E 6.4.6
OS6855 6.4.4
OS6855 6.4.5
OS6855 6.4.6
OS6860E/OS6860N 8.10
OS6860E/OS6860N 8.10
OS6860E/OS6860N 8.6
OS6860E/OS6860N 8.7
OS6860E/OS6860N 8.8
OS6860E/OS6860N 8.8
OS6860E/OS6860N 8.9
OS6860E/OS6860N 8.9
OS6860E/OS6860N 8.9
OS6865 8.10
OS6865 8.10
OS6865 8.6
OS6865 8.7
OS6865 8.8
OS6865 8.8
OS6865 8.9
OS6865 8.9
OS6865 8.9
OS6870 8.10
OS6900 8.10
OS6900 8.10
OS6900 8.6
OS6900 8.7
OS6900 8.8
OS6900 8.8
OS6900 8.9
OS6900 8.9
OS6900 8.9
OS9700E/9800E 6.4.3
OS9700E/9800E 6.4.4
OS9700E/9800E 6.4.5
OS9700E/9800E 6.4.6
Wavence SA 19A.0.0
Wavence SA 20A.0.0
Wavence SA 22.0.0
Wavence SA 22A.0.0
Wavence SA 23.0.0
Wavence SA 23A.0.0
Wavence SA 24.0.0
Wavence SA 25.0.0
Wavence SM 19A.0.0
Wavence SM 20A.0.0
Wavence SM 21A.0.0
Wavence SM 22.0.0
Wavence SM 22A.0.0
Wavence SM 23.0.0
Wavence SM 23A.0.0
Wavence SM 24.0.0
Wavence SM 25.0.0