equipment
PhysicalPort



public class PhysicalPort

Stats:
cellularequipment.CBSDAuthorizationStats cellularequipment.CellularPortStats equipment.AccessPortControlStats equipment.DetailedPacketDiscardStats equipment.GponPortSpecificsStats equipment.IngressPortFwdEngDropReasonStats equipment.InterfaceAdditionalStats equipment.InterfaceStats equipment.MediaIndependentStats equipment.NetworkPortControlStats equipment.NetworkPortEgressControlStats equipment.NetworkPortIngressControlStats equipment.NgeL2PortStats equipment.PerPortThresholdStats equipment.PortAccessEgressQueueStats equipment.PortAccessIngressStats equipment.PortEgrVoqStats equipment.PortEgressAggregateStats equipment.PortEgressMonitorThresholdStats equipment.PortHealthStats equipment.PortNetEgressQueueStats equipment.PortNetEgressStats equipment.PortNetIngressStats equipment.PortNetRingAddDropStats equipment.PortSchedulerTrafficStats equipment.PortStats equipment.QosPortQueueStats equipment.ShDslLineStats equipment.SubscrHostEquipPortStats equipment.UplinkPortNetIngressStats equipment.XDslLineStats ethernetequipment.AdditionalEthernetStats ethernetequipment.AggrMaintRxStats ethernetequipment.AggrMaintTxStats ethernetequipment.AggrRxHistoryDataStats ethernetequipment.AggrRxHistoryDataStats15m ethernetequipment.AggrRxHistoryDataStats24Hr ethernetequipment.AggrTxHistoryDataStats ethernetequipment.AggrTxHistoryDataStats15m ethernetequipment.AggrTxHistoryDataStats24Hr ethernetequipment.CohOptPortStats ethernetequipment.Dot3Stats ethernetequipment.EthernetDampeningStats ethernetequipment.EthernetHighCapacityStats ethernetequipment.EthernetStats ethernetequipment.OtuIfStats ethernetequipment.PortPoEStats ethernetequipment.QosDroppedOctetStats ethernetequipment.QosDroppedPacketStats ethernetequipment.SatellitePortQueueStat layer2.EServiceNNIportL2ProtocolStats layer2.EServiceUNIportL2ProtocolStats mpr.MprRSLTSLStats mpr.MptStats pae802_1x.PaePortAuthenticatorDiagStats pae802_1x.PaePortAuthenticatorSessionStats pae802_1x.PaePortAuthenticatorStats ptp.EsmPtpStats radioequipment.AdaptiveModulationCurrentDataStats radioequipment.AdaptiveModulationCurrentDataStats15Min radioequipment.AdaptiveModulationCurrentDataStats24Hr radioequipment.AdaptiveModulationHistoryDataStats radioequipment.AdaptiveModulationHistoryDataStats15Min radioequipment.AdaptiveModulationHistoryDataStats24Hr radioequipment.AggrPerQueueMaintStats radioequipment.PdhFrameHopCurrentDataStats radioequipment.PdhFrameHopCurrentDataStats15Min radioequipment.PdhFrameHopCurrentDataStats24Hr radioequipment.PdhFrameHopHistoryDataStats radioequipment.PdhFrameHopHistoryDataStats15Min radioequipment.PdhFrameHopHistoryDataStats24Hr radioequipment.PdhFrameLinkCurrentDataStats radioequipment.PdhFrameLinkCurrentDataStats15Min radioequipment.PdhFrameLinkCurrentDataStats24Hr radioequipment.PdhFrameLinkHistoryDataStats radioequipment.PdhFrameLinkHistoryDataStats15Min radioequipment.PdhFrameLinkHistoryDataStats24Hr radioequipment.PeakAndAverageCurrentDataStats radioequipment.PeakAndAverageCurrentDataStats15Min radioequipment.PeakAndAverageCurrentDataStats24Hr radioequipment.PeakAndAverageHistoryDataStats radioequipment.PeakAndAverageHistoryDataStats15Min radioequipment.PeakAndAverageHistoryDataStats24Hr radioequipment.RSLDivHopCurrentDataStats radioequipment.RSLDivHopCurrentDataStats15Min radioequipment.RSLDivHopCurrentDataStats24Hr radioequipment.RSLDivHopHistoryDataStats radioequipment.RSLDivHopHistoryDataStats15Min radioequipment.RSLDivHopHistoryDataStats24Hr radioequipment.RSLDivLinkCurrentDataStats radioequipment.RSLDivLinkCurrentDataStats15Min radioequipment.RSLDivLinkCurrentDataStats24Hr radioequipment.RSLDivLinkHistoryDataStats radioequipment.RSLDivLinkHistoryDataStats15Min radioequipment.RSLDivLinkHistoryDataStats24Hr radioequipment.RSLHopCurrentDataStats radioequipment.RSLHopCurrentDataStats15Min radioequipment.RSLHopCurrentDataStats24Hr radioequipment.RSLHopHistoryDataStats radioequipment.RSLHopHistoryDataStats15Min radioequipment.RSLHopHistoryDataStats24Hr radioequipment.RSLLinkCurrentDataStats radioequipment.RSLLinkCurrentDataStats15Min radioequipment.RSLLinkCurrentDataStats24Hr radioequipment.RSLLinkHistoryDataStats radioequipment.RSLLinkHistoryDataStats15Min radioequipment.RSLLinkHistoryDataStats24Hr radioequipment.RadioAnalogueMeasure radioequipment.TSLHopCurrentDataStats radioequipment.TSLHopCurrentDataStats15Min radioequipment.TSLHopCurrentDataStats24Hr radioequipment.TSLHopHistoryDataStats radioequipment.TSLHopHistoryDataStats15Min radioequipment.TSLHopHistoryDataStats24Hr sonetequipment.SDHCurrentStats sonetequipment.SDHCurrentStats15MinOut sonetequipment.SDHCurrentStats15minIn sonetequipment.SDHCurrentStats24HrIn sonetequipment.SDHCurrentStats24HrOut sonetequipment.SDHhistoryStats sonetequipment.SDHhistoryStats15minIn sonetequipment.SDHhistoryStats15minOut sonetequipment.SDHhistoryStats24HrIn sonetequipment.SDHhistoryStats24HrOut sonetequipment.SonetFarEndLineCurrentStats sonetequipment.SonetFarEndLineIntervalStats sonetequipment.SonetLineCurrentStats sonetequipment.SonetLineIntervalStats sonetequipment.SonetSectionCurrentStats sonetequipment.SonetSectionIntervalStats tdmequipment.SerialSocketStats vwm.DdmDataMibStats vwm.IfEthFecHistoryStats vwm.IfEthHistoryStats vwm.IfOptHistoryStats vwm.IfPcsHistoryStats

Properties
accessAvailableBW Indicates the access bandwidth that is still free for booking on this port.

type=long
access=read-only
default=0
units=kbps
Displayed(tab/group)=Available BW (/Access Bandwidth)

accessBandwidth Specifies the administrative access bandwidth assigned to this port.

type=long
default=0
minimum=0
maximum=6400000000
units=kbps
Displayed(tab/group)=Bandwidth (/Access Bandwidth)

accessBookedBW Indicates the port access bandwidth that has been booked.

type=long
access=read-only
default=0
units=Percentage
Displayed(tab/group)=Booked BW (/Access Bandwidth)

accessBookingFactor Specifies the booking factor, applied as a percentage, against the administrative access bandwidth

type=long
default=100
minimum=1
maximum=1000
units=Percentage
Displayed(tab/group)=Booking Factor (/Access Bandwidth)

accessuplink.AccessUplinkSpecifics-Set type=Children-Set
additionalOperState

type=equipment.OperationalState
access=read-only
default=portUnknown
Displayed(tab/group)=Additional Operational State (States)

aosqos.AdvancedLoopback-Set type=Children-Set
aosqos.QoSPort-Set type=Children-Set
cardSlotId

type=long
access=read-only
default=0

cardSubType

type=equipment.CardSubType
access=read-only
default=unspecified

cellularequipment.CBSDAuthorization-Set type=Children-Set
cellularequipment.CellularPdnProfile-Set type=Children-Set
cellularequipment.CellularPortBearer-Set type=Children-Set
cellularequipment.CellularPortSpecifics-Set type=Children-Set
cellularequipment.SimCard-Set type=Children-Set
clear.ClearRequest-Set type=Children-Set
connectorId

type=long
access=read-only
default=0

customProperties This is used for any custom properties for this object.

type=Map (string to string)

daughterCardSlotId

type=long
access=read-only
default=0

dctr.DCPortSpecifics-Set type=Children-Set
ddmEventSuppression

type=boolean
default=false
Displayed(tab/group)=DDM Event Suppression

dwdmChannel

type=int
default=0
Displayed(tab/group)=Channel (/DWDM)

egressAccessWeight

type=int
default=50
minimum=0
maximum=100
Displayed(tab/group)=Access Weight (/Hybrid Egress Buffer Allocation)

egressNetworkWeight

type=int
default=50
minimum=0
maximum=100
Displayed(tab/group)=Network Weight (/Hybrid Egress Buffer Allocation)

enableDei Specifies whether or not the port is enabled for color-aware policing using DEI bits.

type=boolean
default=false
Displayed(tab/group)=Enable DEI (/Enable DEI)

enablePTPHardwareTimestamp Specifies whether hardware time-stamping of ingress and egress PTP packets is enabled or disabled for the port. When the check box is selected, hardware timestamping is enabled.

type=boolean
default=true
Displayed(tab/group)=Enable PTP Hardware Timestamp (/PTP)

equipment.DigitalDiagnosticMonitoring-Set type=Children-Set
equipment.DslPortSpecifics-Set type=Children-Set
equipment.EgrSchVirtualPort-Set type=Children-Set
equipment.GponPortSpecifics-Set type=Children-Set
equipment.GpsPortSpecifics-Set type=Children-Set
equipment.LaneDDM-Set type=Children-Set
equipment.LogicalUnit-Set type=Children-Set
equipment.MediaAdaptor-Set type=Children-Set
equipment.MediaPortAdaptor-Set type=Children-Set
equipment.ShdslLine-Set type=Children-Set
equipment.XdslLine-Set type=Children-Set
ethernetequipment.AccessEgrQGroup-Set type=Children-Set
ethernetequipment.AccessIngrQGroup-Set type=Children-Set
ethernetequipment.CoherentOpticalCfg-Set type=Children-Set
ethernetequipment.Dot3Oam-Set type=Children-Set
ethernetequipment.Dot3OamSdEventLogEntry-Set type=Children-Set
ethernetequipment.Dot3OamSfEventLogEntry-Set type=Children-Set
ethernetequipment.EgressHsSchedulerOverrides-Set type=Children-Set
ethernetequipment.EgressHsSecondaryShaper-Set type=Children-Set
ethernetequipment.EthVirtualConnection-Set type=Children-Set
ethernetequipment.EthernetPortHybridSpecifics-Set type=Children-Set
ethernetequipment.EthernetPortSpecifics-Set type=Children-Set
ethernetequipment.EthernetStormControl-Set type=Children-Set
ethernetequipment.HsmdaEgressSecondaryShaper-Set type=Children-Set
ethernetequipment.NetworkEgrQGroup-Set type=Children-Set
ethernetequipment.OtuInterface-Set type=Children-Set
ethernetequipment.PoEPort-Set type=Children-Set
ethernetequipment.PortAccessEgrQOverride-Set type=Children-Set
ethernetequipment.PortDwdmConfig-Set type=Children-Set
ethernetequipment.WaveLengthTable-Set type=Children-Set
ethernetequipment.WaveLengthTracker-Set type=Children-Set
farEndPort Indicates which other port is connected to this port (SR port and a port of an external shelf like Optical Extension Shelf/Satellite or vice-versa).

type=Pointer
access=read-only
default=
Displayed(tab/group)=FarEnd Connected Port

flexGroupId

type=int
access=read-only
default=0

flexMemberId

type=int
access=read-only
default=0

hasTransitSAP This property indicates whether the port is associated with Transit SAP.

type=boolean
access=read-only
default=false

hsPortPoolPointer

type=Pointer
default=hsPortPoolPolicy:hsprtpl-default
Displayed(tab/group)=HS Port Pool Policy (/HSQ)

hsSchedulerPointer

type=Pointer
default=HsSchedulerPolicy:hsSched-default
Displayed(tab/group)=HS Scheduler Policy (/HSQ)

ifName Specifies the name of network interface configured on this port. Applicable to Dragonwave FlexiPacket Hub 800.

type=string
access=read-create
Mandatory on create

ingressAccessWeight

type=int
default=50
minimum=0
maximum=100
Displayed(tab/group)=Access Weight (/Hybrid Ingress Buffer Allocation)

ingressNetworkWeight

type=int
default=50
minimum=0
maximum=100
Displayed(tab/group)=Network Weight (/Hybrid Ingress Buffer Allocation)

isApsProtected

type=boolean
access=read-only
default=false

isConnectorPort

type=boolean
access=read-only
default=false

isDecommissioned

type=boolean
access=read-only
default=false
Displayed(tab/group)=Decommissioned (/Port Decommission Info)

isEnabled By default port is always enabled. For 1830 PSS - depending on the card type or card mode, some ports are disabled/enabled. isEnabled is not made neSpecific, as this is used in the GUI-tree to disable the port node and checking the Behavior Shell for each node will slow down the GUI further.

type=boolean
default=true

isMwLinkPort

type=boolean
access=read-only
default=false

isPortNNI

type=boolean
access=read-only
default=false

isPortSpbNetwIf This property is specific to AOS family

type=boolean
access=read-only
default=false

isPrimaryLagMember

type=boolean
access=read-only
default=false
Displayed(tab/group)=Is Primary Member (/LAG Info)

isVfLinkMemberPort

type=boolean
access=read-only
default=false

isVwmPhyLinkMemPort

type=boolean
access=read-only
default=false

isVwmPhyLinkRxPort

type=boolean
access=read-only
default=false

isVwmPhyLinkTxPort

type=boolean
access=read-only
default=false

lag.SharedQueueVlanPolicy-Set type=Children-Set
lagMembershipId

type=int
access=read-only
default=0
minimum=0
maximum=800
Displayed(tab/group)=LAG ID (/LAG Info)

layer2.EServiceNNIPortL2ProtocolClearStats-Set type=Children-Set
layer2.EServiceUNIPortL2ProtocolClearStats-Set type=Children-Set
lldp.LLDPNearestBridgePortConfiguration-Set type=Children-Set
lldp.LLDPNearestCustomerPortConfiguration-Set type=Children-Set
lldp.LLDPNearestNonTpmrPortConfiguration-Set type=Children-Set
lldp.LLDPNetworkPolicyPort-Set type=Children-Set
lldp.LLDPPortConfigExtn-Set type=Children-Set
lldp.LLDPPortConfiguration-Set type=Children-Set
lldp.LLDPTLVApplicationConfiguration-Set type=Children-Set
lldp.RemotePeer-Set type=Children-Set
lowLatency It's specifies whether low latency egress scheduling is enabled on the port.

type=boolean
Displayed(tab/group)=Low Latency (/Scheduler)

lps.LearnedPortSecurityL2MacAddress-Set type=Children-Set
macsec.MacsecInterface-Set type=Children-Set
macsec.MacsecPort-Set type=Children-Set
monitorAggEgrQueue Specifies whether to enable the monitoring of aggregate egress queue statistics on the port. All queues on the port are monitored, which includes SAP egress, network egress, subscriber egress, egress queue-group queues and system queues used for sending port related protocol packets.

type=equipment.MonitorPortSchedulerState
default=disabled
Displayed(tab/group)=Monitor Aggregate Egress Queue Statistics (/Statistics)

monitorOperGroupName The monitorOperGroupName indicates the name of operation-group that the port is monitoring. An empty value indicates that port is not monitoring any operational-group

type=string
default=
minimum=0
maximum=32

monitorOperGroupPtr The pointer to the operational group, which is monitored by this object. Used for UI display. For OSSI setting, use: equipment.physicalport.monitorOperGroupName instead.

type=Pointer
default=
Displayed(tab/group)=Monitored Group Name (/Operational Group)

monitorPortScheduler Specifies whether to enable monitoring of port scheduler

type=equipment.MonitorPortSchedulerState
default=disabled
Displayed(tab/group)=Collect Stats (Policies.General/Port Scheduler Monitor)

mpr.CoSRateLimiter-Set type=Children-Set
mpr.EgressCVlanMapping-Set type=Children-Set
mpr.EthernetSyncMode-Set type=Children-Set
mpr.IMALink-Set type=Children-Set
mpr.IngressCVlanMapping-Set type=Children-Set
mpr.Loopback-Set type=Children-Set
mpr.MPRProtection-Set type=Children-Set
mpr.MptPlugin-Set type=Children-Set
mpr.QOSQueueSize-Set type=Children-Set
mpr.VlanRateLimiter-Set type=Children-Set
mvrp.Interface-Set type=Children-Set
mvrp.InterfaceVLANRestrictions-Set type=Children-Set
mwLinkPointer

type=Pointer
access=read-only
default=
Displayed(tab/group)=MW Link Name (/MW Link Info)

netw.PhysicalInterfaceCtp-Set type=Children-Set
oesPortId Applicable to Optical Extension Shelf Ports only.

type=long
default=0

ols The value of opticalLineSystem specifies whether or not the transceiver is an optical line system. A transceiver cannot be enabled for both DCO and optical line system.

type=equipment.TransOlsType
default=disabled
Displayed(tab/group)=Optical Line System (/Transceiver)

olsEgAmpGain The value of olsEgAmpGain specifies the gain for the egress amplifier.

type=float
default=25.0
minimum=0
maximum=25.0
Displayed(tab/group)=Ols Egress Amp Gain (dB) (/Transceiver)

optical.OpticalPortSpecifics-Set type=Children-Set
otuCapable

type=boolean

otuEnable

type=int
default=disable
Displayed(tab/group)=Optical Transport Channel Unit (/Optical Transport Channel Unit)
enums=
    1: enable - Enabled
    2: disable - Disabled

pae802_1x.NonSupplicantPolicy-Set type=Children-Set
pae802_1x.PaePortAuthenticatorSpecifics-Set type=Children-Set
pae802_1x.PaePortSpecifics-Set type=Children-Set
pae802_1x.SupplicantPolicy-Set type=Children-Set
portAccessDescription This property is specific to AOS family

type=string
minimum=0
maximum=80
Displayed(tab/group)=Description (/Service Access Info)

portFarEndId Indicates which other port is connected to this port (SR port and a port of an external shelf like Optical Extension Shelf or vice-versa).

type=long
access=read-only

portPxcId The portPxcId specifies the unique identifier of the PXC to which port associated with.

type=int
access=read-only
default=0

portQosPolicyPointer

type=Pointer
default=PortQosPolicy7250SROS:default
Displayed(tab/group)=Port QoS Policy (Policies.General/Port QoS Policy)

portRmdAccessId

type=long
access=read-create
Mandatory on create

portRmdPointer

DEPRECATED: 23.4 - No longer applicable to any supported nodes
type=Pointer
default=

portShgName

type=string
access=read-create
default=
maximum=32
Mandatory on create

portShgPointer

type=Pointer
default=
Displayed(tab/group)=Split Horizon Group

portVlanXlation This property is specific to AOS family

type=int
default=2
Displayed(tab/group)=Vlan Xlation Mode (/Service Access Info)
enums=
    1: up - Up
    2: down - Down

pppoeia.PPPoEIAPort-Set type=Children-Set
ptp.PTPTOD-Set type=Children-Set
radioequipment.RadioEquipmentInventory-Set type=Children-Set
radioequipment.UBTChannel-Set type=Children-Set
reasonDown Indicates why a port may be in the operationally 'down' state.

type=long
access=read-only
Displayed(tab/group)=Reason Down (States)
bits=
    0x80: unknown - Unknown
    0x40: linklossFwd - Link Loss Fwd Fault
    0x20: lagMemberPortStandby - Lag Member Port Standby
    0x10: ethCfmFault - EthCfm Fault
    0x8: opticalTuning - Optical Tuning
    0x4: channelOutOfRange - Channel or Frequency Out of Range
    0x2: channelNotConfigured - Channel or Frequency Not Configured
    0x1: crcError - CRC Error
    0x8000: internalMacTxError - Internal MAC Tx Error
    0x4000: efmOamDown - OAM EFM is Down
    0x2000: symMonError - Symbol Monitor Error
    0x800: satHostPortDown - Satellite Host Port Down
    0x400: satUplinkPortDown - Satellite UpLink Port Down

rxdtvAdjust

type=boolean
default=true
Displayed(tab/group)=Rx Decision Threshold Voltage Adjustment (/DWDM)

sasqos.QosPool-Set type=Children-Set
schedulerMode The SchedulerMode indicates scheduler mode for the port

type=equipment.SchedulerModeType
default=none
Displayed(tab/group)=Scheduler Mode (/Scheduler)

service.OperGrpBindingMonitor-Set type=Children-Set
sfpStatus

type=equipment.PortSfpStatus
access=read-only
default=notEquipped
Displayed(tab/group)=Status (/Media Adaptor)

slope.QosPool-Set type=Children-Set
sonetequipment.SonetPortMonitorSpecifics-Set type=Children-Set
sonetequipment.SonetPortOverheadSpecifics-Set type=Children-Set
sonetequipment.SonetPortSpecifics-Set type=Children-Set
sonetequipment.Sts12Channel-Set type=Children-Set
sonetequipment.Sts192Channel-Set type=Children-Set
sonetequipment.Sts1Channel-Set type=Children-Set
sonetequipment.Sts3Channel-Set type=Children-Set
sonetequipment.Sts48Channel-Set type=Children-Set
sonetequipment.Sts768Channel-Set type=Children-Set
spbServicePortMode This property is specific to AOS family

type=int
default=2
Displayed(tab/group)=SPB Service Mode (/Service Access Info)
enums=
    1: enabled - Enabled
    2: none - None

stateChangeCount This property indicates the number of times a physical port state has changed from 'linkDown (3)' to either 'linkUp (4)' or 'up (5)' and from either 'linkUp (4)' or 'up (5)' to 'linkDown (3)'. The count does not include transitions between 'linkUp (4)' and 'up (5)'. This counter is applicable to physical Ethernet ports only. All other ports maintain a count of 0.

type=int
access=read-only
default=0
Displayed(tab/group)=Physical State Change Count

tdmequipment.DS1E1Channel-Set type=Children-Set
tdmequipment.DS1E1PortSpecifics-Set type=Children-Set
tdmequipment.DS3E3Channel-Set type=Children-Set
tdmequipment.DS3E3PortSpecifics-Set type=Children-Set
tdmequipment.DataChannel-Set type=Children-Set
tdmequipment.SerialChannel-Set type=Children-Set
tdmequipment.SerialPortSpecifics-Set type=Children-Set
tdmequipment.VoiceChannel-Set type=Children-Set
tdmequipment.VoicePortSpecifics-Set type=Children-Set
transceiverDco The value of transceiverDco specifies whether or not Digital Coherent Optics (DCO) is enabled on the transceiver.

type=equipment.TransceiverDcoType
default=disabled
Displayed(tab/group)=Digital Coherent Optics (/Transceiver)

udprelay.DHCPSnoopingPort-Set type=Children-Set
udprelay.DHCPv6SnoopingPort-Set type=Children-Set
unpprofile.UNPPort-Set type=Children-Set
usedAsSyncReference

type=sonet.SyncReferenceId
access=read-only
default=none

vlan Applicable to Telco 7250 only, default VLAN for the port

type=int
default=1
minimum=1
maximum=4092
Displayed(tab/group)=Default VLAN (/VLAN Info)

vplsMode Applicable for AOS Fuji2 Nodes. The mode of the VPLS service being configured on the Ethernet Access Port.

type=netw.VplsMode
default=none
Displayed(tab/group)=VPLS Mode (/VPLS Service)

vwm.AmplifierPortSpecifics-Set type=Children-Set
vwm.InterfaceMonitor-Set type=Children-Set
vwm.LosPropagation-Set type=Children-Set
vwm.OtdrResults-Set type=Children-Set
vwm.PortSpecifics-Set type=Children-Set
vwm.SfpSpecifics-Set type=Children-Set
vwm.VwmmsOpticalPortSpecifics-Set type=Children-Set
wLanPortMode Specifies the type of WLAN Access.

type=equipment.WLanPortModeType
access=read-only
Displayed(tab/group)=Mode (/WLAN Info)

wLanPortOperFlags Indicates the reason the port is not in service.

type=equipment.WlanOperFlagType
access=read-only
Displayed(tab/group)=Oper Flags (/WLAN Info)

wLanPortRadio Specifies the radio on this MDA belongs to.

type=int
access=read-only
Displayed(tab/group)=Radio (/WLAN Info)

wlanequipment.WlanAccessPoint-Set type=Children-Set
wlanequipment.WlanNetwork-Set type=Children-Set
xiomCardSlotId

type=string
access=read-only
default=0

 
Overridden Properties
displayedName

portName

 
Properties inherited from equipment.Port
accessuplink.EgressQueueStatsConfig-Set, accountingPolicyCapable, accountingPolicyId, accountingPolicyName, accountingPolicyObjectPointer, actualSpeed, collectStats, currentNumberOfChannels, description, displayedName, encapType, equipment.PortEgrHsmdaSchedulerOverride-Set, equipment.PortSchedulerOverride-Set, ethAccessAccountingPolicyObjectPointer, ethAccessCollectStats, etherAccountingPolicyObjectPointer, etherCollectStats, hasConnections, hasUserAssignedMac, holdTimeDown, holdTimeUnits, holdTimeUp, hwMacAddress, intervalNumber, iomType, isConnectionTerminated, isLinkUp, isPortChannelALeaf, isTerminatable, isl2UplinkMode, l2ProfilePointer, linkTrap, loadBalanceAlgorithm, macAddress, memberOfIGH, mirrorStatus, mode, mpr.FlowEntry-Set, mpr.PwAtmLayer-Set, mpr.VlanPort-Set, mptCombiner, mptCombinerImplemented, mptSubrackPointer, mtuValue, neSpecificMtu, networkQueueObjectPointer, networkQueuePolicyCapable, networkQueuePolicyName, numberOfPossibleChannels, operationalMTU, parentSnmpPortId, portBreakout, portCategory, portClass, portEgrHsmdaSchedulerPolicy, portEgrNamedPoolPlcy, portEgrPoolPercentageRate, portHoldTimeDownRemaining, portHoldTimeUpRemaining, portId, portIngrNamedPoolPlcy, portIngrPoolPercentageRate, portName, portRsFecOperMode, portSchedulerPolicyObjectPointer, portStateFPNumber, portStateLicensed, portStateMacChipNumber, portUsage, portUsageType, previousState, radioequipment.RadioPortSpecifics-Set, snmpPortId, specificCardType, specificType, speed, state, ubtListBits, ubtSpeed, uniProfilePointer, unpPortType, upProtocols, userLabel, vlanAutoBind, vwm.OtdrSpecifics-Set
 
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

requestClearEfmOamEventLogs

Request clearing of EFM-OAM Event Logs. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager.
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.
instanceFullName : string - the full name of the object.
location : equipment.Dot3LogLocation - Defines which logs to clear: local or remote.
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.

requestClearSubVlanStats

Request clearing of Subscriber VLAN statistics. Statistics will be for all service access points with the corresponding port id and outer encap value. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager.
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.
siteId : string - Specifies Site ID of the Subscriber VLAN Statistics to be cleared. This is mandatory parameter.
portName : string - Specifies port of the Subscriber VLAN Statistics to be cleared. This is mandatory parameter.
vlanId : int - (Optional) Specifies VLAN ID the Subscriber VLAN Statistics to be cleared. This value is equal to the outer encapsulation value on the Service Access Point. If set to -1, all Subscriber VLAN Statistics on the specified port will be cleared
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.
Exceptions:
equipment.PhysicalPort.requestClearSubVlanStatsException

requestResyncEfmOamEventLogs

Request resync of EFM-OAM Event Logs. When this method returns the resync has been requested but the resync has not necessarily finished yet.
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.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

requestResyncEfmOamEventStats

Request resync of EFM-OAM Event Stats (not modeled as normal "statistics"). When this method returns the resync has been requested but the resync has not necessarily finished yet.
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.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

requestResyncEfmOamPeerInfo

Request resync of EFM-OAM Peer Information. When this method returns the resync has been requested but the resync has not necessarily finished yet.
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.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Methods inherited from equipment.Port
getMigrationResult, migrateMode
 
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 (all versions)
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